Update VM Image

  • Article

 

The Update VM Image operation updates a VM Image in the image repository that is associated with the specified subscription.

Request

The Update VM Image request may be specified as follows. Replace <subscription-id> with the subscription ID and <image-name> with the name of the VM Image to be updated.

Method

Request URI

PUT

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

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 2014-05-01 or higher.

Request Body

The format of the request body is as follows:

<VMImage xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Label>image-label</Label>
  <Description>description-of-image</Description>
  <OSDiskConfiguration>
    <HostCaching>caching-mode-of-os-disk</HostCaching>
  </OSDiskConfiguration>
  <DataDiskConfiguration>
    <Name>name-of-data-disk</Name>
    <HostCaching>caching-mode-of-data-disk</HostCaching>
    <Lun>logical-unit-number-of-data-disk</Lun>
  </DataDiskConfiguration>
  <Language>language-of-image</Language>
  <ImageFamily>family-of-image</ImageFamily>
  <RecommendedVMSize>recommended-vm-size</RecommendedVMSize>
  <Eula>image-eula</Eula>
  <IconUri>uri-to-image-icon</IconUri>
  <SmallIconUri>uri-to-image-icon</SmallIconUri>
  <PrivacyUri>uri-to-privacy-policy</PrivacyUri>
  <PublishedDate>published-date</PublishedDate>
  <ShowInGui>indicator-of-availability</ShowInGui>
</VMImage>

The following table describes the elements of the request body.

Element Name

Description

Label

Optional. Specifies the friendly name of the VM Image to be updated. You cannot use this operation to update images provided by the Microsoft Azure platform.

Description

Optional. Specifies the description of the VM image.

OSDiskConfiguration

Optional. Contains the configuration settings that can be changed for an operating system disk that is associated with the VM Image.

DataDiskConfiguration

Optional. Contains the configuration settings that can be changed for data disks that are associated with the VM Image.

Language

Optional. Specifies the language of the VM Image.

ImageFamily

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

RecommendedVMSize

Optional. Specifies the size to use for the virtual machine that is created from the VM Image.

Eula

Optional. 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.

IconUri

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

SmallIconUri

Optional. Specifies the URI to the small icon that is displayed when the image is presented in the Management Portal.

PrivacyUri

Optional. Specifies the URI that points to a document that contains the privacy policy related to the VM Image.

PublishedDate

Optional. Specifies the date when the OS Image was added to the image repository.

ShowInGui

Optional. Indicates whether the image should appear in the image gallery. true if the image should appear in the gallery, otherwise false.

OSDiskConfiguration

Contains the configuration settings that can be changed for an operating system disk that is associated with the VM Image.

Element Name

Description

HostCaching

Optional. Specifies the caching mode of the operating system disk. This setting impacts the consistency and performance of the disk.

Possible values are:

  • None

  • ReadOnly

  • ReadWrite

DataDiskConfiguration

Contains the configuration settings that can be changed for data disks that are associated with the VM Image.

Element Name

Description

Name

Required. Specifies the name of the data disk.

HostCaching

Optional. Specifies the caching mode of the data disk. This setting impacts the consistency and performance of the disk.

Possible values are:

  • None

  • ReadOnly

  • ReadWrite

Lun

Optional. Specifies the Logical Unit Number (LUN) for the data disk. Values must be in the range 0-31.

Response

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

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

None.