Referência da API REST do plano de dados de serviço do Azure Web PubSub

Artigo
12/12/2024

Diagrama mostrando o fluxo de trabalho do serviço Web PubSub.

Conforme ilustrado pelo grafo de fluxo de trabalho acima e pelo fluxo de trabalho detalhado descrito nos internos, o servidor de aplicativos pode enviar mensagens aos clientes ou gerenciar os clientes conectados usando APIs REST expostas pelo serviço Web PubSub. Este artigo descreve as APIs REST em detalhes.

Importante

As cadeias de conexão brutas aparecem neste artigo apenas para fins de demonstração.

Uma cadeia de conexão inclui as informações de autorização necessárias para que o seu aplicativo acesse o serviço Azure Web PubSub. A chave de acesso dentro da cadeia de conexão é semelhante a uma senha raiz para o serviço. Em ambientes de produção, sempre proteja suas chaves de acesso. Use o Azure Key Vault para gerenciar e girar suas chaves com segurança e proteger sua conexão com WebPubSubServiceCliento .

Evite distribuir chaves de acesso para outros usuários, fazer hard-coding com elas ou salvá-las em qualquer lugar em texto sem formatação que seja acessível a outras pessoas. Gire suas chaves se você acredita que elas podem ter sido comprometidas.

Usar a API REST

Autenticar por meio do AccessKey do Serviço do Azure Web PubSub

Em cada solicitação HTTP, é necessário um cabeçalho de autorização com um JWT (Token Web JSON) para autenticar com o Serviço Azure Web PubSub.

Assinatura e algoritmo de assinatura

HS256, a saber, HMAC-SHA256, é usado como o algoritmo de assinatura.

Você deve usar AccessKey na cadeia de conexão da instância do Serviço do Azure Web PubSub para assinar o token JWT gerado.

Declarações

As declarações abaixo são necessárias para serem incluídas no token JWT.

Tipo de declaração	Obrigatório	Descrição
`aud`	true	Deve ser o mesmo que o URL da sua solicitação HTTP. Por exemplo, o público de uma solicitação de transmissão é semelhante a: `https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01`.
`exp`	true	Hora da época em que esse token expirará.

Um pseudocódigo no JS:

As cadeias de conexão brutas aparecem neste artigo apenas para fins de demonstração. Em ambientes de produção, sempre proteja suas chaves de acesso. Use o Azure Key Vault para gerenciar e girar suas chaves com segurança e proteger sua conexão com WebPubSubServiceCliento .

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

Autenticar por meio do token do Microsoft Entra

Assim como ao usar AccessKey, um JWT (Token Web JSON) também é necessário para autenticar a solicitação HTTP.

A diferença é que, nesse cenário, o Token JWT é gerado pela ID do Microsoft Entra.

Saiba como gerar tokens do Microsoft Entra

O escopo de credencial usado deve ser https://webpubsub.azure.com/.default.

Você também pode usar o RBAC (Controle de acesso baseado em função) para autorizar a solicitação do servidor para o Serviço do Azure Web PubSub.

Saiba como configurar funções de Controle de acesso baseado em função para seu recurso

APIs

Grupos de Operações	Descrição
Status de serviço	Fornece operações para verificar o status do serviço
Operações do Hub	Fornece operações para gerenciar as conexões e enviar mensagens para elas.

Compartilhar via