Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Guest Configuration VMSS changes to Swagger spec #13465

Merged
merged 10 commits into from
Mar 29, 2021
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,14 @@
"description": "The name of the virtual machine.",
"x-ms-parameter-location": "method"
},
"VMSSNameParameter": {
"name": "vmssName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the virtual machine scale set.",
"x-ms-parameter-location": "method"
},
"MachineNameParameter": {
"name": "machineName",
"in": "path",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -355,12 +354,10 @@
},
"name": {
"type": "string",
"readOnly": true,
"description": "Name of the guest configuration."
},
"type": {
"type": "string",
"readOnly": true,
"description": "Type of the guest configuration."
},
"configurationParameter": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -193,7 +192,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -505,7 +503,7 @@
"properties": {
"configurationMode": {
"type": "string",
"readOnly": true,
"readOnly": false,
"description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.",
"x-ms-enum": {
"name": "configurationMode",
Expand All @@ -518,20 +516,12 @@
]
},
"allowModuleOverwrite": {
"type": "string",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false",
"x-ms-enum": {
"name": "allowModuleOverwrite",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"type": "boolean",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false"
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
},
"actionAfterReboot": {
"type": "string",
"readOnly": true,
"readOnly": false,
"description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration",
"x-ms-enum": {
"name": "actionAfterReboot",
Expand All @@ -544,27 +534,18 @@
},
"refreshFrequencyMins": {
"type": "number",
"readOnly": true,
"readOnly": false,
"default": 30,
"description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30."
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
},
"rebootIfNeeded": {
"type": "string",
"readOnly": true,
"default": "False",
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.",
"x-ms-enum": {
"name": "rebootIfNeeded",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"type": "boolean",
"readOnly": false,
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module."
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
},
"configurationModeFrequencyMins": {
"type": "number",
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
"readOnly": true,
"readOnly": false,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually we could remove the readOnly line if it is false

"default": 15,
"description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15."
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -55,7 +55,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -90,7 +90,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
"configurationMode": "MonitorOnly"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -55,7 +55,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -90,7 +90,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -193,7 +192,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -432,7 +430,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -536,7 +533,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -861,16 +857,8 @@
]
},
"allowModuleOverwrite": {
"type": "string",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false",
"x-ms-enum": {
"name": "allowModuleOverwrite",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"type": "boolean",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false"
aashish1987 marked this conversation as resolved.
Show resolved Hide resolved
},
"actionAfterReboot": {
"type": "string",
Expand All @@ -892,18 +880,9 @@
"description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30."
},
"rebootIfNeeded": {
"type": "string",
"type": "boolean",
"readOnly": false,
"default": "False",
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.",
"x-ms-enum": {
"name": "rebootIfNeeded",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module."
},
"configurationModeFrequencyMins": {
"type": "number",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -55,7 +55,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -90,7 +90,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -55,7 +55,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down Expand Up @@ -90,7 +90,7 @@
}
],
"configurationSetting": {
"rebootIfNeeded": "False",
"rebootIfNeeded": false,
"actionAfterReboot": "ContinueConfiguration",
"configurationModeFrequencyMins": 15,
"configurationMode": "MonitorOnly"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -193,7 +192,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -432,7 +430,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -536,7 +533,6 @@
}
}
},
"x-ms-long-running-operation": true,
"produces": [
"application/json"
],
Expand Down Expand Up @@ -861,16 +857,8 @@
]
},
"allowModuleOverwrite": {
"type": "string",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false",
"x-ms-enum": {
"name": "allowModuleOverwrite",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"type": "boolean",
"description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false"
},
"actionAfterReboot": {
"type": "string",
Expand All @@ -892,18 +880,9 @@
"description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30."
},
"rebootIfNeeded": {
"type": "string",
"type": "boolean",
"readOnly": false,
"default": "False",
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.",
"x-ms-enum": {
"name": "rebootIfNeeded",
"modelAsString": true
},
"enum": [
"True",
"False"
]
"description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module."
},
"configurationModeFrequencyMins": {
"type": "number",
Expand Down
Loading