Restart-​Azure​Rm​Vmss

Restarts the VMSS or a virtual machine within the VMSS.

Syntax

Restart-AzureRmVmss
       [-ResourceGroupName] <String>
       [-VMScaleSetName] <String>
       [[-InstanceId] <String[]>]
       [-Confirm]
       [-WhatIf]
       [<CommonParameters>]

Description

The Restart-AzureRmVmss cmdlet restarts the Virtual Machine Scale Set (VMSS). This cmdlet can also be used to restart a specific virtual machine inside the VMSS by using the InstanceId parameter.

Examples

Example 1: Restart the VMSS

PS C:\>Restart-AzureRmVmss -ResourceGroupName "Group001" -VMScaleSetName "VMSS001";

This command restarts the VMSS named VMSS001 that belongs to the resource group named Group001.

Example 2: Restart a specific virtual machine within the VMSS

PS C:\>Restart-AzureRmVmss -ResourceGroupName "Group004" -VMScaleSetName "VMSS001" -InstanceId "1"

This command restarts a virtual machine that has the instance ID of 1 in the VMSS named VMSS001 that belongs to the resource group named Group001.

Required Parameters

-ResourceGroupName

Specifies the name of the resource group of the VMSS.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VMScaleSetName

Species the name of the VMSS that this cmdlet restarts.

Type:String
Aliases:Name
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-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
-InstanceId

Specifies, as a string array, the ID of the instances that need restarted.

Type:String[]
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
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

Outputs