Обновление установки

Статья
05/26/2023

Центры уведомлений Azure поддерживают частичные обновления для установки, используя стандарт JSON-Patch в RFC6902.

Запрос

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
PATCH	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

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

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

Заголовок запроса	Описание
Content-Type	`application/json-patch+json`
Авторизация	Маркер SAS, созданный, как указано в разделе Проверка подлинности подписанного URL-адреса с помощью служебной шины.
x-ms-version	2015-01

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

Разрешены следующие операции исправления:

операция JSON-Patch	Свойство установки	Описание и пример
add	PushChannel	Обновите канал установки. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` При изменении pushChannel установите значение expiredPushChannel в значение true.
add	UserId	Обновите или добавьте значение идентификатора пользователя. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
add	Тег	Если значением является массив, добавьте все теги в массиве к существующим (даже если они отсутствуют). Если значение является строкой, добавьте тег в текущий массив (или создайте новый массив с одним значением, если в данный момент нет тегов). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
add	Шаблон (P2)	Обновление или добавление всего шаблона. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
add	Текст шаблона,заголовок/срок действия/теги	Обновление или добавление частей шаблона (обратите внимание, что "add" в заголовках заменяет текущий объект заголовков). Добавление тегов имеет ту же семантику, что и собственные теги. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
add	канал secondaryTile	Обновления канал secondaryTile. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
add	тег secondaryTile	Аналогично обновлению тегов, но путь ссылается на вторичную плитку. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
add	Шаблон secondaryTile	То же, что и обычные шаблоны, но path ссылается на tileId.
add	secondaryTile template body/header/expiry/tags	То же, что и обычные шаблоны, но path ссылается на tileId.
Удалить	То же, что и выше	Удаляет свойство, например userID, или элемент массива тегов. Если последний тег свойства tags удаляется, удаляется все свойство. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Заменить	То же, что и выше	Семантически эквивалентно удалению и добавлению.

Ответ

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

Коды ответов

Код	Описание
204	Установка успешно исправлена
400	Не удалось установить исправления, так как запрос был сформирован неправильно.
401	Ошибка авторизации. Указана неправильная клавиша доступа.
403	Превышена квота; слишком много регистраций в этом пространстве имен. Регистрация не создана.
403	Запрос отклонен, так как частота вызовов API слишком высока.

Дополнительные сведения о кодах состояния см. в разделе Коды состояния и ошибок.

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

Заголовок ответа	Описание
Content-type	`application/json-patch+json`
Content-Location	Расположение установки в формате : `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Текст ответа

Нет.

См. также:

Создание или перезапись установки
Чтение установки
Удаление установки

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