Share via


Add a Subscription Add-on

 

Applies To: Windows Azure Pack

Adds a subscription add-on.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. Replace <Port> with either 30005 for the tenant API or 30004 for the administrator API. Replace <SubscriptionId> with the subscription identifier for the required subscription.

Method

Request URI

HTTP version

POST

https://<ServiceMgmt>:<Port>/subscriptions/<SubscriptionId>/addons/

HTTP/1.1

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request header

Description

Authorization: Bearer

Required. Authorization bearer token.

x-ms-client-request-id:

Optional. The client request identifier.

x-ms-client-session-id:

Optional. The client session identifier.

x-ms-client-principal-id:

Optional. The principal identifier.

x-ms-principal-liveid:

Optional. The principal Live identifier.

Request Body

The following table describes the elements of the request body.

Element name

Description

AddOnId

The add-on identifier.

AddOnInstanceId

The add-on instance Identifier. Use null

AcquisitionTime

The add-on acquisition time. Use null

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

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

Response Headers

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

The following table describes the elements of the response body.

Element name

Description

AddOnId

The add-on identifier.

AddOnInstanceId

The add-on instance Identifier.

AcquisitionTime

The add-on acquisition time.

Example

The following code example shows an Add Subscription Add-on request.

POST https://<computer>:30004/subscriptions/1b7a12d8-82c0-4d06-82bb-7da71028b1ff/addons HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: ea3ec878-5246-4c11-9f00-4bec66d6f468-2014-05-02 21:22:34Z
x-ms-client-session-id: c0d4a435-6552-4677-92b7-3da9c5b129e1
x-ms-principal-id: <Computer>%5cAdministrator
Accept-Language: en-US
Content-Type: application/json; charset=utf-8
Host: chrisre-katal:30004
Content-Length: 73
Expect: 100-continue

{
  "AddOnId": "MyAddhupzd4d3",
  "AddOnInstanceId": null,
  "AcquisitionTime": null
}

The following example shows an Add a Subscription Add-on response body.

{
  "AddOnId": "MyAddhupzd4d3",
  "AddOnInstanceId": "c43e34db-156b-4004-a73a-c71d76c2c6f6",
  "AcquisitionTime": "2014-05-02T21:22:35.687"
}

See Also

Common Subscription Interfaces