Skip to content

Add osRollingUpgradeDeferral property and ApproveRollingUpgrade call #25543

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.

Sign up for GitHub

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

Merged
grizzlytheodore merged 5 commits into from
Nov 16, 2023
Merged

Add osRollingUpgradeDeferral property and ApproveRollingUpgrade call #25543

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3de945c
add swagger for rolling upgrade deferral and approval
johnzhang-microsoft Aug 25, 2023
54a0bbe
Update virtualMachineScaleSet.json
johnzhang-microsoft Sep 14, 2023
640e2e1
update to use concise example
johnzhang-microsoft Oct 17, 2023
2d4718f
Pr comments
johnzhang-microsoft Oct 24, 2023
933c21d
remove 200 response from example
johnzhang-microsoft Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions custom-words.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ appendpos
appid
appinsights
applynetworkconfigurationupdates
approverollingupgrade
appservice
appsettings
Appsource
Expand Down
17 changes: 17 additions & 0 deletions ...amples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parameters": {
"resourceGroupName": "rgcompute",
"vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaa",
Comment thread
johnzhang-microsoft marked this conversation as resolved.
Outdated
"instanceId": "0123",
"api-version": "2023-09-01",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {},
"202": {
"headers": {
"location": "https://foo.com/operationstatus"
}
}
}
}
23 changes: 23 additions & 0 deletions ...examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parameters": {
"resourceGroupName": "rgcompute",
"vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
Comment thread
johnzhang-microsoft marked this conversation as resolved.
Outdated
"vmInstanceIDs": {
"instanceIds": [
"0",
"1",
"2"
]
},
"api-version": "2023-09-01",
"subscriptionId": "{subscription-id}"
},
"responses": {
"200": {},
"202": {
"headers": {
"location": "https://foo.com/operationstatus"
}
}
}
}
3 changes: 2 additions & 1 deletion ...xamples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,8 @@
},
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true
"disableAutomaticRollback": true,
"osRollingUpgradeDeferral": true
}
},
"automaticRepairsPolicy": {
Expand Down
6 changes: 4 additions & 2 deletions ...1/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true,
"useRollingUpgradePolicy": true
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
Expand Down Expand Up @@ -361,7 +362,8 @@
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true,
"useRollingUpgradePolicy": true
"useRollingUpgradePolicy": true,
"osRollingUpgradeDeferral": true
},
"rollingUpgradePolicy": {
"maxBatchInstancePercent": 49,
Expand Down
6 changes: 4 additions & 2 deletions ...examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
},
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true
"disableAutomaticRollback": true,
"osRollingUpgradeDeferral": true
}
},
"automaticRepairsPolicy": {
Expand Down Expand Up @@ -578,7 +579,8 @@
},
"automaticOSUpgradePolicy": {
"enableAutomaticOSUpgrade": true,
"disableAutomaticRollback": true
"disableAutomaticRollback": true,
"osRollingUpgradeDeferral": true
}
},
"automaticRepairsPolicy": {
Expand Down
122 changes: 122 additions & 0 deletions ...esource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,6 +1755,66 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approverollingupgrade": {
Comment thread
johnzhang-microsoft marked this conversation as resolved.
Outdated
Comment thread
johnzhang-microsoft marked this conversation as resolved.
Outdated
"post": {
"tags": [
"VirtualMachineScaleSets"
],
"operationId": "VirtualMachineScaleSets_ApproveRollingUpgrade",
"description": "Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "vmScaleSetName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the VM scale set."
},
{
"name": "vmInstanceIDs",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs"
},
"description": "A list of virtual machine instance IDs from the VM scale set."
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK"
},
"202": {
"description": "Accepted"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"VirtualMachineScaleSet_ApproveRollingUpgrade": {
"$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": {
"post": {
"tags": [
Expand Down Expand Up @@ -2645,6 +2705,64 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approverollingupgrade": {
"post": {
"tags": [
"VirtualMachineScaleSetVMs"
],
"operationId": "VirtualMachineScaleSetVMs_ApproveRollingUpgrade",
"description": "Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "vmScaleSetName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the VM scale set."
},
{
"name": "instanceId",
"in": "path",
"required": true,
"type": "string",
"description": "The instance ID of the virtual machine."
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK"
},
"202": {
"description": "Accepted"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common-types/v1/common.json#/definitions/CloudError"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"VirtualMachineScaleSetVM_ApproveRollingUpgrade": {
"$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": {
"post": {
"tags": [
Expand Down Expand Up @@ -3611,6 +3729,10 @@
"useRollingUpgradePolicy": {
"type": "boolean",
"description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS."
},
"osRollingUpgradeDeferral": {
"type": "boolean",
"description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call."
}
},
"description": "The configuration parameters used for performing automatic OS upgrade."
Expand Down
⚡