0 out of 1 rated this helpful - Rate this topic

Add OS Image

Updated: July 18, 2012

The Add OS Image operation adds an operating system image that is stored in a storage account and is available from the image repository.

Request

The Add OS Image request is specified as follows. Replace <subscription-id> with your subscription ID.

Method	Request URI	HTTP Version
POST	`https://management.core.windows.net/<subscription-id>/services/images`	HTTP/1.1

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request Header	Description
x-ms-version	Required. Specifies the version of the operation to use for this request. Currently this header should be set to 2012-08-01.

Request Body

The format of the request body is as follows:

    
<OSImage xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <Label>image-label</Label>
   <MediaLink>uri-of-the-containing-blob</MediaLink>
   <Name>image-name</Name>
   <OS>Linux|Windows</OS>
   <Eula>image-eula</Eula>
   <Description>image-description</Description>
   <ImageFamily>image-family</ImageFamily>
   <PublishedDate>published-date</PublishedDate>
   <IsPremium>true/false</IsPremium>
   <ShowInGui>true/false</ShowInGui>
   <PrivacyUri>http://www.example.com/privacypolicy.html</PrivacyUri>
   <IconUri>http://www.example.com/favicon.png</IconUri>
   <RecommendedVMSize>Small/Large/Medium/ExtraLarge</RecommendedVMSize>
   <SmallIconUri>http://www.example.com/smallfavicon.png</SmallIconUri>
   <Language>language-of-image</Language>
</OSImage>

The following table describes the key elements of the request body:

Element Name	Description
Label	Required. Specifies the friendly name of the image.
MediaLink	Required. Specifies the location of the blob in Windows Azure storage. The blob location must belong to a storage account in the subscription specified by the `<subscription-id>` value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
Name	Required. Specifies a name that Windows Azure uses to identify the image when creating one or more virtual machines.
OS	Required. The operating system type of the OS image. Possible values are: Linux Windows
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.
IsPremium	Indicates if the image contains software or associated services that will incur charges above the core price for the virtual machine.
ShowInGui	Specifies whether the image should appear in the image gallery.
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 Windows Azure 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 201 (Created).

For information about status codes, see Service Management Status and Error Codes.

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header	Description
x-ms-request-id	A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information.

Response Body

None.

Authorization

Only the account owner may call this operation.

Remarks

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)