Referenční informace k rozhraní REST API roviny dat služby Azure Web PubSub

Jak je znázorněno výše uvedeným grafem pracovního postupu a také podrobný pracovní postup popsaný v interních informacích, může váš aplikační server odesílat zprávy klientům nebo spravovat připojené klienty pomocí rozhraní REST API vystavených službou Web PubSub. Tento článek podrobně popisuje rozhraní REST API.

Důležité

Nezpracované připojovací řetězec se v tomto článku zobrazují jenom pro demonstrační účely.

Připojovací řetězec obsahuje informace o autorizaci vyžadované pro vaši aplikaci pro přístup ke službě Azure Web PubSub. Přístupový klíč uvnitř připojovací řetězec je podobný kořenovému heslu pro vaši službu. V produkčních prostředích vždy chraňte přístupové klíče. Pomocí služby Azure Key Vault můžete bezpečně spravovat a obměňovat klíče a zabezpečit připojení WebPubSubServiceClient.

Vyhněte se distribuci přístupových klíčů ostatním uživatelům, jejich pevnému kódování nebo jejich uložení kdekoli ve formátu prostého textu, který je přístupný ostatním uživatelům. Otočte klíče, pokud se domníváte, že mohly být ohroženy.

Pomocí rozhraní REST API

Ověřování prostřednictvím přístupového klíče služby Azure Web PubSub

V každém požadavku HTTP se k ověření pomocí služby Azure Web PubSub vyžaduje autorizační hlavička s webovým tokenem JSON (JWT ).

Podpisový algoritmus a podpis

HS256, konkrétně HMAC-SHA256, se používá jako podpisový algoritmus.

K podepsání vygenerovaného tokenu JWT byste měli použít AccessKey instanci připojovací řetězec služby Azure Web PubSub Service.

Žádosti

Do tokenu JWT je potřeba zahrnout následující deklarace identity.

Typ deklarace identity	Je povinné	Popis
aud	true	Měla by být stejná jako adresa URL požadavku HTTP. Například cílová skupina požadavku vysílání vypadá takto: https://example.webpubsub.azure.com/api/hubs/myhub/:send?api-version=2022-11-01.
exp	true	Epocha, kdy platnost tohoto tokenu vyprší.

Pseudokód v JS:

Nezpracované připojovací řetězec se v tomto článku zobrazují jenom pro demonstrační účely. V produkčních prostředích vždy chraňte přístupové klíče. Pomocí služby Azure Key Vault můžete bezpečně spravovat a obměňovat klíče a zabezpečit připojení WebPubSubServiceClient.

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

Ověřování prostřednictvím tokenu Microsoft Entra

Stejně jako použití AccessKeyse k ověření požadavku HTTP vyžaduje také webový token JSON (JWT).

Rozdíl spočívá v tom, že v tomto scénáři se token JWT vygeneruje pomocí ID Microsoft Entra.

Naučte se generovat tokeny Microsoft Entra.

Použitý obor přihlašovacích údajů by měl být https://webpubsub.azure.com/.default.

K autorizaci požadavku ze serveru do služby Azure Web PubSub Můžete také použít řízení přístupu na základě role (RBAC ).

Informace o konfiguraci rolí řízení přístupu na základě rolí pro prostředek

Rozhraní API

Skupina operací	Popis
Stav služby	Poskytuje operace pro kontrolu stavu služby.
Operace centra	Poskytuje operace pro správu připojení a odesílání zpráv.