Start-AzVmssRollingExtensionUpgrade

Reference

Module:: Az.Compute

This cmdlet starts a rolling upgrade for all extensions on the given Virtual Machine Scale Set to the latest available version.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Start-AzVmssRollingExtensionUpgrade
     -ResourceGroupName <String>
     -VMScaleSetName <String>
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzVmssRollingExtensionUpgrade
     -VirtualMachineScaleSet <PSVirtualMachineScaleSet>
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzVmssRollingExtensionUpgrade
     -ResourceId <String>
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Starts a rolling upgrade to move all extensions on this virtual machine scale set to the latest available version. Extensions which are already running the latest available version are not affected.

Examples

Example 1

$vmss = Get-AzVmss -ResourceGroupName "MyResourceGroupName" -Name "MyVmssName";
Add-AzVmssExtension -VirtualMachineScaleSet $vmss -Name "testExtension" -Publisher Microsoft.CPlat.Core -Type "NullWindows" -TypeHandlerVersion "3.0" -AutoUpgradeMinorVersion $True  -Setting "";
Start-AzVmssRollingExtensionUpgrade -ResourceGroupName "MyResourceGroupName" -VMScaleSetName "MyVmssName";

This example gets the existing VM scale set "MyVmssName", and adds an extension to it. The final command runs the extension rolling upgrade process.

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

The resource Id of the VM scale set object.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualMachineScaleSet

The VM scale set object.

Type:	PSVirtualMachineScaleSet
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-VMScaleSetName

The name of the VM scale set.

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

PSVirtualMachineScaleSet

Outputs

PSOperationStatusResponse