Referencia de la API REST del plano de datos del servicio Azure Web PubSub

Como se muestra en el gráfico de flujo de trabajo anterior, así como en el flujo de trabajo detallado que se describe en Elementos internos, el servidor de aplicaciones puede enviar mensajes a los clientes o administrar los clientes conectados mediante las API REST que expone el servicio Web PubSub. En este artículo se describen detalladamente las API REST.

Uso de la API de REST

Autenticación mediante la instancia de AccessKey del servicio Azure Web PubSub

En cada solicitud HTTP, se requiere un encabezado de autorización con un JSON Web Token (JWT) para autenticarse con el servicio Azure Web PubSub.

Firma y algoritmo de firma

HS256 (concretamente HMAC-SHA256) se usa como algoritmo de firma.

Debe usar la instancia de AccessKey en la cadena de conexión de la instancia del servicio Azure Web PubSub para firmar el token JWT generado.

Notificaciones

Deben incluirse las notificaciones siguientes en el token JWT.

Tipo de notificación	Es obligatorio	Descripción
aud	true	Debe ser el MISMO que la dirección URL de la solicitud HTTP. Por ejemplo, la audiencia de una solicitud de difusión tiene el aspecto siguiente: https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01.
exp	true	Hora de época en la que expirará este token.

Pseudocódigo en JS:

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

Autenticación mediante el token de Microsoft Entra

Al igual que cuando se usa AccessKey, también se requiere un JSON Web Token (JWT) para autenticar la solicitud HTTP.

La diferencia es que, en este escenario, microsoft Entra ID genera el token JWT.

Obtenga información sobre cómo generar tokens de Microsoft Entra

El ámbito de credencial usado debe ser https://webpubsub.azure.com/.default.

También puede usar el control de acceso basado en rol (RBAC) para autorizar la solicitud del servidor al servicio Azure Web PubSub.

Obtenga información sobre cómo configurar roles de control de acceso basado en rol para el recurso.

API existentes

Grupo de operaciones	Descripción
Estado del servicio	Proporciona operaciones para comprobar el estado del servicio.
Operaciones en el centro de conectividad	Proporciona operaciones para administrar las conexiones y enviarles mensajes.