Save-AzureVMImage

Module:
Azure
Captures and saves the image of a stopped Azure virtual machine.

Syntax

Save-AzureVMImage
    [-ServiceName] <String>
    [-Name] <String>
    [-ImageName] <String>
    [[-ImageLabel] <String>]
    [[-OSState] <String>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Save-AzureVMImage cmdlet captures and saves the image of a stopped Azure virtual machine. For Windows virtual machines, run the Sysprep tool to prepare the image before it is captured. After the image is captured, the virtual machine is deleted.

Examples

Example 1: Save an existing virtual machine and then delete it from a deployment

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

This command captures an existing virtual machine and deletes it from the deployment.

Required Parameters

-ImageName

Specifies the name of the virtual machine image.

Type:String
Aliases:NewImageName
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the source virtual machine.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServiceName

Specifies the name of the Azure service.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ImageLabel

Specifies the label of the virtual machine image.

Type:String
Aliases:NewImageLabel
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OSState

Specifies the operation system state for the virtual machine image. Use this parameter if you intend to capture a virtual machine image to Azure.

Valid values are:

  • Generalized
  • Specialized
Type:String
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False