Migrate a Subscription

 

Applies To: Windows Azure Pack

Migrates a subscription to a different plan.

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

Method

Request URI

HTTP Version

PATCH

https://<ServiceMgmt>:30004/subscriptions/<SubscriptionId>?migrate=true

HTTP/1.1

The following table describes the URI parameters.

URI parameter

Description

migrate

Set to true to migrate the subscription.

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 request body contains an AdminSubscription (Administrator object). The following elements are required for migrating a subscription. The other elements are ignored.

Element name

Description

SubscriptionId

The subscription identifier.

PlanId

The target plan for the subscription migration.

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

AdminSubscription

The migrated subscription. For more information, see AdminSubscription (Administrator object).

Show: