Add model for 'az vmss'

Azure · Aug 12, 2023 · 31365dd · 31365dd
1 parent 5bbcf54
commit 31365dd
Show file tree

Hide file tree

Showing 36 changed files with 8,388 additions and 27 deletions.
diff --git a/Commands/tree.json b/Commands/tree.json
@@ -97851,7 +97851,7 @@
                 "commands": {
                   "list-names": {
                     "help": {
-                      "short": "List a list of virtual machine extension image types."
+                      "short": "List virtual machine extension image types."
                     },
                     "names": [
                       "vmss",
@@ -97874,7 +97874,7 @@
                   },
                   "list-versions": {
                     "help": {
-                      "short": "List a list of virtual machine extension image versions."
+                      "short": "List virtual machine extension image versions."
                     },
                     "names": [
                       "vmss",
@@ -98093,6 +98093,103 @@
           }
         },
         "commands": {
+          "create": {
+            "help": {
+              "short": "Create a VM scale set."
+            },
+            "names": [
+              "vmss",
+              "create"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "delete": {
+            "help": {
+              "short": "Delete a VM scale set."
+            },
+            "names": [
+              "vmss",
+              "delete"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "get-os-upgrade-history": {
+            "help": {
+              "short": "List the OS upgrades on a VM scale set instance."
+            },
+            "names": [
+              "vmss",
+              "get-os-upgrade-history"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/osupgradehistory",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "list": {
+            "help": {
+              "short": "List all VM scale sets under a resource group."
+            },
+            "names": [
+              "vmss",
+              "list"
+            ],
+            "versions": [
+              {
+                "examples": [
+                  {
+                    "commands": [
+                      "vmss list --resource-group MyResourceGroup"
+                    ],
+                    "name": "List VMSS"
+                  }
+                ],
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/providers/microsoft.compute/virtualmachinescalesets",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  },
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
           "list-instance-public-ips": {
             "help": {
               "short": "List information about all public IP addresses on a virtual machine scale set level."
@@ -98123,6 +98220,143 @@
                 ]
               }
             ]
+          },
+          "list-instances": {
+            "help": {
+              "lines": [
+                "Return a list of virtual machines managed by VMSS. For VMSS in Flexible Orchestration mode, please use \"az vm list\" to get full details."
+              ],
+              "short": "List all virtual machines in a VM scale sets."
+            },
+            "names": [
+              "vmss",
+              "list-instances"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "list-skus": {
+            "help": {
+              "short": "List SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU."
+            },
+            "names": [
+              "vmss",
+              "list-skus"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/skus",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "perform-maintenance": {
+            "help": {
+              "short": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications"
+            },
+            "names": [
+              "vmss",
+              "perform-maintenance"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/performmaintenance",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "show": {
+            "help": {
+              "short": "Get information about a virtual machine scale set."
+            },
+            "names": [
+              "vmss",
+              "show"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "simulate-eviction": {
+            "help": {
+              "short": "Simulate the eviction of a Spot virtual machine in a VM scale set."
+            },
+            "names": [
+              "vmss",
+              "simulate-eviction"
+            ],
+            "versions": [
+              {
+                "examples": [
+                  {
+                    "commands": [
+                      "vmss simulate-eviction --resource-group MyResourceGroup --name MyScaleSet --instance-id 0"
+                    ],
+                    "name": "Simulate the eviction of a Spot virtual machine in a VM scale set."
+                  }
+                ],
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines/{}/simulateeviction",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
+          },
+          "update": {
+            "help": {
+              "short": "Update a VM scale set."
+            },
+            "names": [
+              "vmss",
+              "update"
+            ],
+            "versions": [
+              {
+                "name": "2023-03-01",
+                "resources": [
+                  {
+                    "id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}",
+                    "plane": "mgmt-plane",
+                    "version": "2023-03-01"
+                  }
+                ]
+              }
+            ]
           }
         },
         "help": {

diff --git a/Commands/vmss/_create.md b/Commands/vmss/_create.md
@@ -0,0 +1,9 @@
+# [Command] _vmss create_
+
+Create a VM scale set.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{} 2023-03-01 -->
diff --git a/Commands/vmss/_delete.md b/Commands/vmss/_delete.md
@@ -0,0 +1,9 @@
+# [Command] _vmss delete_
+
+Delete a VM scale set.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{} 2023-03-01 -->
diff --git a/Commands/vmss/_get-os-upgrade-history.md b/Commands/vmss/_get-os-upgrade-history.md
@@ -0,0 +1,9 @@
+# [Command] _vmss get-os-upgrade-history_
+
+List the OS upgrades on a VM scale set instance.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9L29zdXBncmFkZWhpc3Rvcnk=/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/osupgradehistory 2023-03-01 -->
diff --git a/Commands/vmss/_list-instances.md b/Commands/vmss/_list-instances.md
@@ -0,0 +1,11 @@
+# [Command] _vmss list-instances_
+
+List all virtual machines in a VM scale sets.
+
+Return a list of virtual machines managed by VMSS. For VMSS in Flexible Orchestration mode, please use "az vm list" to get full details.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9L3ZpcnR1YWxtYWNoaW5lcw==/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines 2023-03-01 -->
diff --git a/Commands/vmss/_list-skus.md b/Commands/vmss/_list-skus.md
@@ -0,0 +1,9 @@
+# [Command] _vmss list-skus_
+
+List SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9L3NrdXM=/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/skus 2023-03-01 -->
diff --git a/Commands/vmss/_list.md b/Commands/vmss/_list.md
@@ -0,0 +1,17 @@
+# [Command] _vmss list_
+
+List all VM scale sets under a resource group.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRz/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/providers/microsoft.compute/virtualmachinescalesets 2023-03-01 -->
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets 2023-03-01 -->
+
+#### examples
+
+- List VMSS
+    ```bash
+        vmss list --resource-group MyResourceGroup
+    ```
diff --git a/Commands/vmss/_perform-maintenance.md b/Commands/vmss/_perform-maintenance.md
@@ -0,0 +1,9 @@
+# [Command] _vmss perform-maintenance_
+
+Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9L3BlcmZvcm1tYWludGVuYW5jZQ==/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/performmaintenance 2023-03-01 -->
diff --git a/Commands/vmss/_show.md b/Commands/vmss/_show.md
@@ -0,0 +1,9 @@
+# [Command] _vmss show_
+
+Get information about a virtual machine scale set.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{} 2023-03-01 -->
diff --git a/Commands/vmss/_simulate-eviction.md b/Commands/vmss/_simulate-eviction.md
@@ -0,0 +1,16 @@
+# [Command] _vmss simulate-eviction_
+
+Simulate the eviction of a Spot virtual machine in a VM scale set.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9L3ZpcnR1YWxtYWNoaW5lcy97fS9zaW11bGF0ZWV2aWN0aW9u/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines/{}/simulateeviction 2023-03-01 -->
+
+#### examples
+
+- Simulate the eviction of a Spot virtual machine in a VM scale set.
+    ```bash
+        vmss simulate-eviction --resource-group MyResourceGroup --name MyScaleSet --instance-id 0
+    ```
diff --git a/Commands/vmss/_update.md b/Commands/vmss/_update.md
@@ -0,0 +1,9 @@
+# [Command] _vmss update_
+
+Update a VM scale set.
+
+## Versions
+
+### [2023-03-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3ZpcnR1YWxtYWNoaW5lc2NhbGVzZXRzL3t9/2023-03-01.xml) **Stable**
+
+<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{} 2023-03-01 -->
diff --git a/Commands/vmss/extension/image/_list-names.md b/Commands/vmss/extension/image/_list-names.md
@@ -1,6 +1,6 @@
 # [Command] _vmss extension image list-names_
 
-List a list of virtual machine extension image types.
+List virtual machine extension image types.
 
 ## Versions
 

diff --git a/Commands/vmss/extension/image/_list-versions.md b/Commands/vmss/extension/image/_list-versions.md
@@ -1,6 +1,6 @@
 # [Command] _vmss extension image list-versions_
 
-List a list of virtual machine extension image versions.
+List virtual machine extension image versions.
 
 ## Versions