Vazby Web PubSub pro Azure Functions

Tato sada článků vysvětluje, jak ověřovat a odesílat zprávy klientům připojeným k podsítě Azure Web PubSub pomocí vazeb Azure Web PubSub ve službě Azure Functions.

Akce	Typ
Zpracování klientských událostí z web pubSub	Vazba triggeru
Zpracování událostí klienta z web pubSub pomocí triggeru HTTP nebo vrácení adresy URL a tokenu přístupu klienta	Vstupní vazba
Vyvolání rozhraní API služby	Výstupní vazba

Ukázky

Instalace rozšíření

Balíček NuGet rozšíření, který nainstalujete, závisí na režimu jazyka C#, který používáte ve své aplikaci funkcí:

Izolovaný model pracovního procesu

Funkce se spouštějí v izolovaném pracovním procesu C#. Další informace najdete v průvodci spuštěním služby Azure Functions v jazyce C# v izolovaném pracovním procesu.

Přidejte rozšíření do projektu instalací tohoto balíčku NuGet.

Model v procesu

Důležité

Podpora modelu v procesu skončí 10. listopadu 2026. Důrazně doporučujeme migrovat aplikace do izolovaného modelu pracovního procesu pro plnou podporu.

Funkce se spouštějí ve stejném procesu jako hostitel služby Functions. Další informace najdete v tématu Vývoj funkcí knihovny tříd jazyka C# pomocí Azure Functions.

Přidejte rozšíření do projektu instalací tohoto balíčku NuGet.

Instalace sady

Pokud chcete v aplikaci použít toto rozšíření vazeb, ujistěte se, že soubor host.json v kořenovém adresáři projektu obsahuje tento extensionBundle odkaz:

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[4.0.0, 5.0.0)"
    }
}

V tomto příkladu version hodnota [4.0.0, 5.0.0) dává hostiteli Functions pokyn, aby používal verzi sady, která je alespoň 4.0.0 , ale menší než 5.0.0, která zahrnuje všechny potenciální verze 4.x. Tato notace efektivně udržuje vaši aplikaci na nejnovější dostupné podverzi sady rozšíření v4.x.

Pokud je to možné, měli byste použít nejnovější hlavní verzi sady rozšíření a umožnit modulu runtime automaticky udržovat nejnovější podverzi. Obsah nejnovější sady můžete zobrazit na stránce verze sady rozšíření. Další informace najdete v sadách rozšíření Azure Functions.

Poznámka:

Rozšíření Web PubSub pro Javu se zatím nepodporují.

Klíčové koncepty

(1)-(2) WebPubSubConnection vstupní vazba s HttpTriggerem pro generování připojení klienta.

(3)-(4) WebPubSubTrigger aktivační vazby nebo WebPubSubContext vstupní vazby s HttpTriggerem pro zpracování požadavku služby.

(5)-(6) WebPubSub výstupní vazba pro vyžádání služby něco udělat.

Připojení

K připojení ke službě Azure Web PubSub můžete použít připojovací řetězec nebo identitu Microsoft Entra .

Připojovací řetězec

Ve výchozím nastavení se k WebPubSubConnectionString ukládání připojovací řetězec Web PubSub používá nastavení aplikace. Pokud se rozhodnete pro připojení použít jiný název nastavení, musíte ho explicitně nastavit jako název klíče v definicích vazeb. Během místního vývoje je také nutné toto nastavení přidat do Values kolekce v souborulocal.settings.json.

Důležité

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. Pro zajištění optimálního zabezpečení by vaše aplikace funkcí měla používat spravované identity při připojování ke službě Web PubSub místo použití připojovacího řetězce.

Podrobnosti o tom, jak nakonfigurovat a používat Web PubSub a Azure Functions společně, najdete v kurzu: Vytvoření bezserverové aplikace pro oznámení pomocí azure Functions a služby Azure Web PubSub.

Připojení založená na identitách

Pokud používáte rozšíření Azure Web PubSub Functions v1.10.0 nebo vyšší, místo připojovacího řetězce s přístupovým klíčem můžete aplikaci funkcí nakonfigurovat tak, aby se ověřila ve službě Azure Web PubSub pomocí identity Microsoft Entra.

Tento přístup eliminuje potřebu správy tajných kódů a doporučuje se pro produkční úlohy.

Požadavky

Ujistěte se, že identita Microsoft Entra používaná vaší aplikací funkcí byla udělena odpovídající roli Azure RBAC na cílovém prostředku Web PubSub:

• Vlastník podsítě Azure Web PubSub

Konfigurace

Připojení založená na identitách ve službě Azure Functions používají sadu nastavení, která sdílejí společnou předponu. Rozšíření Azure Web PubSub Functions ve výchozím nastavení hledají nastavení s předponou WebPubSubConnectionString. Tuto předponu můžete přizpůsobit nastavením vlastnosti v triggeru connection nebo vazbě.

Pro Azure Web PubSub musíte zadat nastavení specifické pro službu, které musíte zadat, je identifikátor URI koncového bodu služby:

Vlastnictví	Šablona proměnné prostředí	Description	Povinné
URI služby	WebPubSubConnectionString__serviceUri	Identifikátor URI koncového bodu služby Web PubSub.	Ano

Při hostovaní ve službě Azure Functions používají připojení založená na identitách spravovanou identitu. Identita přiřazená systémem se používá ve výchozím nastavení, i když je možné zadat identitu přiřazenou uživatelem. Další informace o tom, jak přizpůsobit identitu, společné vlastnosti pro připojení založená na identitě.

Při spuštění v jiných kontextech, jako je místní vývoj, se místo toho použije vaše identita vývojáře, i když je možné ji přizpůsobit. Viz také Místní vývoj s připojeními podle identit.

Příklad konfigurace

Následující příklad ukazuje, jak nakonfigurovat identitu na základě výchozího nastavení:

{
  "WebPubSubConnectionString__serviceUri": "https://your-webpubsub.webpubsub.azure.com"
}

Poznámka:

Pokud používáte local.settings.json soubor v místním prostředí, Aplikace Azure Konfigurace nebo Key Vault k poskytování nastavení pro připojení založená na identitě, nahraďte __: v názvu nastavení název nastavení, aby se názvy správně přeložily.

Například: WebPubSubConnectionString:serviceUri.

Další kroky

• Zpracování klientských událostí z web pubSub (vazba triggeru)
• Zpracování událostí klienta z webového pubSub pomocí triggeru HTTP nebo vrácení adresy URL a tokenu přístupu klienta (vstupní vazba)
• Vyvolání rozhraní API služby (výstupní vazba)