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

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

Conforme ilustrado pelo gráfico de fluxo de trabalho acima e também pelo fluxo de trabalho detalhado descrito em internos, seu servidor de aplicativos pode enviar mensagens para 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 ligação inclui a informação de autorização que a sua aplicação precisa para aceder ao serviço Azure Web PubSub. A chave de acesso na cadeia de ligação funciona como uma palavra-passe root para o seu serviço. Em ambientes de produção, proteja sempre as 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, codificá-las ou salvá-las em qualquer lugar em texto simples acessível a outras pessoas. Rode as chaves se acreditar que podem ter sido comprometidas.

Com a API REST

Autenticar através do Azure Web PubSub Service AccessKey

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

Algoritmo de assinatura e assinatura

HS256, ou seja, HMAC-SHA256, é usado como o algoritmo de assinatura.

Deves usar a AccessKey instância de cadeia de ligação do Azure Web PubSub Service para assinar o JWT gerado.

Pedidos

As reivindicações abaixo devem ser incluídas no JWT.

Tipo de reclamação É Necessário Description
aud verdadeiro Deve ser o MESMO que o URL da sua solicitação HTTP. Por exemplo, o público de uma solicitação de transmissão se parece com: https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01.
exp verdadeiro Época em que este token expirará.

Um pseudocódigo em JS:

As cadeias de conexão brutas aparecem neste artigo apenas para fins de demonstração. Em ambientes de produção, proteja sempre as 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 através do token Microsoft Entra

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

A diferença é que, neste cenário, o JWT é gerado pelo Microsoft Entra ID.

Saiba como gerar tokens do Microsoft Entra

O escopo da 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 seu servidor para o Serviço PubSub da Web do Azure.

Aprenda a adicionar atribuições de funções

APIs

Grupo de Operações Description
Estado do Serviço Fornece operações para verificar o status do serviço
Operações REST Fornece operações para gerenciar as conexões e enviar mensagens para elas.
  • Last updated on