Create an Add-on

Article
08/24/2015

Applies To: Windows Azure Pack

Creates an add-on.

Request

Specify the Create Add-on request as follows: Replace <ServiceMgmt> with your Service Management API endpoint address.

Method	Request URI	HTTP version
POST	https://<ServiceMgmt>:30004/addons	HTTP/1.1

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request header	Description
Authorization: Bearer	Required. The authorization bearer token.
x-ms-principal-id	Required. The principal identifier.
x-ms-client-request-id	Optional. The client request identifier.
x-ms-client-session-id	Optional. The client session identifier.
x-ms-principal-liveid	Optional. The principal Live identifier.

Request Body

The request body includes the following elements.

Element name	Description
PlanAddon	For more information, see PlanAddon (Administrator object).

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
PlanAddon	An object that represents the new add-on. For more information, see PlanAddon (Administrator object).

Example

The following code example shows a Create Add-on request.

POST https://<Computer>:30004/addons HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-session-id: d19ca528-d7bf-4a62-9d4d-03adbb4f6c74
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Content-Type: application/json; charset=utf-8
Host: <Computer>:30004
Content-Length: 512
Expect: 100-continue

{
  "Id": "GoldAhihps8jy",
  "DisplayName": "GoldAddon",
  "State": 0,
  "ConfigState": 0,
  "QuotaSyncState": 2,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "GoldAddon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "sqlservers",
      "ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
      "ServiceDisplayName": "SQL Servers",
      "ServiceInstanceDisplayName": null,
      "ConfigState": 0,
      "QuotaSyncState": 2,
      "Settings": [

      ]
    }
  ],
  "SubscriptionCount": 0,
  "AssociatedPlans": [

  ],
  "MaxOccurrencesPerPlan": 0,
  "Price": null
}

The following code example shows a Create Add-on response.

{
  "Id": "GoldAhihps8jy",
  "DisplayName": "GoldAddon",
  "State": 0,
  "ConfigState": 0,
  "QuotaSyncState": 0,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "GoldAddon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "sqlservers",
      "ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
      "ServiceDisplayName": "SQL Servers",
      "ServiceInstanceDisplayName": "SQL Servers",
      "ConfigState": 0,
      "QuotaSyncState": 0,
      "Settings": [

      ]
    }
  ],
  "SubscriptionCount": 0,
  "AssociatedPlans": [

  ],
  "MaxOccurrencesPerPlan": 1,
  "Price": null
}

Share via