Add OS Image


Updated: July 10, 2015

The Add OS Image operation adds an operating system image to the image repository that is associated with the specified subscription.

The Add OS Image request may be specified as follows. Replace <subscription-id> with the subscription ID.

MethodRequest URI

URI Parameters


Request Headers

The following table describes the request headers.

Request HeaderDescription
x-ms-versionRequired. Specifies the version of the operation to use for this request. This header should be set to 2012-08-01 or higher.

Request Body

The format of the request body is as follows:

<OSImage xmlns="" xmlns:i="">  

The following table describes the elements of the request body.

Element NameDescription
LabelRequired. Specifies the friendly name of the image.
MediaLinkRequired. 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.

NameRequired. Specifies a name that is used to identify the image when you create a Virtual Machine.
OSRequired. Specifies the operating system type of the OS image.

Possible values are:

- Linux
- Windows
EulaOptional. 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.
DescriptionOptional. Specifies the description of the OS image.
ImageFamilyOptional. Specifies a value that can be used to group OS images.
PublishedDateOptional. Specifies the date when the OS image was added to the image repository.
ShowInGuiSpecifies whether the image should appear in the image gallery.
PrivacyUriOptional. Specifies the URI that points to a document that contains the privacy policy related to the OS image.
IconUriOptional. Specifies the Uri to the icon that is displayed for the image in the Management Portal.
RecommendedVMSizeOptional. Specifies the size to use for the virtual machine that is created from the OS image.
SmallIconUriSpecifies 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.
LanguageSpecifies the language of the image.

The Language element is only available using version 2013-03-01 or higher.

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

Status Code

A successful operation returns status code 201 (Created).

Response Headers

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

Response HeaderDescription
x-ms-request-idA value that uniquely identifies a request made against the management service.

Response Body