Synchronize a Plan

Article
08/24/2015

Applies To: Windows Azure Pack

Synchronizes a plan.

Request

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

Method	Request URI	HTTP Version
PUT	https://<ServiceMgmt>:30004/plans/<PlanId>/Quota	HTTP/1.1

URI Parameters

This request has the following parameters.

Uri parameter	Descriptions
sync	Required. Set to True to start Plan synchronization.

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. 404 is returned if the plan is not found.

Status Code

A successful operation returns status code 202 (Accepted).

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 elements of the request body.

Element name	Description
Plan	The synchronized plan. For more information, See Plan (Administrator object).

Example

The following code example shows a Synchronize Plan request.

PUT https://<Computer>:30004/plans/Hostihixchp2f/quota?sync=true HTTP/1.1
Authorization: Bearer 
x-ms-client-request-id: 29225749-c8bf-49a1-ac7c-00d902cdbdf6-2013-07-09 21:24:11Z
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
Content-Length: 0

The following code example shows a Synchronize Plan response.

{
  "Id": "Hostihixchp2f",
  "DisplayName": "Hosting Plan One",
  "State": 0,
  "ConfigState": 1,
  "QuotaSyncState": 1,
  "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": 1,
      "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