List VM Images

 

Updated: July 10, 2015

The List VM Images operation retrieves a list of the VM Images from the image repository that is associated with the specified subscription.

The List VM Images request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/services/vmimages

The following table describes the parameters that can be added to the URI.

URI Parameter

Description

location

Optional. Returns VM Images from the specified location.

The location parameter is only available using version 2014-05-01 or higher.

publisher

Optional. Returns VM Images that were published by the specified publisher.

The publisher parameter is only available using version 2014-05-01 or higher.

category

Optional. Returns VM Images that were assigned to the specified category.

The category parameter is only available using version 2014-05-01 or higher.

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2014-02-01 or higher.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.


<VMImages xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <VMImage>
    <Name>name-of-image</Name>
    <Label>identifier-of-image</Label>
    <Category>category-of-image</Category>
    <Description>description-of-image</Description>
    <OSDiskConfiguration>
      <Name>name-of-operating-system-disk</Name>
      <HostCaching>caching-mode-of-disk</HostCaching>
      <OSState>state-of-disk</OSState>
      <OS>operating-system-of-image</OS>
      <MediaLink>path-to-vhd</MediaLink>
      <LogicalDiskSizeInGB>size-of-disk</LogicalDiskSizeInGB>
      <IOType>IO-type<IOType>
    </OSDiskConfiguration>
    <DataDiskConfigurations>
      <DataDiskConfiguration>
        <Name>name-of-data-disk</Name>
        <HostCaching>caching-mode-of-disk</HostCaching>
        <Lun>logical-unit-number</Lun>
        <MediaLink>path-to-vhd</MediaLink>
        <LogicalDiskSizeInGB>size-of-disk</LogicalDiskSizeInGB>
        <IOType>IO-Type<IOType>
      </DataDiskConfigurations>
    </DataDiskConfiguration>
    <ServiceName>name-of-cloud-service</ServiceName>
    <DeploymentName>name-of-deployment</DeploymentName>
    <RoleName>name-of-virtual-machine</RoleName>
    <Location>geo-location-of-image-blobs</Location>
    <AffinityGroup>name-of-affinity-group</AffinityGroup>
    <CreatedTime>creation-time-of-image</CreatedTime>
    <ModifiedTime>modification-time-of-image</ModifiedTime>
    <Language>language-of-image</Language>
    <ImageFamily>image-family</ImageFamily>
    <RecommendedVMSize>size-of-virtual-machine</RecommendedVMSize>
    <IsPremium>indicator-of-image-status</IsPremium>
    <Eula>image-eula</Eula>
    <IconUri>uri-of-icon</IconUri>
    <SmallIconUri>uri-of-icon</SmallIconUri>
    <PrivacyUri>uri-of-privacy-policy</PrivacyUri>
    <PublisherName>publisher-identifier</PublisherName>
    <PublishedDate>published-date</PublishedDate>
    <ShowInGui>indicator-of-availability</ShowInGui>
    <PricingDetailLink>pricing-details</PricingDetailLink>
  </VMImage>
</VMImages>

The following table describes the elements of the response body.

Element Name

Description

Name

Specifies the name of the image.

Label

Specifies an identifier for the image.

Category

Specifies the repository classification of the image. All user images have the category User.

Description

Specifies the description of the image.

OSDiskConfiguration

Specifies configuration information for the operating system disk that is associated with the image.

DataDiskConfigurations

Specifies configuration information for the data disks that are associated with the image. A VM Image might not have data disks associated with it.

ServiceName

Specifies the name of the cloud service that contained the Virtual Machine from which the image was created.

DeploymentName

Specifies the name of the deployment that contained the Virtual Machine from which the image was created.

RoleName

Specifies the name of the Virtual Machine from which the image was created.

Location

Specifies the geo-location in which the media is located. The Location value is derived from the storage account that contains the blob in which the media is located. If the storage account belongs to an affinity group the value is NULL and the element is not displayed in the response.

AffinityGroup

Specifies the affinity group in which the media is located. The AffinityGroup value is derived from the storage account that contains the blob in which the media is located. If the storage account does not belong to an affinity group the value is NULL and the element is not displayed in the response.

CreatedTime

Specifies the time that the image was created.

ModifiedTime

Specifies the time that the image was last updated.

The ModifiedTime element is only available using version 2014-05-01 or higher.

Language

Specifies the language of the image.

The Language element is only available using version 2014-05-01 or higher.

ImageFamily

Specifies a value that can be used to group VM Images.

The ImageFamily element is only available using version 2014-05-01 or higher.

RecommendedVMSize

Optional. Specifies the size to use for the Virtual Machine that is created from the VM Image.

The RecommendedVMSize element is only available using version 2014-05-01 or higher.

IsPremium

Indicates whether the image contains software or associated services that will incur charges above the core price for the virtual machine. For additional details, see the PricingDetailLink element.

The IsPremium element is only available using version 2014-05-01 or higher.

Eula

Specifies the End User License Agreement that is associated with the image. The value for this element is a string, but it is recommended that the value be a URL that points to a EULA.

The Eula element is only available using version 2014-05-01 or higher.

IconUri

Specifies the URI to the icon that is displayed for the image in the Management Portal.

The IconUri element is only available using version 2014-05-01 or higher.

SmallIconUri

Specifies the URI to the small icon that is displayed for the image in the Management Portal.

The SmallIconUri element is only available using version 2014-05-01 or higher.

PrivacyUri

Specifies the URI that points to a document that contains the privacy policy related to the image.

The PrivacyUri element is only available using version 2014-05-01 or higher.

PublishedDate

Specifies the date when the image was added to the image repository.

The PublishedDate element is only available using version 2014-05-01 or higher.

Specifies configuration information for the operating system disk that is associated with the image.

Element Name

Description

Name

Specifies the name of the operating system disk.

HostCaching

Specifies the caching behavior of the operating system disk.

Possible values are:

  • None

  • ReadOnly

  • ReadWrite

OSState

Specifies the state of the operating system in the image.

Possible values are:

  • Generalized

  • Specialized

A Virtual Machine that is fully configured and running contains a Specialized operating system. A Virtual Machine on which the Sysprep command has been run with the generalize option contains a Generalized operating system.

OS

Specifies the operating system type of the image.

MediaLink

Specifies the location of the blob in Azure storage. The blob location belongs to a storage account in the subscription specified by the <subscription-id> value in the operation call.

LogicalSizeInGB

Specifies the size, in GB, of the operating system disk.

IOType

Identifies the type of the storage account for the backing VHD. If the backing VHD is in an Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.

Note: This value is populated by Azure platform when the disk is created, not by the user.

This property is only returned with a version header of 2014-10-01 or newer.

Specifies configuration information for the data disks that are associated with the image.

Element Name

Description

Name

Specifies the name of the data disk.

HostCaching

Specifies the caching behavior of the data disk.

Possible values are:

  • None

  • ReadOnly

  • ReadWrite

Lun

Specifies the Logical Unit Number (LUN) for the data disk.

MediaLink

Specifies the location of the blob in Azure storage. The blob location belongs to a storage account in the subscription specified by the <subscription-id> value in the operation call.

LogicalSizeInGB

Specifies the size, in GB, of the data disk.

IOType

Identifies the type of the storage account for the backing VHD. If the backing VHD is in an Provisioned Storage account, “Provisioned” is returned otherwise “Standard” is returned.

Note: This value is populated by Azure platform when the disk is created, not by the user.

This property is only returned with a version header of 2014-10-01 or newer.

Show: