Update-AzureVM
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Update-AzureVM
Updates an Azure virtual machine with the modications make to a virtual machine object.
Syntax
Parameter Set: Default
Update-AzureVM [-ServiceName] <String> [-Name] <String> -VM <PersistentVM> [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
The Update-AzureVM cmdlet accepts update information for the specified virtual machine and initiates the update. You can add or remove data disks, modify the cache mode of data or operating system disks, change the network endpoints, or change the size of the virtual machine.
Parameters
-Name<String>
Specifies the name of the virtual machine to be updated.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the name of the Azure service.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VM<PersistentVM>
The virtual machine object that includes updated settings.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
-------------- Example 1 --------------
This example changes the size of the virtual machine "MyVM3", running in "MySvc1", to "Medium".
C:\PS>Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" `
| Set-AzureVMSize –InstanceSize "Medium" `
| Update-AzureVM
-------------- Example 2 --------------
This example adds a new data disk to the virtual machine "MyVM3", running in "MySvc1".
C:\PS>Get-AzureVM -ServiceName "MySvc1" -Name "MyVM3" `
| Add-AzureDataDisk -CreateNew `
-MediaLocation "https://MyaccountStore1.blob.core.azure.com/vhds/MyNewDisk.vhd" `
-DiskSizeInGB 128 -DiskLabel "Data-128" -LUN 0 `
| Update-AzureVM