SALES: 1-800-867-1380
Expand Minimize

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 Azure virtual machine.

Syntax

Parameter Set: Default
Save-AzureVMImage [-ServiceName] <String> [-Name] <String> [-ImageName] <String> [[-ImageLabel] <String> ] [[-OSState] <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 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.

Parameters

-ImageLabel<String>

Aliases

NewImageLabel

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ImageName<String>

Aliases

NewImageName

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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

-OSState<String>

Specifies the operation system state for the virtual machine image. Valid values are: Generalized and Specialized. Use this parameter if you intend to capture a virtual machine image to Azure.


Aliases

none

Required?

false

Position?

5

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://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 captures an existing virtual machine and deletes it from the deployment.


C:\PS>Save-AzureVMImage -ServiceName MyService -Name MyVM -NewImageName MyBaseImage -NewImageLabel MyBaseVM 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft