Справочник по REST API уровня данных службы Azure Web PubSub

Статья
10/26/2023

Схема, на которой показан рабочий процесс службы Web PubSub.

Как показано на приведенном выше графике рабочего процесса, а также подробном рабочем процессе, описанном во внутренних элементах, сервер приложений может отправлять сообщения клиентам или управлять подключенными клиентами с помощью REST API, предоставляемых службой Web PubSub. В этой статье подробно описаны интерфейсы REST API.

Использование REST API

Проверка подлинности с помощью Azure Web PubSub Service AccessKey

В каждом HTTP-запросе для проверки подлинности в службе Azure Web PubSub требуется заголовок авторизации с веб-маркером JSON (JWT ).

Алгоритм подписи и подпись

HS256, а именно HMAC-SHA256, используется в качестве алгоритма подписи.

Для подписывания созданного токена JWT следует использовать AccessKey строка подключения экземпляра службы Azure Web PubSub.

Претензии

Ниже указаны утверждения, которые необходимо включить в токен JWT.

Тип утверждения	Обязательно	Description
`aud`	true	Должен совпадать с URL-адресом HTTP-запроса. Например, аудитория широковещательного запроса выглядит следующим образом: `https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01`
`exp`	true	Время эпохи, когда срок действия этого маркера истекает.

Псевдокод в JS:

const bearerToken = jwt.sign({}, connectionString.accessKey, {
  audience: request.url,
  expiresIn: "1h",
  algorithm: "HS256",
});

Проверка подлинности с помощью токена Microsoft Entra

Как и при использовании AccessKey, для проверки подлинности HTTP-запроса также требуется веб-токен JSON (JWT ).

Разница заключается в том, что в этом сценарии токен JWT создается идентификатором Microsoft Entra.

Узнайте, как создать токены Microsoft Entra

Область учетных данных, используемая, должна быть https://webpubsub.azure.com/.default.

Вы также можете использовать контроль доступа на основе ролей (RBAC) для авторизации запроса с сервера в службу Azure Web PubSub.

Узнайте, как настроить роли на основе ролей контроль доступа для ресурса

Программные интерфейсы

Группа операций	Description
Состояние службы	Предоставляет операции для проверки состояния службы
Операции концентратора	Предоставляет операции для управления подключениями и отправки сообщений в них.

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