Rest API-referens för Azure Web PubSub-tjänstens dataplan

Som illustreras av arbetsflödesdiagrammet ovan och även detaljerade arbetsflöden som beskrivs internt, kan appservern skicka meddelanden till klienter eller hantera anslutna klienter med hjälp av REST-API:er som exponeras av Web PubSub-tjänsten. I den här artikeln beskrivs REST-API:erna i detalj.

Viktigt!

Råa anslutningssträng visas endast i den här artikeln i demonstrationssyfte.

En anslutningssträng innehåller den auktoriseringsinformation som krävs för att ditt program ska få åtkomst till Azure Web PubSub-tjänsten. Åtkomstnyckeln i anslutningssträng liknar ett rotlösenord för din tjänst. Skydda alltid dina åtkomstnycklar i produktionsmiljöer. Använd Azure Key Vault för att hantera och rotera dina nycklar på ett säkert sätt och skydda anslutningen med WebPubSubServiceClient.

Undvik att distribuera åtkomstnycklar till andra användare, hårdkoda dem eller spara dem var som helst i oformaterad text som är tillgänglig för andra. Rotera dina nycklar om du tror att de har komprometterats.

Använda REST-API

Autentisera via Azure Web PubSub Service AccessKey

I varje HTTP-begäran krävs en auktoriseringsrubrik med en JSON-webbtoken (JWT) för att autentisera med Azure Web PubSub Service.

Signeringsalgoritm och signatur

HS256, nämligen HMAC-SHA256, används som signeringsalgoritm.

Du bör använda i Azure Web PubSub Service-instansens AccessKey anslutningssträng för att signera den genererade JWT-token.

Anspråk

Anspråken nedan måste ingå i JWT-token.

Anspråkstyp	Krävs	beskrivning
aud	true	Bör vara SAMMA som URL:en för DIN HTTP-begäran. En sändningsförfrågans målgrupp ser till exempel ut så här: https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01.
exp	true	Epoktid när denna token kommer att upphöra att gälla.

En pseudokod i JS:

Råa anslutningssträng visas endast i den här artikeln i demonstrationssyfte. Skydda alltid dina åtkomstnycklar i produktionsmiljöer. Använd Azure Key Vault för att hantera och rotera dina nycklar på ett säkert sätt och skydda anslutningen med WebPubSubServiceClient.

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

Autentisera via Microsoft Entra-token

Precis som med hjälp av AccessKeykrävs även en JSON-webbtoken (JWT) för att autentisera HTTP-begäran.

Skillnaden är att I det här scenariot genereras JWT-token av Microsoft Entra-ID.

Lär dig hur du genererar Microsoft Entra-token

Omfånget för autentiseringsuppgifter ska vara https://webpubsub.azure.com/.default.

Du kan också använda rollbaserad åtkomstkontroll (RBAC) för att auktorisera begäran från servern till Azure Web PubSub Service.

Lär dig hur du konfigurerar rollbaserade åtkomstkontrollroller för din resurs

API:er

Åtgärdsgrupp	beskrivning
Tjänststatus	Tillhandahåller åtgärder för att kontrollera tjänststatusen
Hubbåtgärder	Tillhandahåller åtgärder för att hantera anslutningarna och skicka meddelanden till dem.