Informazioni di riferimento sulle API REST del piano dati del piano dati di Pubblicazione Web di Azure

Articolo
10/26/2023

Diagram showing the Web PubSub service workflow.

Come illustrato dal grafico del flusso di lavoro precedente e anche dal flusso di lavoro dettagliato descritto in internals, il server app può inviare messaggi ai client o gestire i client connessi usando le API REST esposte dal servizio Web PubSub. Questo articolo descrive in dettaglio le API REST.

Uso dell'API REST

Eseguire l'autenticazione tramite AccessKey del servizio Web PubSub di Azure

In ogni richiesta HTTP, è necessaria un'intestazione di autorizzazione con un token JSON Web (JWT) per l'autenticazione con il servizio PubSub Web di Azure.

Algoritmo di firma e firma

HS256, ovvero HMAC-SHA256, viene usato come algoritmo di firma.

È consigliabile usare nel AccessKey stringa di connessione dell'istanza del servizio Web PubSub di Azure per firmare il token JWT generato.

Richieste di rimborso

Le attestazioni seguenti devono essere incluse nel token JWT.

Tipo di attestazione	Obbligatorio	Descrizione
`aud`	true	Deve essere uguale all'URL della richiesta HTTP. Ad esempio, il pubblico di una richiesta di trasmissione è simile al seguente: `https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01`.
`exp`	true	Periodo di tempo in cui questo token sarà scaduto.

Uno pseudo-codice in JS:

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

Eseguire l'autenticazione tramite il token Microsoft Entra

Analogamente all'uso AccessKeydi , è necessario anche un token JSON Web (JWT) per autenticare la richiesta HTTP.

La differenza è che, in questo scenario, il token JWT viene generato dall'ID Microsoft Entra.

Informazioni su come generare token Microsoft Entra

L'ambito delle credenziali usato deve essere https://webpubsub.azure.com/.default.

È anche possibile usare il controllo degli Controllo di accesso accessi in base al ruolo (RBAC) per autorizzare la richiesta dal server al servizio Web PubSub di Azure.

Informazioni su come configurare i ruoli di Controllo di accesso basati sui ruoli per la risorsa

API

Gruppo di operazioni	Descrizione
Stato del servizio	Fornisce operazioni per controllare lo stato del servizio
Operazioni dell'hub	Fornisce operazioni per gestire le connessioni e inviare messaggi.

Condividi tramite