Retrieve an Add-on (Tenant Add-on)

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves an add-on.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. Replace <AddonId> with the add-on identifier of the add-on.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:30005/addons/<AddonId>	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 following table describes the elements of the request body.

Element name	Description
includePrice	Optional. The add-on include price.
region	Optional. The add-on region.
subscriptionId	Optional. The subscription identifier.
username	Optional. The add-on user name.

There are 4 calling options. If any other combination of options is used, the operation will not have a request body.

Option	Requirement
AddonID in the calling URI only	No request body.
includeprice, region, username & SubscriptionId.	The username and subscriptionId supplied.
Includeprice, region & username	The username supplied.
includeprice, region and subscriptionId	The subscriptionId supplied.

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
PlanAddOn	The add-on that was retrieved. For more information, see PlanAddon (Administrator object).

Example

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

GET https://<computer>:30004/addons/MyTeshixk1xiz HTTP/1.1
Authorization: Bearer 
x-ms-client-request-id: 5f7abeba-03fd-41ab-92f1-1ef4ee5507f3-2013-07-09 22:02:35Z
x-ms-client-session-id: 4d317dde-d7c1-495e-a819-9802dc021e2f
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 Get Add-on response.

{
  "Id": "MyTeshixk1xiz",
  "DisplayName": "My Test Addon",
  "State": 0,
  "ConfigState": 1,
  "QuotaSyncState": 0,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "My Test Addon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "sqlservers",
      "ServiceInstanceId": "85D94D4A-6ADF-47A6-BAEF-A01975742308",
      "ServiceDisplayName": "SQL Servers",
      "ServiceInstanceDisplayName": "SQL Servers",
      "ConfigState": 1,
      "QuotaSyncState": 0,
      "Settings": [
        {
          "Key": "Editions",
          "Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"1\",\"resourceSize\":\"10\",\"offerEditionId\":\"1373402022182\"}]"
        }
      ]
    }
  ],
  "SubscriptionCount": 0,
  "AssociatedPlans": [

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

Share via