REST-API-Referenz für die Azure Web PubSub-Dienstdatenebene

Artikel
02/14/2025

Darstellung des Web PubSub-Dienstworkflows.

Wie im obigen Workflowdiagramm dargestellt und wie im unter Interna beschriebenen Workflow, kann Ihr App-Server Nachrichten an Clients senden oder die verbundenen Clients mithilfe von REST-APIs verwalten, die vom Web PubSub-Dienst verfügbar gemacht werden. In diesem Artikel werden die REST-APIs ausführlich beschrieben.

Wichtig

Unformatierte Verbindungszeichenfolgen werden in diesem Artikel nur zu Demonstrationszwecken angezeigt.

Eine Verbindungszeichenfolge enthält die Autorisierungsinformationen, die Ihre Anwendung für den Zugriff auf den Azure Web PubSub-Dienst benötigt. Der Zugriffsschlüssel in der Verbindungszeichenfolge ähnelt einem Stammkennwort für Ihren Dienst. Schützen Sie Ihre Zugriffsschlüssel in Produktionsumgebungen immer sorgfältig. Verwenden Sie Azure Key Vault zum sicheren Verwalten und Rotieren Ihrer Schlüssel und zum Schützen Ihrer Verbindung mit WebPubSubServiceClient.

Geben Sie Zugriffsschlüssel nicht an andere Benutzer weiter, vermeiden Sie das Hartcodieren, und speichern Sie die Schlüssel nicht als Klartext, auf den andere Benutzer Zugriff haben. Rotieren Sie die Schlüssel, wenn Sie glauben, dass sie möglicherweise gefährdet sind.

Verwenden der REST-API

Authentifizieren über AccessKey des Azure Web PubSub-Diensts

In jeder HTTP-Anforderung ist ein Autorisierungsheader mit einem JSON Web Token (JWT) erforderlich, um sich beim Azure Web PubSub-Dienst zu authentifizieren.

Signaturalgorithmus und -signatur

HS256 (HMAC-SHA256) wird als Signaturalgorithmus verwendet.

Sie sollten den AccessKey in der Verbindungszeichenfolge der Azure Web PubSub-Dienstinstanz verwenden, um das generierte JWT-Token zu signieren.

Ansprüche

Die unten stehenden Ansprüche müssen in das JWT-Token aufgenommen werden.

Anspruchstyp	Ist erforderlich	Beschreibung
`aud`	true	Sollte identisch mit Ihrer HTTP-Anforderungs-URL sein. Beispielsweise sieht die Zielgruppe einer Übertragungsanfrage (Broadcast) wie folgt aus: `https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01`.
`exp`	true	Epochenzeit, zu der dieses Token abläuft.

Ein Pseudocode in JS:

Unformatierte Verbindungszeichenfolgen werden in diesem Artikel nur zu Demonstrationszwecken angezeigt. Schützen Sie Ihre Zugriffsschlüssel in Produktionsumgebungen immer sorgfältig. Verwenden Sie Azure Key Vault zum sicheren Verwalten und Rotieren Ihrer Schlüssel und zum Schützen Ihrer Verbindung mit WebPubSubServiceClient.

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

Authentifizieren über das Microsoft Entra-Token

Wie bei der Verwendung des AccessKey ist ein JSON Web Token (JWT) ebenfalls erforderlich, um die HTTP-Anforderung zu authentifizieren.

Der Unterschied besteht in diesem Szenario darin, dass JWT-Token von Microsoft Entra ID generiert wird.

Erfahren Sie, wie Sie Microsoft Entra-Token generieren.

Der verwendete Anmeldeinformationsbereich sollte https://webpubsub.azure.com/.default sein.

Sie können auch die rollenbasierte Zugriffssteuerung (Role Based Access Control, RBAC) verwenden, um die Anforderung von Ihrem Server an den Azure Web PubSub-Dienst zu autorisieren.

Erfahren Sie, wie Sie rollenbasierte Zugriffssteuerungsrollen für Ihre Ressource konfigurieren.

APIs

Vorgangsgruppe	Beschreibung
Dienststatus	Stellt Vorgänge zum Überprüfen des Dienststatus bereit.
Hub-Vorgänge	Stellt Vorgänge zum Verwalten der Verbindungen und zum Senden von Nachrichten an diese bereit.

Teilen über