Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzVmssVM
- Module:
- Az.Compute Module
Modifies the state of a VMSS instance.
Syntax
DefaultParameter (Default)
Set-AzVmssVM
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[-InstanceId] <String>
[-Reimage]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FriendMethod
Set-AzVmssVM
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[-InstanceId] <String>
[-ReimageAll]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RedeployMethodParameter
Set-AzVmssVM
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[-InstanceId] <String>
[-Redeploy]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PerformMaintenanceMethodParameter
Set-AzVmssVM
[-ResourceGroupName] <String>
[-VMScaleSetName] <String>
[-InstanceId] <String>
[-PerformMaintenance]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SimulateEvictionMethodParameter
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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-InstanceId
Specifies the ID of the VMSS instance for which this cmdlet modifies state.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PerformMaintenance
Indicates that this cmdlet performs maintenance on a virtual machine in the VMSS.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Redeploy
Indicates that this cmdlet redeploys a virtual machine in the VMSS.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Reimage
Indicates that this cmdlet reimages the VMSS instance.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ReimageAll
Indicates that the cmdlet reimages all the disks in the VMSS instance.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group that contains the VMSS instance.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VMScaleSetName
Specifies the name of the VMSS instance that this cmdlet modifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
PSOperationStatusResponse
Related Links
Azure PowerShell
Feedback
Was this page helpful?