< Back
Update-AzureRmVmss
Post
NAME Update-AzureRmVmss
SYNOPSIS
Updates the state of a VMSS.
SYNTAX
Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-AsJob]
[-AutomaticOSUpgrade <Boolean>] [-BootDiagnosticsEnabled <Boolean>] [-BootDiagnosticsStorageUri <String>] [-CustomData <String>] [-DefaultProfile
<IAzureContextContainer>] [-DisablePasswordAuthentication <Boolean>] [-EnableAutomaticUpdate <Boolean>] [-IdentityId <String[]>] -IdentityType
{SystemAssigned | UserAssigned | SystemAssignedUserAssigned | None} [-ImageReferenceId <String>] [-ImageReferenceOffer <String>]
[-ImageReferencePublisher <String>] [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] [-ImageUri <String>] [-LicenseType <String>]
[-ManagedDiskStorageAccountType <String>] [-MaxBatchInstancePercent <Int32>] [-MaxUnhealthyInstancePercent <Int32>]
[-MaxUnhealthyUpgradedInstancePercent <Int32>] [-OsDiskCaching {None | ReadOnly | ReadWrite}] [-OsDiskWriteAccelerator <Boolean>] [-Overprovision
<Boolean>] [-PauseTimeBetweenBatches <String>] [-PlanName <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] [-PlanPublisher
<String>] [-ProvisionVMAgent <Boolean>] [-SinglePlacementGroup <Boolean>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Tag
<Hashtable>] [-TimeZone <String>] [-UpgradePolicyMode {Automatic | Manual | Rolling}] [-VhdContainer <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Update-AzureRmVmss cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background and return a Job to track progress.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-AutomaticOSUpgrade <Boolean>
Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes
available.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BootDiagnosticsEnabled <Boolean>
Whether boot diagnostics should be enabled on the virtual machine scale set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BootDiagnosticsStorageUri <String>
URI of the storage account to use for placing the console output and screenshot.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CustomData <String>
Specifies a base-64 encoded string of custom data. This is decoded to a binary array that is saved as a file on the virtual machine. The
maximum length of the binary array is 65535 bytes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisablePasswordAuthentication <Boolean>
Indicates that this cmdlet disables password authentication for Linux OS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EnableAutomaticUpdate <Boolean>
Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdentityId <String[]>
Specifies the list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in
the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdentityType <ResourceIdentityType>
Specifies the type of identity used for the virtual machine scale set. The type 'SystemAssignedUserAssigned' includes both an implicitly
created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. The
acceptable values for this parameter are:
- SystemAssigned
- UserAssigned
- SystemAssignedUserAssigned
- None
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceId <String>
Specifies the image reference ID.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceOffer <String>
Specifies the type of virtual machine image (VMImage) offer. To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferencePublisher <String>
Specifies the name of a publisher of a VMImage. To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceSku <String>
Specifies the VMImage SKU. To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceVersion <String>
Specifies the version of the VMImage. To use the latest version, specify a value of latest instead of a particular version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageUri <String>
Specifies the blob URI for the user image. VMSS creates an operating system disk in the same container of the user image.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LicenseType <String>
Specify the license type, which is for bringing your own license scenario.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ManagedDiskStorageAccountType <String>
Specifies the storage account type for managed disk. The acceptable values for this parameter are:
- StandardLRS
- PremiumLRS
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxBatchInstancePercent <Int32>
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a
maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher
reliability. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxUnhealthyInstancePercent <Int32>
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of
being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This
constraint will be checked prior to starting any batch. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxUnhealthyUpgradedInstancePercent <Int32>
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each
batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OsDiskCaching <CachingTypes>
Specifies the caching mode of the operating system disk. The acceptable values for this parameter are:
- None
- ReadOnly
- ReadWrite
The default value is ReadWrite. If you change the caching value, the cmdlet will restart the virtual machine.
This setting affects the consistency and performance of the disk.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OsDiskWriteAccelerator <Boolean>
Specifies whether WriteAccelerator should be enabled or disabled on the OS disk.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Overprovision <Boolean>
Indicates whether the cmdlet overprovisions the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PauseTimeBetweenBatches <String>
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be
specified in ISO 8601 format. The default value is 0 seconds (PT0S).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanName <String>
Specifies the plan name.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanProduct <String>
Specifies the plan product.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanPromotionCode <String>
Specifies the plan promotion code.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanPublisher <String>
Specifies the plan publisher.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProvisionVMAgent <Boolean>
Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group the VMSS belongs to.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SinglePlacementGroup <Boolean>
Specifies the single placement group.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuCapacity <Int32>
Specifies the number of instances in the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuName <String>
Specifies the size of all the instances of VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuTier <String>
Specifies the tier of VMSS. The acceptable values for this parameter are:
- Standard
- Basic
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TimeZone <String>
Specifies the time zone for Windows OS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpgradePolicyMode <UpgradeMode>
Specified the mode of an upgrade to virtual machines in the scale set. The acceptable values for this parameter are:
- Automatic
- Manual
- Rolling
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VhdContainer <String[]>
Specifies the container URLs that are used to store operating system disks for the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualMachineScaleSet <PSVirtualMachineScaleSet>
Specifies a local VMSS object. To obtain a VMSS object, use the Get-AzureRmVmss cmdlet. This virtual machine object contains the updated state
for the VMSS.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VMScaleSetName <String>
Specifies the name of the VMSS that this cmdlet creates.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
VirtualMachineScaleSet
Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet
NOTES
Example 1: Update the state of a VMSS to the state of a local VMSS object.
PS C:\\> Update-AzureRmVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS
This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object,
$LocalVMSS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... zurermvmss
Get-AzureRmVmssDiskEncryption
New-AzureRmVmss
Remove-AzureRmVmss
Restart-AzureRmVmss
Set-AzureRmVmss
Restart-AzureRmVmss
Stop-AzureRmVmss
SYNOPSIS
Updates the state of a VMSS.
SYNTAX
Update-AzureRmVmss [-ResourceGroupName] <String> [-VMScaleSetName] <String> [[-VirtualMachineScaleSet] <PSVirtualMachineScaleSet>] [-AsJob]
[-AutomaticOSUpgrade <Boolean>] [-BootDiagnosticsEnabled <Boolean>] [-BootDiagnosticsStorageUri <String>] [-CustomData <String>] [-DefaultProfile
<IAzureContextContainer>] [-DisablePasswordAuthentication <Boolean>] [-EnableAutomaticUpdate <Boolean>] [-IdentityId <String[]>] -IdentityType
{SystemAssigned | UserAssigned | SystemAssignedUserAssigned | None} [-ImageReferenceId <String>] [-ImageReferenceOffer <String>]
[-ImageReferencePublisher <String>] [-ImageReferenceSku <String>] [-ImageReferenceVersion <String>] [-ImageUri <String>] [-LicenseType <String>]
[-ManagedDiskStorageAccountType <String>] [-MaxBatchInstancePercent <Int32>] [-MaxUnhealthyInstancePercent <Int32>]
[-MaxUnhealthyUpgradedInstancePercent <Int32>] [-OsDiskCaching {None | ReadOnly | ReadWrite}] [-OsDiskWriteAccelerator <Boolean>] [-Overprovision
<Boolean>] [-PauseTimeBetweenBatches <String>] [-PlanName <String>] [-PlanProduct <String>] [-PlanPromotionCode <String>] [-PlanPublisher
<String>] [-ProvisionVMAgent <Boolean>] [-SinglePlacementGroup <Boolean>] [-SkuCapacity <Int32>] [-SkuName <String>] [-SkuTier <String>] [-Tag
<Hashtable>] [-TimeZone <String>] [-UpgradePolicyMode {Automatic | Manual | Rolling}] [-VhdContainer <String[]>] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Update-AzureRmVmss cmdlet updates the state of a Virtual Machine Scale Set (VMSS) to the state of a local VMSS object.
PARAMETERS
-AsJob [<SwitchParameter>]
Run cmdlet in the background and return a Job to track progress.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-AutomaticOSUpgrade <Boolean>
Sets whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes
available.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BootDiagnosticsEnabled <Boolean>
Whether boot diagnostics should be enabled on the virtual machine scale set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BootDiagnosticsStorageUri <String>
URI of the storage account to use for placing the console output and screenshot.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CustomData <String>
Specifies a base-64 encoded string of custom data. This is decoded to a binary array that is saved as a file on the virtual machine. The
maximum length of the binary array is 65535 bytes.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisablePasswordAuthentication <Boolean>
Indicates that this cmdlet disables password authentication for Linux OS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EnableAutomaticUpdate <Boolean>
Indicates whether the Windows virtual machines in the VMSS are enabled for automatic updates.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdentityId <String[]>
Specifies the list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in
the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdentityType <ResourceIdentityType>
Specifies the type of identity used for the virtual machine scale set. The type 'SystemAssignedUserAssigned' includes both an implicitly
created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. The
acceptable values for this parameter are:
- SystemAssigned
- UserAssigned
- SystemAssignedUserAssigned
- None
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceId <String>
Specifies the image reference ID.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceOffer <String>
Specifies the type of virtual machine image (VMImage) offer. To obtain an image offer, use the Get-AzureRmVMImageOffer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferencePublisher <String>
Specifies the name of a publisher of a VMImage. To obtain a publisher, use the Get-AzureRmVMImagePublisher cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceSku <String>
Specifies the VMImage SKU. To obtain SKUs, use the Get-AzureRmVMImageSku cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageReferenceVersion <String>
Specifies the version of the VMImage. To use the latest version, specify a value of latest instead of a particular version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ImageUri <String>
Specifies the blob URI for the user image. VMSS creates an operating system disk in the same container of the user image.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LicenseType <String>
Specify the license type, which is for bringing your own license scenario.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ManagedDiskStorageAccountType <String>
Specifies the storage account type for managed disk. The acceptable values for this parameter are:
- StandardLRS
- PremiumLRS
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxBatchInstancePercent <Int32>
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a
maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher
reliability. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxUnhealthyInstancePercent <Int32>
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of
being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This
constraint will be checked prior to starting any batch. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MaxUnhealthyUpgradedInstancePercent <Int32>
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each
batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. If the value is not specified, it is set to 20.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OsDiskCaching <CachingTypes>
Specifies the caching mode of the operating system disk. The acceptable values for this parameter are:
- None
- ReadOnly
- ReadWrite
The default value is ReadWrite. If you change the caching value, the cmdlet will restart the virtual machine.
This setting affects the consistency and performance of the disk.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OsDiskWriteAccelerator <Boolean>
Specifies whether WriteAccelerator should be enabled or disabled on the OS disk.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Overprovision <Boolean>
Indicates whether the cmdlet overprovisions the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PauseTimeBetweenBatches <String>
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be
specified in ISO 8601 format. The default value is 0 seconds (PT0S).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanName <String>
Specifies the plan name.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanProduct <String>
Specifies the plan product.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanPromotionCode <String>
Specifies the plan promotion code.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PlanPublisher <String>
Specifies the plan publisher.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProvisionVMAgent <Boolean>
Indicates whether virtual machine agent should be provisioned on the Windows virtual machines in the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group the VMSS belongs to.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SinglePlacementGroup <Boolean>
Specifies the single placement group.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuCapacity <Int32>
Specifies the number of instances in the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuName <String>
Specifies the size of all the instances of VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SkuTier <String>
Specifies the tier of VMSS. The acceptable values for this parameter are:
- Standard
- Basic
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Tag <Hashtable>
Key-value pairs in the form of a hash table. For example:
@{key0="value0";key1=$null;key2="value2"}
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TimeZone <String>
Specifies the time zone for Windows OS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UpgradePolicyMode <UpgradeMode>
Specified the mode of an upgrade to virtual machines in the scale set. The acceptable values for this parameter are:
- Automatic
- Manual
- Rolling
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VhdContainer <String[]>
Specifies the container URLs that are used to store operating system disks for the VMSS.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VirtualMachineScaleSet <PSVirtualMachineScaleSet>
Specifies a local VMSS object. To obtain a VMSS object, use the Get-AzureRmVmss cmdlet. This virtual machine object contains the updated state
for the VMSS.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-VMScaleSetName <String>
Specifies the name of the VMSS that this cmdlet creates.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
VirtualMachineScaleSet
Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSVirtualMachineScaleSet
NOTES
Example 1: Update the state of a VMSS to the state of a local VMSS object.
PS C:\\> Update-AzureRmVmss -ResourceGroupName "Group001" -Name "VMSS001" -VirtualMachineScaleSet $LocalVMSS
This command updates the state of the VMSS named VMSS001 that belongs to the resource group named Group001 to the state of a local VMSS object,
$LocalVMSS.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... zurermvmss
Get-AzureRmVmssDiskEncryption
New-AzureRmVmss
Remove-AzureRmVmss
Restart-AzureRmVmss
Set-AzureRmVmss
Restart-AzureRmVmss
Stop-AzureRmVmss