Set the upgrade policy on Virtual Machine Scale Sets (Preview)

Note

Upgrade policies for Virtual Machine Scale Sets with Uniform Orchestration are in general availability (GA).

Upgrade policies for Virtual Machine Scale Sets with Flexible Orchestration are currently in preview. Previews are made available to you on the condition that you agree to the supplemental terms of use. Some aspects of these features may change prior to general availability (GA).

The upgrade policy can be set during scale set creation or changed post deployment. If you don't explicitly set the upgrade policy, it defaults to manual. To change the upgrade policy of an existing scale set deployment, see changing the upgrade policy.

Portal

During the Virtual Machine Scale Set creation in the Azure portal, under the Management tab, set the upgrade policy to Rolling, Automatic, or Manual.

If using a rolling upgrade policy, see configure rolling upgrade policy for configuration settings and suggestions.

CLI

When creating a new scale set using Azure CLI, use az vmss create and the -upgrade-policy-mode to set the upgrade policy mode.

If using a rolling upgrade policy, see configure rolling upgrade policy for configuration settings and suggestions.

az vmss create \
    --resource-group myResourceGroup \
    --name myScaleSet \
    --orchestration-mode Flexible \
    --image Ubuntu2204 \
    --lb myLoadBalancer \
    --upgrade-policy-mode manual \
    --instance-count 5 \
    --admin-username azureuser \
    --generate-ssh-keys

PowerShell

Note

Setting the upgrade policy to automatic during scale set creation using PowerShell on Virtual Machine Scale Sets with Flexible Orchestration is not yet available. To set the upgrade policy to automatic, update the upgrade policy after scale set deployment. See changing the upgrade policy on a Virtual Machine Scale Set.

When creating a new scale set using Azure PowerShell, use New-AzVmss and the -UpgradePolicyMode parameter to set the upgrade policy mode.

If using a rolling upgrade policy, see configure rolling upgrade policy for configuration settings and suggestions.

New-AzVmss `
  -ResourceGroupName "myResourceGroup" `
  -Location "EastUS" `
  -VMScaleSetName "myScaleSet" `
  -OrchestrationMode "Flexible" `
  -VirtualNetworkName "myVnet" `
  -SubnetName "mySubnet" `
  -PublicIpAddressName "myPublicIPAddress" `
  -LoadBalancerName "myLoadBalancer" `
  -UpgradePolicyMode "Manual"

ARM Template

When using an ARM template, add the upgradePolicy parameter to the properties section of your template to set the upgrade policy mode.

If using a rolling upgrade policy, see configure rolling upgrade policy for configuration settings and suggestions.

"properties": {
        "upgradePolicy": {
            "mode": "manual",
        }
    }

Next steps

Learn how to change the upgrade policy of your Virtual Machine Scale Set.