Adding command and parameter to VMSS CLI #32361
Description
Preconditions
- No need to upgrade Python SDK or the Python SDK is ready.
Related command
We would like to:
- add a parameter to: az vmss list-instances
- create a command called: az vmss get-resiliency-view
Resource Provider
Microsoft.Compute/VirtualMachineScaleSets
Description of Feature or Work Requested
The parameters and commands we'd like to add to CLI (listed above) provide the customer with visibility into the status of a functionality on VMSS called Resilient Delete. For some context, Resilient Delete automatically initiates "force delete" retries on VMs that did not delete properly (max number of retries is 5). This means that customers who enroll in this Resilient Delete feature don't have to manually mitigate those delete failures anymore, because VMSS will just perform retries on the customer's behalf. When VMSS initiates another delete operation on the failed VM, the VM's provisioning status will change from "Failed" to "Deleting". However, if that delete operation failed again, then the VM status would change from "Deleting" to "Failed" (more comprehensive example included later in this ticket). Therefore, if the customer needs to know if the retries are still in progress, we're requesting CLI support for a new property called "resiliencyView" as well as a new command called get-resiliency-view which are two options for when the customer needs the real-time status of the VM delete retries ("in-progress", "failed", "not started"). This status is shown in the payload under the field: "ResilientDeletionStatus
Minimum API Version Required
2024-07-01
Swagger PR link / SDK link
https://github.com/Azure/azure-rest-api-specs/pull/32531/files
Request Example
1. Impacted CLI Command: az vmss list-instances
We would like to support the following parameters on vmss list-instances commands so that customers can retrieve the status of Resilient Delete on the VMs in their scale sets.
az vmss list-instances
--resiliencyView
--resource-group
--subscription
--name
2. Request to add CLI Command: az vmss get-resiliency-view (similar structure as "az vmss get-instance-view")
az vmss get-resiliency-view
--resource-group
--name
--instance #instance name for Flex and instance ID for Uniform
**The response body is included in the PR for the API change: ** https://github.com/Azure/azure-rest-api-specs/pull/32531/files
Target Date
2025-11-30
PM Contact
Engineer Contact
@abondalapati
Additional context
The payload of resiliencyView is actually the same as the payload of instanceView with the addition of "ResilientVMDeletionStatus". The "ResilientVMDeletionStatus" is the field that returns the status of delete retries: in progress, failed, or not started.