Retrieve the Available Add-ons

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves the available add-ons.

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.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:<Port>/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-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 principle Live identifier.

Request Body

None.

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 key elements of the response body:

Element name	Description
PlanAddonList	The list of Add-ons. For more information, see PlanAddon (Administrator object).

Example

The following code example shows a List Add-ons request.

GET https://<Computer>:30004/addons HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 854ad280-fc02-4301-8066-588cb416dc24-2013-06-26 19:43:15Z
x-ms-client-session-id: 04f2c518-71af-4dfa-973e-1bcae380ef88
x-ms-principal-id: <Computer>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <Computer>\Administrator
Host: <Computer>:30004

The following code example shows a List Add-ons response.

[
  {
    "Id": "SqlAOzu4r2rvczcwyhwn2",
    "DisplayName": "SqlAOzu4r2rvc",
    "State": 0,
    "ConfigState": 1,
    "QuotaSyncState": 0,
    "LastErrorMessage": null,
    "Advertisements": [
      {
        "LanguageCode": "en-us",
        "DisplayName": "SqlAOzu4r2rvc",
        "Description": null
      }
    ],
    "ServiceQuotas": [
      {
        "ServiceName": "sqlservers",
        "ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
        "ServiceDisplayName": "SQL Servers",
        "ServiceInstanceDisplayName": "SQL Servers",
        "ConfigState": 1,
        "QuotaSyncState": 0,
        "Settings": [
          {
            "Key": "Editions",
            "Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"2\",\"resourceSize\":\"10\",\"offerEditionId\":\"1367541399669\"}]"
          }
        ]
      }
    ],
    "SubscriptionCount": 1,
    "AssociatedPlans": [

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

Share via