Retrieve the Subscriptions for a Plan
Applies To: Windows Azure Pack
Retrieves the subscriptions that belong to a plan.
Request
Replace <ServiceMgmt> with your Service Management API endpoint address.
Method |
Request URI |
HTTP version |
|---|---|---|
GET |
https://<ServiceMgmt>:30004/subscriptions |
HTTP/1.1 |
URI Parameters
The following table describes the URI parameters.
URI Parameter |
Description |
|---|---|
planId |
Required. The identifier of the plan that the subscription belongs to. |
Filter |
Optional. A string to use as a query filter. |
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. |
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 |
|---|---|
items |
A list of AdminSubscription (Administrator object) query results. |
filteredTotalCount |
The total number of returned items before paging is applied and after filtering is applied. |
totalCount |
The total number of returned items before paging and filtering are applied. |
Example
The following code example shows a List Plan Subscriptions request.
GET https://<Computer>:30004/subscriptions?planId=WebWehig9z4ua&skip=0&take=25 HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 71437629-f18d-41c1-a7c4-f100fb8a54da-2013-06-28 19:46:04Z
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 List Plan Subscriptions response.
{
"items": [
{
"SubscriptionID": "bbb5b930-4b2d-4744-b1bd-ec512732cab6",
"SubscriptionName": "WebWeb",
"AccountAdminLiveEmailId": "tim4tim@tim.com",
"ServiceAdminLiveEmailId": null,
"CoAdminNames": [
],
"AddOnReferences": [
],
"AddOns": [
],
"State": 1,
"QuotaSyncState": 0,
"ActivationSyncState": 0,
"PlanId": "WebWehig9z4ua",
"Services": [
{
"Type": "webspaces",
"State": "registered",
"QuotaSyncState": 0,
"ActivationSyncState": 0,
"BaseQuotaSettings": [
{
"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": 0,
"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-27T18:19:15.097"
}
],
"filteredTotalCount": 2,
"totalCount": 2
}