Get-​Azure​VM​Image

Gets the properties on one or a list of operating systems or a virtual machine image in the image repository.

Syntax

Get-AzureVMImage
   [[-ImageName] <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureVMImage cmdlet gets properties on one or a list of operating systems or a virtual machine image in the image repository. The cmdlet returns information for all images in the repository, or about a specific image if its image name is provided.

Examples

Example 1: Get a specific image object from the current image repository.

PS C:\> Get-AzureVMImage -ImageName Image001

This command gets the image object named Image001 from the current image repository.

Example 2: Get all images from the current image repository

PS C:\> Get-AzureVMImage

This command retrieves all the images from the current image repository.

Example 3: Set the subscription context and then get all the images

PS C:\> $SubsId = <MySubscriptionID>
C:\PS>$Cert = Get-AzureCertificate cert:\LocalMachine\MY\<CertificateThumbprint>
C:\PS>$MyOSImages = Get-AzureVMImage

This command sets the subscription context and then retrieves all the images from the image repository.

Optional Parameters

-ImageName

Specifies the name of the operating system or virtual machine image in the image repository. If you do not specify this parameter, all the images are returned.

Type:String
Position:0
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
-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