Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az vmss rolling-upgrade

Manage rolling upgrades.

Commands

Name Description Type Status
az vmss rolling-upgrade cancel

Cancel the current virtual machine scale set rolling upgrade.

 Core GA
az vmss rolling-upgrade get-latest

Get the status of the latest virtual machine scale set rolling upgrade.

 Core GA
az vmss rolling-upgrade start

Start a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

 Core GA

az vmss rolling-upgrade cancel

Cancel the current virtual machine scale set rolling upgrade.

az vmss rolling-upgrade cancel [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name --virtual-machine-scale-set-name --vm-scale-set-name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--resource-group]
 [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --virtual-machine-scale-set-name --vm-scale-set-name -n

Scale set name. You can configure the default using az configure --defaults vmss=<name>.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments

az vmss rolling-upgrade get-latest

Get the status of the latest virtual machine scale set rolling upgrade.

az vmss rolling-upgrade get-latest [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name --virtual-machine-scale-set-name --vm-scale-set-name]
 [--resource-group]
 [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --virtual-machine-scale-set-name --vm-scale-set-name -n

Scale set name. You can configure the default using az configure --defaults vmss=<name>.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments

az vmss rolling-upgrade start

Start a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.

az vmss rolling-upgrade start [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name --virtual-machine-scale-set-name --vm-scale-set-name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--resource-group]
 [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name --virtual-machine-scale-set-name --vm-scale-set-name -n

Scale set name. You can configure the default using az configure --defaults vmss=<name>.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments

Feedback

Was this page helpful?