Rest API-verwijzing voor azure Web PubSub-servicegegevensvlak

Artikel
12/12/2024

Diagram van de Web PubSub-servicewerkstroom.

Zoals wordt geïllustreerd door de bovenstaande werkstroomgrafiek en ook gedetailleerde werkstroom die wordt beschreven in internals, kan uw app-server berichten verzenden naar clients of de verbonden clients beheren met behulp van REST API's die beschikbaar zijn gesteld door de Web PubSub-service. In dit artikel worden de REST API's uitgebreid beschreven.

Belangrijk

Onbewerkte verbindingsreeks worden alleen in dit artikel weergegeven voor demonstratiedoeleinden.

Een verbindingsreeks bevat de autorisatiegegevens die nodig zijn voor uw toepassing voor toegang tot de Azure Web PubSub-service. De toegangssleutel in de verbindingsreeks is vergelijkbaar met een hoofdwachtwoord voor uw service. Beveilig uw toegangssleutels altijd in productieomgevingen. Gebruik Azure Key Vault om uw sleutels veilig te beheren en te roteren en uw verbinding te beveiligen.WebPubSubServiceClient

Vermijd het distribueren van toegangssleutels naar andere gebruikers, het coderen ervan of het opslaan van ze ergens in tekst zonder opmaak die toegankelijk is voor anderen. Draai uw sleutels als u denkt dat ze mogelijk zijn aangetast.

REST API gebruiken

Verifiëren via Azure Web PubSub Service AccessKey

In elke HTTP-aanvraag is een autorisatieheader met een JSON-webtoken (JWT) vereist voor verificatie met de Azure Web PubSub-service.

Handtekeningalgoritme en handtekening

HS256, namelijk HMAC-SHA256, wordt gebruikt als het ondertekeningsalgoritme.

U moet het verbindingsreeks van het AccessKey azure Web PubSub Service-exemplaar gebruiken om het gegenereerde JWT-token te ondertekenen.

Claims

Onderstaande claims moeten worden opgenomen in het JWT-token.

Claimtype	Is vereist	Beschrijving
`aud`	true	Moet hetzelfde zijn als de URL van uw HTTP-aanvraag. De doelgroep van een broadcast-aanvraag ziet er bijvoorbeeld als volgt uit: `https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01`
`exp`	true	Tijdsperiode waarin dit token is verlopen.

Een pseudocode in JS:

Onbewerkte verbindingsreeks worden alleen in dit artikel weergegeven voor demonstratiedoeleinden. Beveilig uw toegangssleutels altijd in productieomgevingen. Gebruik Azure Key Vault om uw sleutels veilig te beheren en te roteren en uw verbinding te beveiligen.WebPubSubServiceClient

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

Verifiëren via Microsoft Entra-token

Net als bij het gebruik AccessKeyis ook een JSON Web Token (JWT) vereist om de HTTP-aanvraag te verifiëren.

Het verschil is dat in dit scenario JWT-token wordt gegenereerd door Microsoft Entra-id.

Meer informatie over het genereren van Microsoft Entra-tokens

Het gebruikte referentiebereik moet zijn https://webpubsub.azure.com/.default.

U kunt ook op rollen gebaseerd toegangsbeheer (RBAC) gebruiken om de aanvraag van uw server te autoriseren naar Azure Web PubSub Service.

Meer informatie over het configureren van rollen gebaseerd toegangsbeheer voor uw resource

API's

Bewerkingsgroep	Beschrijving
Servicestatus	Biedt bewerkingen om de servicestatus te controleren
Hubbewerkingen	Biedt bewerkingen voor het beheren van de verbindingen en het verzenden van berichten naar deze verbindingen.

Delen via