Export-AzureVM
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Export-AzureVM
Exports the state of an Azure virtual machine to a file.
Syntax
Parameter Set: Default
Export-AzureVM [-ServiceName] <String> [-Name] <String> [-Path] <String> [ <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 Export-AzureVM cmdlet exports the state of a virtual machine to an XML file.
Note: Using Export-AzureVM, followed by Remove-AzureVM and then Import-AzureVM to recreate a virtual machine can cause the recreated virtual machine to have a different IP address than the original virtual machine.
Parameters
-Name<String>
Specifies the name of the virtual machine whose state you are exporting.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path and file name to which the virtual machine state will be saved.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the name of the Azure service that hosts the virtual machine.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (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 command exports the state of the $MyRole virtual machine to the “VMstate.xml” file.
C:\PS>Export-AzureVM -ServiceName $MyService -Name $MyRole -Path "C:\vms\VMstate.xml"
Related topics
Use Azure PowerShell to create and preconfigure Windows-based Virtual Machines