Подготовка новой подписки (подписка клиента)

Статья
08/24/2015

Область применения: Windows Azure Pack

Подготавливает новую подписку с указанными сведениями.

Запрос

Замените <ServiceMgmt> адресом конечной точки API управления службами.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
POST	<https:// ServiceMgmt>:30005/subscriptions	HTTP/1.1

Параметры URI

Отсутствует.

Заголовки запросов

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса	Описание
x-ms-principal-id:	Обязательный. Идентификатор участника.
Авторизация: носитель	Обязательный. Токен носителя авторизации.
x-ms-client-request-id:	Необязательный элемент. Идентификатор запроса клиента.
x-ms-client-session-id:	Необязательный элемент. Идентификатор сеанса клиента.
x-ms-principal-liveid:	Необязательный элемент. Идентификатор основной динамической трансляции.

Текст запроса

В следующей таблице описываются элементы текста запроса.

Имя элемента	Описание
AccountAdminLiveEmailId	Идентификатор учетной записи Майкрософт администратора учетной записи. Не требуется для подготовки подписки. Используйте значение NULL.
AccountAdminLivePuid	Идентификатор учетной записи Passport администратора учетной записи. Это должна быть существующая учетная запись пользователя. Вы можете использовать извлечение пользователя , чтобы определить, существует ли учетная запись.
AccountId	Идентификатор учетной записи. Используйте Guid.Empty.
FriendlyName	Понятное имя подписки.
OfferCategory	Категория предложения. Используйте значение NULL.
OfferInfo	Сведения о предложении. Используйте значение NULL.
OfferType	Тип предложения. Используйте 0.
ReasonCode	Код причины. Используйте значение NULL.
ServiceAdminLiveEmailId	Идентификатор учетной записи Майкрософт администратора службы. Это значение не используется Windows Azure Pack и требуется только для целей согласованности. Используйте значение NULL.
ServiceAdminLivePuid	Идентификатор учетной записи Passport администратора службы. Не требуется для подготовки подписки. Используйте значение NULL.
SubscriptionId	Идентификатор подписки. Используйте Guid.NewGuid(). ToString() для создания GUID.
Status	Состояние подписки. Используйте значение NULL.
PlanId	Идентификатор плана, на который подписан план.
CoAdminNames	Список соадминистраторов. Используйте значение NULL, если соадминистраторов не существует. Соадминистраторам не нужно знать системе. После создания учетной записи соадминистратора подписка автоматически применяется к соадминистратору.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа.

Код состояния

Успешная операция возвращает код состояния 200 (ОК). MaxSubscriptionsPerPlanReached возвращается, если достигнуто максимальное количество подписок, допустимых для плана.

Сведения о кодах состояния см. в разделе "Коды состояния" и "Коды ошибок" (Windows управления пакетом обновления Azure).

Заголовки откликов

Ответ для этой операции включает стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Текст ответа

В следующей таблице описываются ключевые элементы текста ответа.

Имя элемента	Описание
Подписка	Подготовленные подписки. Дополнительные сведения см. в разделе "Подписка (общий объект)".

Пример

В следующем примере кода показан запрос на подготовку подписки .

POST https://<Computer>:30005/subscriptions HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 02130fee-13b7-4b93-b618-3a8830dbe611-2014-04-15 20:00:55Z
x-ms-client-session-id: eec98428-7dd5-4033-8a2c-77946f61a2f6
x-ms-principal-id: NewUser%40contoso.com
Accept-Language: en-US
Content-Type: application/json; charset=utf-8
Host: <computer>:30005
Content-Length: 458
Expect: 100-continue
{
  "AccountAdminLiveEmailId": null,
  "AccountAdminLivePuid": "newuser@contoso.com",
  "AccountId": "00000000-0000-0000-0000-000000000000",
  "FriendlyName": "MyServicePlanX",
  "OfferCategory": null,
  "OfferInfo": null,
  "OfferType": 0,
  "ReasonCode": null,
  "ServiceAdminLiveEmailId": null,
  "ServiceAdminLivePuid": "newuser@contoso.com",
  "SubscriptionId": "da506abb-1658-4abf-971c-e0e5a9c47b83",
  "Status": null,
  "PlanId": "MyServicePlanX18aa6bac",
  "CoAdminNames": null
}

В следующем примере кода показан текст ответа "Подготовка подписки ".

{
  "SubscriptionID": "da506abb-1658-4abf-971c-e0e5a9c47b83",
  "SubscriptionName": "MyServicePlanX",
  "AccountAdminLiveEmailId": "newuser@contoso.com",
  "ServiceAdminLiveEmailId": null,
  "CoAdminNames": [

  ],
  "AddOnReferences": [

  ],
  "AddOns": [

  ],
  "State": 1,
  "QuotaSyncState": 0,
  "ActivationSyncState": 1,
  "PlanId": "MyServicePlanX18aa6bac",
  "Services": [
    {
      "Type": "mysqlservers",
      "State": "registered",
      "QuotaSyncState": 0,
      "ActivationSyncState": 1,
      "BaseQuotaSettings": [
        {
          "Key": "Editions",
          "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"offerEditionId\":\"040814101717\",\"groupType\":null}]"
        }
      ]
    }
  ],
  "LastErrorMessage": null,
  "Features": null,
  "OfferFriendlyName": "MyServicePlanX",
  "OfferCategory": null,
  "Created": "2014-04-15T20:00:59.187"
}

Примечания

Портал управления для клиентов выполняет следующие вызовы REST при подготовке подписки.

Получите доступные планы. Он используется для отображения планов, на которые пользователь может подписаться. Возвращаемые объекты плана (объекта администратора) имеют свойство Id . После выбора плана значение идентификатора используется для идентификации выбранного плана в вызове для подготовки новой подписки.
Получение пользователя. Так как подписка не может быть создана для пользователя, который не существует, этот вызов подтверждает, что пользователь действительно существует.
Подготовка новой подписки. Подготавливает подписку, используя предоставленные сведения.

См. также:

Интерфейсы подписки клиента

Поделиться через