Создание подписки для уведомления

Статья
08/24/2015

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

Используется API управления службами для уведомления поставщика ресурсов о создании подписки на план. Предоставленный объект Subscription предоставляет сведения, которые могут использоваться поставщиком ресурсов для внутренней обработки новой подписки.

Запрос

Замените <NotificationEndpoint> адресом конечной точки для Windows REST API уведомлений пользовательского поставщика ресурсов Azure Pack.

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

Параметры URI

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

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

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

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

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

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

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

Ответ

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

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

Возвращает код состояния 201 (создан), если внутренняя подписка поставщика ресурсов успешно создана. Код состояния 202 (принято) может быть возвращен, если операция выполняется асинхронно.

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

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

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

Текст ответа

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

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

Пример

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

POST https://<NotificationEndpoint>/subscriptions HTTP/1.1
Referer: https://<Computer>:30004/subscriptions
Accept-Language: en-US
x-ms-client-request-id: 4abcdb02-cf03-4b07-a1e1-d43c4fe06a8b-2013-07-25 06:09:39Z
x-ms-client-session-id: be02e255-38de-4e86-9690-b3a3e3037e4c
x-ms-principal-id: <COMPUTER>\Administrator
x-ms-principal-liveid: <COMPUTER>\Administrator
x-ms-request-id: 60668356a6204f269a455cc3f3901a84.2013-07-25T06:09:42.8465532Z
Authorization: Basic <encoded username and password>
Content-Type: application/json; charset=utf-8
Host: <Computer>:30010
Content-Length: 438
Expect: 100-continue
{
  "SubscriptionId": "685a05ed-3a6f-4c3a-b70c-924a1307834f",
  "SubscriptionName": "Hosting Plan One",
  "State": 0,
  "LifecycleState": 0,
  "LastErrorMessage": null,
  "QuotaSettings": [
    {
      "Key": "Editions",
      "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"070913050037\",\"groupType\":null}]"
    }
  ],
  "AdminId": "egghead@contoso.com",
  "CoAdminIds": [

  ]
}

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

{
  "SubscriptionId": "685a05ed-3a6f-4c3a-b70c-924a1307834f",
  "SubscriptionName": "Hosting Plan One",
  "State": 0,
  "LifecycleState": 0,
  "LastErrorMessage": null,
  "QuotaSettings": [
    {
      "Key": "Editions",
      "Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceSize\":\"1024\",\"resourceSizeLimit\":\"1024\",\"offerEditionId\":\"070913050037\",\"groupType\":null}]"
    }
  ],
  "AdminId": "egghead@contoso.com",
  "CoAdminIds": [

  ]
}

Примечания

При вызове TBD API управления службами ожидает одну минуту ответа. Если ответ не получен, подписка помечается как не синхронизированная.

Поддерживаются асинхронные операции. Если операция создания займет более минуты, поставщик ресурсов может вернуть значение 202 (принято) и задать внутреннее представление подписки (объект конечной точки уведомления). LifecycleState to Provisioning. После завершения операции создания поставщик ресурсов должен задать его представление подписки (объект конечной точки уведомления). LifecycleState to Provisioned . API управления службами проверит подписку (объект конечной точки уведомления). LifecycleState для завершения операции каждые 10 секунд с помощью TBD.

См. также:

Справочник по REST API уведомлений пользовательского поставщика ресурсов Windows Пакета Azure

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