Add scaleDownMode to agent pool properties (#15124)

* add scale down mode * address comments * fix markdown link * update proper api version
Azure · Jul 14, 2021 · 2ae26ef · 2ae26ef
1 parent dddf56e
commit 2ae26ef
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/...r/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json b/...r/Microsoft.ContainerService/stable/2021-07-01/examples/ManagedClustersCreate_Update.json
@@ -24,6 +24,7 @@
             "vmSize": "Standard_DS1_v2",
             "osType": "Linux",
             "type": "VirtualMachineScaleSets",
+            "scaleDownMode": "Deallocate",
             "availabilityZones": [
               "1",
               "2",
@@ -108,6 +109,7 @@
               "provisioningState": "Succeeded",
               "orchestratorVersion": "1.9.6",
               "type": "VirtualMachineScaleSets",
+              "scaleDownMode": "Deallocate",
               "availabilityZones": [
                 "1",
                 "2",
@@ -209,6 +211,7 @@
               "provisioningState": "Creating",
               "orchestratorVersion": "1.9.6",
               "type": "VirtualMachineScaleSets",
+              "scaleDownMode": "Deallocate",
               "availabilityZones": [
                 "1",
                 "2",

diff --git a/...ervice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json b/...ervice/resource-manager/Microsoft.ContainerService/stable/2021-07-01/managedClusters.json
@@ -2377,6 +2377,11 @@
           "type": "boolean",
           "description": "Whether to enable auto-scaler"
         },
+        "scaleDownMode": {
+          "$ref": "#/definitions/ScaleDownMode",
+          "title": "The scale down mode to use when scaling the Agent Pool.",
+          "description": "This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete."
+        },
         "type": {
           "$ref": "#/definitions/AgentPoolType"
         },
@@ -4242,6 +4247,28 @@
       "title": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
       "description": "Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)"
     },
+    "ScaleDownMode": {
+      "type": "string",
+      "enum": [
+        "Delete",
+        "Deallocate"
+      ],
+      "x-ms-enum": {
+        "name": "ScaleDownMode",
+        "modelAsString": true,
+        "values": [
+          {
+            "value": "Delete",
+            "description": "Create new instances during scale up and remove instances during scale down."
+          },
+          {
+            "value": "Deallocate",
+            "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down."
+          }
+        ]
+      },
+      "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)."
+    },
     "ProximityPlacementGroupID": {
       "type": "string",
       "description": "The ID for Proximity Placement Group."