Retrieve a Plan (Tenant Plan)

 

Applies To: Windows Azure Pack

Retrieves a plan.

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

Method

Request URI

HTTP Version

GET

https://<ServiceMgmt>:30005/plans/<PlanId>

HTTP/1.1

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.

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.

username

Optional. The add-on user name.

There are 3 calling options. Any other combination results in a no request body call.

Option

Description

PlanId in the calling URI onlyincludePrice

No request body.

includeprice, region & username

includeprice and username supplied.

Includeprice, region

Includeprice supplied.

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 200 (OK).

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

The following table describes the key elements of the response body:

Element name

Description

Plan

The retrieved plan. For more information, see Plan (Administrator object).

Show: