Save-AzureVMImage
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Save-AzureVMImage
Captures and saves the image of a stopped Windows Azure virtual machine.
Parameter Set: Default
Save-AzureVMImage [-ServiceName] <String> [-Name] <String> [-NewImageName] <String> [[-NewImageLabel] <String> ] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
The Save-AzureVMImage cmdlet makes a stopped virtual machine available as an image for reuse. For Windows virtual machines, run the Sysprep tool to prepare the image before it’s captured. After the image is captured, the virtual machine is deleted.
-Name<String>
Specifies the name of the source virtual machine.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewImageLabel<String>
Specifies a label for the saved image. If not specified, the image name is used for the label.
Aliases |
none |
Required? |
false |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewImageName<String>
Specifies the name for the saved image created from the virtual machine capture.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the name of the Windows Azure service.
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.
Example 1
This example captures an existing virtual machine and deletes it from the deployment.
C:\PS>Save-AzureVMImage -ServiceName MyService -Name MyVM -NewImageName MyBaseImage -NewImageLabel MyBaseVM