Set-AzVmssVM

Reference

Module:: Az.Compute

Modifies the state of a VMSS instance.

Note

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

Syntax

Set-AzVmssVM
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-InstanceId] <String>
   [-Reimage]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzVmssVM
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-InstanceId] <String>
   [-ReimageAll]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzVmssVM
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-InstanceId] <String>
   [-Redeploy]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzVmssVM
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-InstanceId] <String>
   [-PerformMaintenance]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzVmssVM
   [-ResourceGroupName] <String>
   [-VMScaleSetName] <String>
   [-InstanceId] <String>
   [-SimulateEviction]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzVmssVM cmdlet modifies the state of a Virtual Machine Scale Set (VMSS) instance.

Examples

Example 1

Modifies the state of a VMSS instance. (autogenerated)

Set-AzVmssVM -InstanceId <String> -Reimage -ResourceGroupName myresourcegroup -VMScaleSetName 'VMSS001'

Example 2

Modifies the state of a VMSS instance. (autogenerated)

Set-AzVmssVM -InstanceId <String> -PerformMaintenance -ResourceGroupName myresourcegroup -VMScaleSetName 'VMSS001'

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

-InstanceId

Specifies the ID of the VMSS instance for which this cmdlet modifies state.

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

-PerformMaintenance

Indicates that this cmdlet performs maintenance on a virtual machine in the VMSS.

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

-Redeploy

Indicates that this cmdlet redeploys a virtual machine in the VMSS.

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

-Reimage

Indicates that this cmdlet reimages the VMSS instance.

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

-ReimageAll

Indicates that the cmdlet reimages all the disks in the VMSS instance.

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

-ResourceGroupName

Specifies the name of the resource group that contains the VMSS instance.

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

-SimulateEviction

Indicates that this cmdlet simulates the eviction of spot virtual machine in a VM scale set. The eviction will occur within 30 minutes of calling the API.

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

-VMScaleSetName

Specifies the name of the VMSS instance that this cmdlet modifies.

Type:	String
Aliases:	Name
Position:	1
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

Outputs

PSOperationStatusResponse

Get-AzVmssVM