Retrieve a Plan

Article
08/24/2015

Applies To: Windows Azure Pack

Retrieves a plan.

Request

Specify the Get Plan request as follows: Replace <ServiceMgmt> with your Service Management API endpoint address. <PlanIdentifier> should be replaced with the plan identifier for the plan being retrieved.

Method	Request URI	HTTP version
GET	https://<ServiceMgmt>:30004/plans/<PlanIdentifier>	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

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 the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response header	Description
Plan	The retrieved plan. For more information, See Plan Objects for Administrators.

Response Body

The following table describes the elements of the request body.

Response header	Description
Plan	The retrieved plan. For more information, See Plan Objects for Administrators.

Example

The following code example shows a Get Plan request.

GET https://<Computer>:30004/plans/Hostihixchp2f HTTP/1.1
Authorization: Bearer 
x-ms-client-request-id: 7bb987b1-5e20-438e-a428-f0402a599a40-2013-07-10 17:58:56Z
x-ms-client-session-id: abdf5f79-1a76-48e7-a37f-d5b3af5b0662
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 Plan response.

{
  "Id": "Hostihixchp2f",
  "DisplayName": "Hosting Plan One",
  "State": 0,
  "ConfigState": 1,
  "QuotaSyncState": 0,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "Hosting Plan One",
      "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": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"070913050037\",\"groupType\":null}]"
        }
      ]
    }
  ],
  "SubscriptionCount": 1,
  "MaxSubscriptionsPerAccount": 1,
  "AddOnReferences": [

  ],
  "AddOns": [

  ],
  "InvitationCode": null,
  "Price": null
}

Share via