List OS Images

Article
08/03/2016

The List OS Images operation retrieves a list of the operating system images from the image repository that is associated with the specified subscription.

Request

The List OS 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/images

URI Parameters

None.

Request Headers

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 2013-03-01 or higher.

Request Body

None.

Response

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

Status Code

A successful operation returns status code 200 (OK).

Response Headers

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.

Response Body

<Images xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OSImage>
    <AffinityGroup>name-of-the-affinity-group</AffinityGroup>
    <Category>category-of-the-image</Category>
    <Label>image-description</Label>
    <Location>geo-location-of-the-stored-image</Location>
    <LogicalSizeInGB>size-of-the-image</LogicalSizeInGB>
    <MediaLink>url-of-the-containing-blob</MediaLink>
    <Name>image-name</Name>
    <OS>operating-system-of-the-image</OS>
    <Eula>image-eula</Eula>
    <Description>image-description</Description>
    <ImageFamily>image-family</ImageFamily>
    <ShowInGui>indicator-of-availability</ShowInGui>
    <PublishedDate>published-date</PublishedDate>
    <IsPremium>indicator-of-image-status</IsPremium>
    <PrivacyUri>uri-of-privacy-policy</PrivacyUri>
    <RecommendedVMSize>size-of-the-virtual-machine</RecommendedVMSize>
    <PublisherName>publisher-identifier</PublisherName>
    <PricingDetailLink>pricing-details</PricingDetailLink>
    <SmallIconUri>uri-of-icon</SmallIconUri>
    <Language>language-of-image</Language>
    <IOType>IO-Type<IOType>
  </OSImage>
</Images>

The following table describes the elements of the response body.

Element Name	Description
AffinityGroup	Specifies the affinity in which the media is located. The AffinityGroup value is derived from 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. This value is NULL for platform images.
Category	Specifies the repository classification of the image. All user images have the category User. If the version is set to 2013-10-01 or higher, the following values are also possible: Public – A platform image that is available to all. Private – A platform image that is privately available. MSDN - A platform image that is available through MSDN.
Label	Specifies an identifier for the image.
Location	The geo-location in which this media is located. The Location value is derived from 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. If the version is set to 2012-08-01 or later, the locations are returned for platform images; otherwise, this value is NULL for platform images.
LogicalSizeInGB	Specifies the size, in GB, of the image.
MediaLink	Specifies the location of the vhd file for the image. The storage account where the vhd is located must be associated with the specified subscription. Example: http://example.blob.core.windows.net/disks/myimage.vhd
Name	Specifies the name of the operating system image. This is the name that is used when creating one or more virtual machines using the image.
OS	Specifies the operating system type of the image. Possible Values are: Linux Windows
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.
Description	Specifies the description of the image.
ImageFamily	Specifies a value that can be used to group images.
PublishedDate	Specifies the date when the image was added to the image repository.
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.
PrivacyUri	Specifies the URI that points to a document that contains the privacy policy related to the image.
RecommendedVMSize	Specifies the size to use for the virtual machine that is created from the image.
PublisherName	The name of the publisher of the image. All user images have a publisher name of User.
PricingDetailLink	Specifies a URL for an image with IsPremium set to true, which contains the pricing details for a virtual machine that is created from the image. The PricingDetailLink element is only available using version 2012-12-01 or higher.
SmallIconUri	Specifies the URI to the small icon that is displayed when the image is presented in the portal. The SmallIconUri element is only available using version 2013-03-01 or higher.
Language	Specifies the language of the image. The Language element is only available using version 2013-03-01 or higher.
IOType	This property 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.

Share via