Add osRollingUpgradeDeferral property and ApproveRollingUpgrade call

custom-words.txt

@@ -139,6 +139,7 @@ appendpos
 appid
 appinsights
 applynetworkconfigurationupdates
+approverollingupgrade
 appservice
 appsettings
 Appsource

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json

@@ -0,0 +1,16 @@
+{
+  "parameters": {
+    "resourceGroupName": "rgcompute",
+    "vmScaleSetName": "vmssToApproveRollingUpgradeOn",
+    "instanceId": "0123",
+    "api-version": "2023-09-01",
+    "subscriptionId": "{subscription-id}"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "location": "https://foo.com/operationstatus"
+      }
+    }
+  }
+}

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json

@@ -0,0 +1,22 @@
+{
+  "parameters": {
+    "resourceGroupName": "rgcompute",
+    "vmScaleSetName": "vmssToApproveRollingUpgradeOn",
+    "vmInstanceIDs": {
+      "instanceIds": [
+        "0",
+        "1",
+        "2"
+      ]
+    },
+    "api-version": "2023-09-01",
+    "subscriptionId": "{subscription-id}"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "location": "https://foo.com/operationstatus"
+      }
+    }
+  }
+}

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json

@@ -294,7 +294,8 @@
                 },
                 "automaticOSUpgradePolicy": {
                   "enableAutomaticOSUpgrade": true,
-                  "disableAutomaticRollback": true
+                  "disableAutomaticRollback": true,
+                  "osRollingUpgradeDeferral": true
                 }
               },
               "automaticRepairsPolicy": {

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json

@@ -26,7 +26,8 @@
                 "automaticOSUpgradePolicy": {
                   "enableAutomaticOSUpgrade": true,
                   "disableAutomaticRollback": true,
-                  "useRollingUpgradePolicy": true
+                  "useRollingUpgradePolicy": true,
+                  "osRollingUpgradeDeferral": true
                 },
                 "rollingUpgradePolicy": {
                   "maxBatchInstancePercent": 49,
@@ -361,7 +362,8 @@
                 "automaticOSUpgradePolicy": {
                   "enableAutomaticOSUpgrade": true,
                   "disableAutomaticRollback": true,
-                  "useRollingUpgradePolicy": true
+                  "useRollingUpgradePolicy": true,
+                  "osRollingUpgradeDeferral": true
                 },
                 "rollingUpgradePolicy": {
                   "maxBatchInstancePercent": 49,

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json

@@ -29,7 +29,8 @@
           },
           "automaticOSUpgradePolicy": {
             "enableAutomaticOSUpgrade": true,
-            "disableAutomaticRollback": true
+            "disableAutomaticRollback": true,
+            "osRollingUpgradeDeferral": true
           }
         },
         "automaticRepairsPolicy": {
@@ -578,7 +579,8 @@
             },
             "automaticOSUpgradePolicy": {
               "enableAutomaticOSUpgrade": true,
-              "disableAutomaticRollback": true
+              "disableAutomaticRollback": true,
+              "osRollingUpgradeDeferral": true
             }
           },
           "automaticRepairsPolicy": {

specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json

@@ -1755,6 +1755,68 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade": {
+      "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": {
+          "202": {
+            "description": "Accepted",
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            }
+          },
+          "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": [
@@ -2645,6 +2707,66 @@
         }
       }
     },
+    "/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": {
+          "202": {
+            "description": "Accepted",
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            }
+          },
+          "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": [
@@ -3611,6 +3733,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."