Disable a Subscription

Article
08/24/2015

Applies To: Windows Azure Pack

Disables a subscription.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. Replace <SubscriptionId> with the subscription identifier for the subscription to be disabled.

Method	Request URI	HTTP version
PATCH	https://<ServiceMgmt>:30004/subscriptions/<SubscriptionId>	HTTP/1.1

Request Headers

The following table describes required and optional request headers.

Request header	Description
Authorization: Bearer	Required. The authorization bearer token.
x-ms-client-request-id:	Optional. The client request identifier.
x-ms-client-session-id:	Optional. The client session identifier.
x-ms-client-principal-id:	Optional. The principal identifier.
x-ms-principal-liveid:	Optional. The principal Live identifier.

Request Body

The request body is an AdminSubscription (Administrator object). The following elements are required to Disable a subscription. Other elements are ignored.

Element name	Description
Status	Set to Suspended to enable the subscription.
SubscriptionId	The identifier of the subscription to be Disabled.

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

Element name	Description
AdminSubscription	The disabled subscription. For more information, see AdminSubscription (Administrator object).

Example

The following code example shows a Disable Subscription request.

PATCH https://<Computer>:30004/subscriptions/512d113d-44e0-4fb4-81d1-2770be611d14 HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 8517493b-3e0e-449f-bb0e-4fb299021cae-2013-06-28 19:28:12Z
x-ms-client-session-id: 36d65d7b-42b5-4fc0-8334-93c10e7a90f2
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: 371
Expect: 100-continue

{
  "AccountAdminLiveEmailId": null,
  "AccountAdminLivePuid": null,
  "AccountId": "00000000-0000-0000-0000-000000000000",
  "FriendlyName": null,
  "OfferCategory": null,
  "OfferInfo": null,
  "OfferType": 0,
  "ReasonCode": null,
  "ServiceAdminLiveEmailId": null,
  "ServiceAdminLivePuid": null,
  "SubscriptionId": "512d113d-44e0-4fb4-81d1-2770be611d14",
  "Status": "Suspended",
  "PlanId": null,
  "CoAdminNames": null
}

The following code example shows a Disable Subscription response.

{
  "SubscriptionID": "512d113d-44e0-4fb4-81d1-2770be611d14",
  "SubscriptionName": "WebWeb",
  "AccountAdminLiveEmailId": "[email protected]",
  "ServiceAdminLiveEmailId": null,
  "CoAdminNames": [

  ],
  "AddOnReferences": [

  ],
  "AddOns": [

  ],
  "State": 2,
  "QuotaSyncState": 0,
  "ActivationSyncState": 0,
  "PlanId": "WebWehig9z4ua",
  "Services": [
    {
      "Type": "webspaces",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 0,
      "BaseQuotaSettings": [
        {
          "Key": "BytesReceived_Shared_WebSpace_Limited",
          "Value": "{\"ComputeMode\":0,\"CustomActionName\":null,\"EnforcementScope\":0,\"ExceededAction\":0,\"Limit\":-1,\"Period\":1440,\"QuotaName\":\"BytesReceived\",\"ResourceName\":\"BytesReceived\",\"SiteMode\":\"Limited\",\"Unit\":1,\"WebPlan\":null}"
        },

        {
          "Key": "NumberOfVirtualWorkers_Dedicated_WebSpace_NULL",
          "Value": "{\"ComputeMode\":1,\"CustomActionName\":null,\"EnforcementScope\":0,\"ExceededAction\":0,\"Limit\":-1,\"Period\":1440,\"QuotaName\":\"NumberOfVirtualWorkers\",\"ResourceName\":\"NumberOfVirtualWorkers\",\"SiteMode\":null,\"Unit\":1,\"WebPlan\":null}"
        }
      ]
    },
    {
      "Type": "sqlservers",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 0,
      "BaseQuotaSettings": [
        {
          "Key": "Editions",
          "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"062713061814\",\"groupType\":null}]"
        }
      ]
    },
    {
      "Type": "mysqlservers",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 0,
      "BaseQuotaSettings": [
        {
          "Key": "Editions",
          "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"offerEditionId\":\"062713061814\",\"groupType\":null}]"
        }
      ]
    }
  ],
  "LastErrorMessage": null,
  "Features": null,
  "OfferFriendlyName": "WebWeb",
  "OfferCategory": null,
  "Created": "2013-06-28T19:26:03.373"
}

Share via