Share via


Update an Add-on

 

Applies To: Windows Azure Pack

Updates an add-on.

Request

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

Method

Request URI

HTTP version

PUT

https://<ServiceMgmt>:30004/addons/<AddonIdentifier>

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

The following table describes the request body.

Element name

Description

PlanAddon

The add-on to be updated. For more information, see PlanAddon (Administrator object).

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 request body.

Element name

Description

PlanAddon

The updated add-on. For more information, see PlanAddon (Administrator object).

Example

The following code example shows an Add Add-on Service request.

PUT https://<Computer>:30004/addons/GoldAhihps8jy HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: ad8d982f-361c-4f99-ac4f-96f9e0d7c443-2013-06-28 18:38:08Z
x-ms-client-session-id: d19ca528-d7bf-4a62-9d4d-03adbb4f6c74
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Content-Type: application/json; charset=utf-8
Host: <Computer>:30004
Content-Length: 512
Expect: 100-continue

{
  "Id": "GoldAhihps8jy",
  "DisplayName": "GoldAddon",
  "State": 1,
  "ConfigState": 0,
  "QuotaSyncState": 2,
  "LastErrorMessage": null,
  "Advertisements": [
    {
      "LanguageCode": "en-us",
      "DisplayName": "GoldAddon",
      "Description": null
    }
  ],
  "ServiceQuotas": [
    {
      "ServiceName": "sqlservers",
      "ServiceInstanceId": "7BAD5022-79CA-4B53-8177-1ACAEEAFA099",
      "ServiceDisplayName": "SQL Servers",
      "ServiceInstanceDisplayName": null,
      "ConfigState": 0,
      "QuotaSyncState": 2,
      "Settings": [

      ]
    }
  ],
  "SubscriptionCount": 0,
  "AssociatedPlans": [

  ],
  "MaxOccurrencesPerPlan": 2,
  "Price": null
}

See Also

Administrator Add-on Interfaces