Update OS Image

  • Article

 

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

Request

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

Method

Request URI

Put

https://management.core.windows.net/<subscription-id>/services/images/<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 2012-08-01 or higher.

Request Body

<OSImage xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Label>image-label</Label>
  <Eula>image-eula</Eula>
  <Description>description-of-image</Description>
  <ImageFamily>family-of-image</ImageFamily>
  <PublishedDate>published-date</PublishedDate>
  <ShowInGui>indicator-of-availability</ShowInGui>
  <PrivacyUri>uri-to-privacy-policy</PrivacyUri>
  <IconUri>uri-to-image-icon</IconUri>
  <RecommendedVMSize>recommended-vm-size</RecommendedVMSize>
  <SmallIconUri>uri-to-image-icon</SmallIconUri>
  <Language>language-of-image</Language>
</OSImage>

The following table describes the elements of the request body.

Element Name

Description

Label

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

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.

Description

Optional. Specifies the description of the OS Image.

ImageFamily

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

PublishedDate

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

PrivacyUri

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

IconUri

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

RecommendedVMSize

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

SmallIconUri

Specifies the URI to the small icon that is displayed when the image is presented in the Management 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.

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.