Synchronize an Add-on

Article
08/24/2015

Applies To: Windows Azure Pack

Synchronizes a plan.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. . <AddonId> should be replaced with an Add-on identifier for the Add-on being synchronized.

Method	Request URI	HTTP version
PUT	https://<ServiceMgmt>:30004/addons/<AddonId>/quota	HTTP/1.1

URI Parameters

The following table describes the URI parameters.

Uri parameter	Description
sync	Required. Set to True to start add-on 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.

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

Element name	Description
PlanAddon	A PlanAddon (Administrator object) object that represents the plan to synchronize.

Example

The following code example shows a Synchronize Add-on request.

PUT https://<computer>:30004/addons/mysqlhiw5rx66/quota?sync=true HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: d45ac1b0-795c-482c-8c1b-93751dd19dda-2013-07-12 15:53:54Z
x-ms-client-session-id: eaec1453-ef45-4ed9-97bd-c064d2467f2a
x-ms-principal-id: PT-CSPOD21\Administrator
Accept-Language: en-US
x-ms-principal-liveid: PT-CSPOD21\Administrator
Content-Type: application/json; charset=utf-8
Host: <computer>:30004
Content-Length: 0
Expect: 100-continue

The following code example shows a Synchronize Add-on response.

{
  "Id": "mysqlhiw5rx66",
  "DisplayName": "mysql addon",
  "State": 1,
  "ConfigState": 1,
  "QuotaSyncState": 1,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "mysql addon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "mysqlservers",
      "ServiceInstanceId": "2BC36D84-DDFF-4455-AAC7-7D0FF3D4ECB1",
      "ServiceDisplayName": "MySQL Server",
      "ServiceInstanceDisplayName": "Default Instance",
      "ConfigState": 1,
      "QuotaSyncState": 1,
      "Settings": [
        {
          "Key": "Editions",
          "Value": "[{\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"0\",\"offerEditionId\":\"1373317509278\"}]"
        }
      ]
    }
  ],
  "SubscriptionCount": 6,
  "AssociatedPlans": [

  ],
  "MaxOccurrencesPerPlan": -1,
  "Price": null
}

Share via