Skip to content

Commit

Permalink
Add Guest Configuration VMSS changes to Swagger spec (#13465)
Browse files Browse the repository at this point in the history 
* Add Guest Configuration VMSS changes to Swagger spec

* Fixed all the review comments from validation tool

* Fix PR comments

* Fixed the validation errors. Added back the fields in the examples

* Added GET Collection APIs and Delete API for VMSS

* Fixed delete API return type and other validation failures

* add No content response for Delete operation

* Fixed the example to have resposne for 204

* Removed the long running operation flag

* Reverted readonly field

Co-authored-by: Aashish Rajaram Salokhe <aasalokh@microsoft.com>
  • Loading branch information
@aashish1987
aashish1987 and Aashish Rajaram Salokhe authored Mar 29, 2021
1 parent 413612b commit a46829b
Show file tree
Hide file tree
Showing 31 changed files with 2,758 additions and 93 deletions.
8 changes: 8 additions & 0 deletions ...estconfiguration/resource-manager/Microsoft.GuestConfiguration/common/v1/definitions.json
View file
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
3 changes: 0 additions & 3 deletions ...e-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json
View file
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
37 changes: 9 additions & 28 deletions ...e-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json
View file
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"
},
"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."
},
"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."
},
"configurationModeFrequencyMins": {
"type": "number",
"readOnly": true,
"readOnly": 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
6 changes: 3 additions & 3 deletions ...tConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json
View file
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
6 changes: 3 additions & 3 deletions ...figuration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json
View file
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
29 changes: 4 additions & 25 deletions ...n/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json
View file
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
6 changes: 3 additions & 3 deletions ...tConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json
View file
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
6 changes: 3 additions & 3 deletions ...figuration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json
View file
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
29 changes: 4 additions & 25 deletions ...n/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
View file
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

0 comments on commit a46829b

Please sign in to comment.