Update-AzVM

Syntax

ResourceGroupNameParameterSetName (Default)

Update-AzVM
 [-ResourceGroupName] <String>
 -VM <PSVirtualMachine>
 [-Tag <Hashtable>]
 [-OsDiskWriteAccelerator <Boolean>]
 [-UltraSSDEnabled <Boolean>]
 [-MaxPrice <Double>]
 [-EncryptionAtHost <Boolean>]
 [-ProximityPlacementGroupId <String>]
 [-VirtualMachineScaleSetId <String>]
 [-HostId <String>]
 [-CapacityReservationGroupId <String>]
 [-AsJob]
 [-NoWait]
 [-UserData <String>]
 [-HibernationEnabled]
 [-vCPUCountAvailable <Int32>]
 [-vCPUCountPerCore <Int32>]
 [-SecurityType <String>]
 [-EnableVtpm <Boolean>]
 [-EnableSecureBoot <Boolean>]
 [-IfMatch <String>]
 [-IfNoneMatch <String>]
 [-AlignRegionalDisksToVMZone <Boolean>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

ExplicitIdentityParameterSet

Update-AzVM
 [-ResourceGroupName] <String>
 -VM <PSVirtualMachine>
 -IdentityType <ResourceIdentityType>
 [-Tag <Hashtable>]
 [-IdentityId <String[]>]
 [-OsDiskWriteAccelerator <Boolean>]
 [-UltraSSDEnabled <Boolean>]
 [-MaxPrice <Double>]
 [-EncryptionAtHost <Boolean>]
 [-ProximityPlacementGroupId <String>]
 [-VirtualMachineScaleSetId <String>]
 [-HostId <String>]
 [-CapacityReservationGroupId <String>]
 [-AsJob]
 [-NoWait]
 [-UserData <String>]
 [-HibernationEnabled]
 [-vCPUCountAvailable <Int32>]
 [-vCPUCountPerCore <Int32>]
 [-SecurityType <String>]
 [-EnableVtpm <Boolean>]
 [-EnableSecureBoot <Boolean>]
 [-IfMatch <String>]
 [-IfNoneMatch <String>]
 [-AlignRegionalDisksToVMZone <Boolean>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

IdParameterSetName

Update-AzVM
 [-Id] <String>
 -VM <PSVirtualMachine>
 [-Tag <Hashtable>]
 [-OsDiskWriteAccelerator <Boolean>]
 [-UltraSSDEnabled <Boolean>]
 [-MaxPrice <Double>]
 [-EncryptionAtHost <Boolean>]
 [-ProximityPlacementGroupId <String>]
 [-VirtualMachineScaleSetId <String>]
 [-HostId <String>]
 [-CapacityReservationGroupId <String>]
 [-AsJob]
 [-NoWait]
 [-UserData <String>]
 [-HibernationEnabled]
 [-vCPUCountAvailable <Int32>]
 [-vCPUCountPerCore <Int32>]
 [-SecurityType <String>]
 [-EnableVtpm <Boolean>]
 [-EnableSecureBoot <Boolean>]
 [-IfMatch <String>]
 [-IfNoneMatch <String>]
 [-AlignRegionalDisksToVMZone <Boolean>]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Examples

Example 1: Update a virtual machine

Update-AzVM -ResourceGroupName "ResourceGroup11" -VM $VirtualMachine

Example 2: Update a virtual machine to disable hyperthreading.

$resourceGroupName = 'Resource Group Name>'
$vmname = 'Virtual Machine Name';
$domainNameLabel = "d1" + $rgname;
$vCPUsCoreInitial = 2;
$vCPUsAvailableInitial = 4;
$vCPUsCore1 = 1;
$vCPUsAvailable1 = 1;
$vmSize = 'Standard_D4s_v4';

$securePassword = ConvertTo-SecureString -String "****" -AsPlainText -Force;
$user = "user";
$cred = New-Object System.Management.Automation.PSCredential ($user, $securePassword);
$vm = New-AzVM -ResourceGroupName $rgname -Name $vmname -Credential $cred -DomainNameLabel $domainNameLabel -Size $vmSize -vCPUCountPerCore $vCPUsCoreInitial -vCPUCountAvailable $vCPUsAvailableInitial;
# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 2, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 4.

Update-AzVM -ResourceGroupName $rgname -VM $vm -vCPUCountAvailable $vCPUsAvailable1 -vCPUCountPerCore $vCPUsCore1;
# The $vm.HardwareProfile.VmSizeProperties.VCPUsPerCore property is 1, and the $vm.HardwareProfile.VmSizeProperties.VCPUsAvailable property is 1.
# Hyperthreading is now disabled for this VM.

Parameters

-AlignRegionalDisksToVMZone

Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible.

Parameter properties

Parameter sets

-AsJob

Run cmdlet in the background and return a Job to track progress.

Parameter properties

Parameter sets

-CapacityReservationGroupId

Id of the capacity reservation Group that is used to allocate.

Parameter properties

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Parameter sets

-DefaultProfile

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

Parameter properties

Parameter sets

-EnableSecureBoot

Specifies whether secure boot should be enabled on the virtual machine.

Parameter properties

Parameter sets

-EnableVtpm

Specifies whether vTPM should be enabled on the virtual machine.

Parameter properties

Parameter sets

-EncryptionAtHost

EncryptionAtHost property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

Parameter properties

Parameter sets

-HibernationEnabled

The flag that enables or disables hibernation capability on the VM.

Parameter properties

Parameter sets

-HostId

The Id of Host

Parameter properties

Parameter sets

-Id

Specifies the resource ID of the virtual machine.

Parameter properties

Parameter sets

-IdentityId

Specifies the list of user identities associated with the virtual machine. The user identity references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'

Parameter properties

Parameter sets

-IdentityType

The type of identity used for the virtual machine. Valid values are SystemAssigned, UserAssigned, SystemAssignedUserAssigned, and None.

Parameter properties

Parameter sets

-IfMatch

used to make a request conditional for the PUT and other non-safe methods. The server will only return the requested resources if the resource matches one of the listed ETag values. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

Parameter properties

Parameter sets

-IfNoneMatch

Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Used to make a request conditional for the GET and HEAD methods. The server will only return the requested resources if none of the listed ETag values match the current entity. Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.

Parameter properties

Parameter sets

-MaxPrice

Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars. This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price. The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: any decimal value greater than zero. Example: 0.01538. -1 indicates that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Parameter properties

Parameter sets

-NoWait

Starts the operation and returns immediately, before the operation is completed. In order to determine if the operation has successfully been completed, use some other mechanism.

Parameter properties

Parameter sets

-OsDiskWriteAccelerator

Specifies whether WriteAccelerator should be enabled or disabled on the OS disk.

Parameter properties

Parameter sets

-ProximityPlacementGroupId

The resource id of the Proximity Placement Group to use with this virtual machine.

Parameter properties

Parameter sets

-ResourceGroupName

Specifies the name of the resource group of the virtual machine.

Parameter properties

Parameter sets

-SecurityType

Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. By default, UefiSettings will not be enabled unless this property is set.

Parameter properties

Parameter sets

-Tag

Specifies the resources and resource groups can be tagged with a set of name-value pairs. Adding tags to resources enables you to group resources together across resource groups and to create your own views. Each resource or resource group can have a maximum of 15 tags.

Parameter properties

Parameter sets

-UltraSSDEnabled

The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine only if this property is enabled.

Parameter properties

Parameter sets

-UserData

UserData for the VM, which will be base-64 encoded. Customer should not pass any secrets in here.

Parameter properties

Parameter sets

-vCPUCountAvailable

Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region.

Parameter properties

Parameter sets

-vCPUCountPerCore

Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled.

Parameter properties

Parameter sets

-VirtualMachineScaleSetId

Id for the Virtual Machine ScaleSet that the virtual machine should be updated to.

Parameter properties

Parameter sets

-VM

Specifies a local virtual machine object. To obtain a virtual machine object, use the Get-AzVM cmdlet. This virtual machine object contains the updated state for the virtual machine.

Parameter properties

Parameter sets

-WhatIf

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

Parameter properties

Parameter sets

CommonParameters

Inputs

String

PSVirtualMachine

Boolean

Outputs

PSAzureOperationResponse

Related Links

• Get-AzVM
• New-AzVM
• Remove-AzVM
• Restart-AzVM
• Start-AzVM
• Stop-AzVM
• New-AzVMConfig