Retrieve a Subscription

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves a subscription.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. Replace <SubscriptionId> with the subscription identifier for the required subscription.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:30004/subscriptions/<SubscriptionId>	HTTP/1.1

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

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 element of the response body.

Element name	Description
AdminSubscription	The retrieved subscription. For more information, see AdminSubscription (Administrator object).

Example

The following code example shows a Get Subscription request.

GET https://<Computer>:30004/subscriptions/512d113d-44e0-4fb4-81d1-2770be611d14 HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: d9ed35a1-6f98-4a6a-88c3-42bf11d552da-2013-06-28 19:42:37Z
x-ms-client-session-id: 36d65d7b-42b5-4fc0-8334-93c10e7a90f2
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 Subscription response.

{
  "SubscriptionID": "512d113d-44e0-4fb4-81d1-2770be611d14",
  "SubscriptionName": "WebWeb",
  "AccountAdminLiveEmailId": "aaa@ccc.com",
  "ServiceAdminLiveEmailId": null,
  "CoAdminNames": [
    "aaa@bbb.com"
  ],
  "AddOnReferences": [
    {
      "AddOnId": "SqlAOzu4r2rvczcwyhwn2",
      "AddOnInstanceId": "f4e9c1de-0cd0-4e9c-b902-01b081b30096",
      "AcquisitionTime": "2013-06-28T19:40:59.233"
    }
  ],
  "AddOns": [
    {
      "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": 2,
      "AssociatedPlans": [

      ],
      "MaxOccurrencesPerPlan": 1,
      "Price": null
    }
  ],
  "State": 1,
  "QuotaSyncState": 0,
  "ActivationSyncState": 2,
  "PlanId": "WebWehig9z4ua",
  "Services": [
    {
      "Type": "webspaces",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 0,
      "BaseQuotaSettings": [
        {
          "Key": "BytesReceived_Shared_WebSpace_Limited",
          "Value": "{\"ComputeMode\":0,\"CustomActionName\":null,\"EnforcementScope\":0,\"ExceededAction\":0,\"Limit\":-1,\"Period\":1440,\"QuotaName\":\"BytesReceived\",\"ResourceName\":\"BytesReceived\",\"SiteMode\":\"Limited\",\"Unit\":1,\"WebPlan\":null}"
        },

        {
          "Key": "NumberOfVirtualWorkers_Dedicated_WebSpace_NULL",
          "Value": "{\"ComputeMode\":1,\"CustomActionName\":null,\"EnforcementScope\":0,\"ExceededAction\":0,\"Limit\":-1,\"Period\":1440,\"QuotaName\":\"NumberOfVirtualWorkers\",\"ResourceName\":\"NumberOfVirtualWorkers\",\"SiteMode\":null,\"Unit\":1,\"WebPlan\":null}"
        }
      ]
    },
    {
      "Type": "sqlservers",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 0,
      "BaseQuotaSettings": [
        {
          "Key": "Editions",
          "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"062713061814\",\"groupType\":null}]"
        }
      ]
    },
    {
      "Type": "mysqlservers",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 2,
      "BaseQuotaSettings": [
        {
          "Key": "Editions",
          "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"offerEditionId\":\"062713061814\",\"groupType\":null}]"
        }
      ]
    }
  ],
  "LastErrorMessage": null,
  "Features": null,
  "OfferFriendlyName": "WebWeb",
  "OfferCategory": null,
  "Created": "2013-06-28T19:26:03.373"
}

Share via