Azure Web PubSub-triggers en -bindingen voor Azure Functions

In deze verwijzing wordt uitgelegd hoe u Web PubSub-gebeurtenissen in Azure Functions kunt verwerken.

Web PubSub is een door Azure beheerde service waarmee ontwikkelaars eenvoudig webtoepassingen kunnen bouwen met realtime functies en een patroon publiceren-abonneren.

Handeling	Typologie
Een functie uitvoeren wanneer berichten afkomstig zijn van de service	Trigger binding
Aanvraag binden aan doelobject onder HTTP-trigger voor onderhandelings- en upstream-aanvragen	Inputkoppeling
Serviceacties aanroepen	Uitvoerbinding

Broncode | Pakket | API-referentiedocumentatie | Productdocumentatie | Voorbeelden

Toevoegen aan uw functie-app

Als u met de trigger en bindingen werkt, moet u verwijzen naar het juiste pakket. Het NuGet-pakket wordt gebruikt voor .NET-klassebibliotheken terwijl een uitbreidingsbundel wordt gebruikt voor alle andere toepassingstypen.

Taal	Toevoegen door...
C#	Installeer het NuGet-pakket, de specifieke doelversie
JavaScript, Python, PowerShell, C#-script (alleen Azure Portal)	Uitbreidingsbundels ( aanbevolen) gebruiken, extensies expliciet installeren

Belangrijke concepten

Diagram van de werkstroom van de Azure Web PubSub-service die werkt met Function Apps.

(1)-(2) WebPubSubConnection invoerbinding met HttpTrigger om clientverbinding te genereren.

(3)-(4) WebPubSubTrigger Triggerbinding of WebPubSubContext Invoerbinding met HttpTrigger om serviceaanvragen te verwerken.

(5)-(6) WebPubSub uitvoerbinding om een serviceverzoek uit te voeren.

Triggerbinding

Gebruik de functietrigger om aanvragen van de Azure Web PubSub-service te verwerken.

WebPubSubTrigger wordt gebruikt wanneer u aanvragen van de servicezijde moet verwerken. Het eindpuntpatroon van de trigger is als volgt en moet worden ingesteld in de Web PubSub-service (Portal: instellingen -> gebeurtenishandler -> URL-sjabloon). In het eindpuntpatroon is het queryonderdeel code=<API_KEY> VEREIST wanneer u Azure Function App gebruikt om beveiligingsredenen. De sleutel vindt u in Azure Portal. Zoek uw functie-app-resource en navigeer naar Functies ->App-sleutels ->Systeemsleutels ->webpubsub_extension nadat u de functie-app naar Azure hebt geïmplementeerd. Deze sleutel is echter niet nodig wanneer u met lokale functies werkt.

<Function_App_Url>/runtime/webhooks/webpubsub?code=<API_KEY>

Schermopname van functiesysteemsleutels ophalen.

Voorbeeld

[FunctionName("WebPubSubTrigger")]
public static void Run(
    [WebPubSubTrigger("<hub>", WebPubSubEventType.User, "message")] UserEventRequest request, ILogger log)
{
    log.LogInformation($"Request from: {request.ConnectionContext.UserId}");
    log.LogInformation($"Request message data: {request.Data}");
    log.LogInformation($"Request message dataType: {request.DataType}");
}

WebPubSubTrigger binding ondersteunt ook retourwaarde in synchronisatiescenario's, bijvoorbeeld systeem Connect - en gebruikersbeurtenis, wanneer de server de clientaanvraag kan controleren en weigeren, of berichten rechtstreeks naar de beller kan verzenden. Connect gebeurtenis respecteert ConnectEventResponse en EventErrorResponse, en gebruikersgebeurtenis respecteert UserEventResponse en EventErrorResponse, resttypen die niet overeenkomen met het huidige scenario worden genegeerd. En als EventErrorResponse wordt geretourneerd, verbreekt de service de clientverbinding.

[FunctionName("WebPubSubTriggerReturnValueFunction")]
public static UserEventResponse Run(
    [WebPubSubTrigger("hub", WebPubSubEventType.User, "message")] UserEventRequest request)
{
    return request.CreateResponse(BinaryData.FromString("ack"), WebPubSubDataType.Text);
}

In het volgende voorbeeld ziet u een Web PubSub-trigger JavaScript-functie.

const { app, trigger } = require('@azure/functions');

const wpsTrigger = trigger.generic({
    type: 'webPubSubTrigger',
    name: 'request',
    hub: '<hub>',
    eventName: 'message',
    eventType: 'user'
});

app.generic('message', {
    trigger: wpsTrigger,
    handler: async (request, context) => {
        context.log('Request from: ', request.connectionContext.userId);
        context.log('Request message data: ', request.data);
        context.log('Request message dataType: ', request.dataType);
    }
});

WebPubSubTrigger binding biedt ook ondersteuning voor retourwaarde in synchronisatiescenario's, bijvoorbeeld systeem Connect - en gebruikersevenementen, wanneer de server de clientaanvraag kan controleren en weigeren, of het bericht rechtstreeks naar de aanvraagclient kan verzenden. In javaScript wordt zwak getypte taal gedeserialiseerd met betrekking tot de objectsleutels. Bovendien heeft EventErrorResponse de hoogste prioriteit vergeleken met de andere objecten, dat als code in de retour zit, het wordt geparseerd naar EventErrorResponse en de client verbinding wordt verbroken.

app.generic('message', {
    trigger: wpsTrigger,
    handler: async (request, context) => {
          return { 
              "data": "ack",
              "dataType" : "text"
          };
    }
});

Triggerbinding definiëren in function.json.

{
  "disabled": false,
  "bindings": [
    {
      "type": "webPubSubTrigger",
      "direction": "in",
      "name": "data",
      "hub": "<hub>",
      "eventName": "message",
      "eventType": "user"
    }
  ]
}

Definieer de functie in index.js.

module.exports = function (context, data) {
  context.log('Request from: ', context.bindingData.request.connectionContext.userId);
  context.log('Request message data: ', data);
  context.log('Request message dataType: ', context.bindingData.request.dataType);
}

WebPubSubTrigger binding biedt ook ondersteuning voor retourwaarde in synchronisatiescenario's, bijvoorbeeld systeem Connect - en gebruikersevenementen, wanneer de server de clientaanvraag kan controleren en weigeren, of het bericht rechtstreeks naar de aanvraagclient kan verzenden. In de zwak getypte taal JavaScript wordt gedeserialiseerd wat betreft de objectsleutels. Bovendien heeft EventErrorResponse de hoogste prioriteit vergeleken met de overige objecten, dat als code zich in de terugkeer bevindt, deze wordt verwerkt en de klantverbinding via EventErrorResponse wordt verbroken.

module.exports = async function (context) {
  return { 
    "data": "ack",
    "dataType" : "text"
  };
}

Kenmerken en aantekeningen

Gebruik het kenmerk in C#-klassebibliotheken.WebPubSubTrigger

Hier volgt een WebPubSubTrigger attribuut in een methodehandtekening:

[FunctionName("WebPubSubTrigger")]
public static void Run([WebPubSubTrigger("<hub>", <WebPubSubEventType>, "<event-name>")] 
    WebPubSubConnectionContext context, ILogger log)
{
    ...
}

Zie het C#-voorbeeld voor een volledig voorbeeld.

Configuratie

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u in het function.json-bestand hebt ingesteld.

function.json-eigenschap	Attribuuteigenschap	Beschrijving
soort	n.v.t.	Vereist - moet worden ingesteld op `webPubSubTrigger`.
richting	n.v.t.	Vereist - moet worden ingesteld op `in`.
naam	n.v.t.	Vereist: de variabelenaam die wordt gebruikt in functiecode voor de parameter die de gebeurtenisgegevens ontvangt.
hub	Knooppunt	Vereist: de waarde moet worden ingesteld op de naam van de Web PubSub-hub om de functie te activeren. We ondersteunen het instellen van de waarde in kenmerk als hogere prioriteit, of deze kan worden ingesteld in app-instellingen als een globale waarde.
gebeurtenistype	WebPubSubEventType	Vereist: de waarde moet worden ingesteld als het gebeurtenistype van berichten om de functie te activeren. De waarde moet `user` of `system` zijn.
eventName	Naam van het evenement	Vereist: de waarde moet worden ingesteld als de gebeurtenis van berichten om de functie te activeren. Voor `system` gebeurtenistype moet de naam van de gebeurtenis worden weergegeven in `connect`, `connected`, `disconnected`. Voor door de gebruiker gedefinieerde subprotocollen is `message`de gebeurtenisnaam . Voor door het systeem ondersteunde subprotocol `json.webpubsub.azure.v1.`is de gebeurtenisnaam door de gebruiker gedefinieerde gebeurtenisnaam.
verbinding	Verbinding	Optioneel: de naam van een app-instellingen of verzameling die de upstream Azure Web PubSub-service aangeeft. De waarde wordt gebruikt voor handtekeningvalidatie. En de waarde wordt standaard automatisch bepaald met de app-instellingen "WebPubSubConnectionString". En `null` betekent dat de validatie niet nodig is en altijd slaagt.

Gebruik

In C# WebPubSubEventRequest is het type herkende bindingsparameter. Rest-parameters zijn afhankelijk van de parameternaam. Controleer de onderstaande tabel met beschikbare parameters en typen.

In een zwakgetypte taal zoals JavaScript, wordt name in function.json gebruikt om het triggerobject te koppelen aan de onderstaande mappingstabel. En respecteer dataType in function.json om het bericht dienovereenkomstig te converteren wanneer name als bindingsobject is ingesteld op data voor de triggerinvoer. Alle parameters kunnen worden gelezen uit context.bindingData.<BindingName> en worden JObject geconverteerd.

Bindingsnaam	Bindingstype	Beschrijving	Eigenschappen
aanvraag	`WebPubSubEventRequest`	Beschrijft de upstream-aanvraag	Eigenschap verschilt per verschillende gebeurtenistypen, waaronder afgeleide klassen`ConnectEventRequest`, `ConnectedEventRequestUserEventRequest` en`DisconnectedEventRequest`
verbindingscontext	`WebPubSubConnectionContext`	Algemene aanvraaggegevens	EventType, EventName, Hub, ConnectionId, UserId, Headers, Origin, Signature, Staten
gegevens	`BinaryData`,,`string`,`Streambyte[]`	Berichtgegevens aanvragen van cliënt tijdens de gebruikers `message` gebeurtenis	-
gegevenstype	`WebPubSubDataType`	Request message dataType, die `binary`, `text`, `json` ondersteunt	-
aanspraken	`IDictionary<string, string[]>`	Gebruikersclaims in systeemaanvraag `connect`	-
zoekopdracht	`IDictionary<string, string[]>`	Gebruikersquery in systeemaanvraag `connect`	-
subprotocollen	`IList<string>`	Beschikbare subprotocollen in systeemaanvraag `connect`	-
clientcertificaten	`IList<ClientCertificate>`	Een lijst met certificaatvingerafdrukken van clients in systeemaanvraag `connect`	-
reden	`string`	Reden in systeemaanvraag `disconnected`	-

Belangrijk

In C# moeten parameters die door meerdere typen worden ondersteund als eerste worden geplaatst, dat wil zeggen request of data in plaats van het standaardtype BinaryData om de functie correct te binden.

Antwoord retourneren

WebPubSubTrigger respecteert het geretourneerde antwoord van de klant voor synchrone gebeurtenissen van connect en gebruikersgebeurtenissen. Alleen overeenkomende antwoorden worden teruggestuurd naar de service, anders wordt het genegeerd. WebPubSubTrigger Bovendien ondersteunt return-object gebruikers voor SetState() en ClearStates() het beheren van de metagegevens voor de verbinding. En de extensie voegt de resultaten van de retourwaarde samen met de oorspronkelijke waarden uit de aanvraag WebPubSubConnectionContext.States. De waarde in de bestaande sleutel wordt overschreven en de waarde in de nieuwe sleutel wordt toegevoegd.

Retourtype	Beschrijving	Eigenschappen
`ConnectEventResponse`	Antwoord voor `connect` gebeurtenis	Groepen, rollen, userid, subprotocol
`UserEventResponse`	Antwoord voor gebruikersevenement	DataType, Gegevens
`EventErrorResponse`	Foutreactie voor de synchronisatie-gebeurtenis	Code, Foutmelding
`*WebPubSubEventResponse`	Basisreactietype van de ondersteunde antwoorden die worden gebruikt voor onzekere retourcases	-

Invoerbinding

Onze extensie biedt twee invoerbindingen die gericht zijn op verschillende behoeften.

WebPubSubConnection

Als u een client verbinding wilt laten maken met Azure Web PubSub Service, moet deze de URL van het service-eindpunt en een geldig toegangstoken weten. De WebPubSubConnection invoerbinding produceert vereiste informatie, zodat de client deze tokengeneratie zelf niet hoeft te verwerken. Omdat het token tijdslimiet heeft en kan worden gebruikt om een specifieke gebruiker te verifiëren bij een verbinding, slaat u het token niet in de cache op of deelt u het tussen clients. Een HTTP-trigger die met deze invoerbinding werkt, kan worden gebruikt voor clients om de verbindingsgegevens op te halen.
WebPubSubContext

Wanneer u Static Web Apps gebruikt, is HttpTrigger de enige ondersteunde trigger en in het Web PubSub-scenario bieden we de WebPubSubContext invoerbinding die gebruikers helpt om de upstream http-aanvraag vanaf de servicezijde onder Web PubSub-protocollen te deserialiseren. Zo kunnen klanten vergelijkbare resultaten krijgen die vergelijkbaar zijn met WebPubSubTrigger om eenvoudig te verwerken in functies. Zie de voorbeelden hieronder. Wanneer deze wordt gebruikt met HttpTrigger, moet de klant de HttpTrigger-URL in de gebeurtenishandler dienovereenkomstig configureren.

Voorbeeld- `WebPubSubConnection`

In het volgende voorbeeld ziet u een C#-functie die verbindingsgegevens van Web PubSub verkrijgt met behulp van de invoerbinding en deze retourneert via HTTP. In het onderstaande voorbeeld wordt het doorgegeven via een UserId queryonderdeel voor clientaanvragen, zoals ?userid={User-A}.

[FunctionName("WebPubSubConnectionInputBinding")]
public static WebPubSubConnection Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubConnection(Hub = "<hub>", UserId = "{query.userid}")] WebPubSubConnection connection)
{
    return connection;
}

const { app, input } = require('@azure/functions');

const connection = input.generic({
    type: 'webPubSubConnection',
    name: 'connection',
    userId: '{query.userId}',
    hub: '<hub>'
});

app.http('negotiate', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraInputs: [connection],
    handler: async (request, context) => {
        return { body: JSON.stringify(context.extraInputs.get('connection')) };
    },
});

Invoerbindingen definiëren in function.json.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "webPubSubConnection",
      "name": "connection",
      "userId": "{query.userid}",
      "hub": "<hub>",
      "direction": "in"
    }
  ]
}

Definieer de functie in index.js.

module.exports = function (context, req, connection) {
  context.res = { body: connection };
  context.done();
};

Geverifieerde tokens

Als de functie wordt geactiveerd door een geverifieerde client, kunt u een gebruikers-id-claim toevoegen aan het gegenereerde token. U kunt eenvoudig verificatie toevoegen aan een functie-app met behulp van App Service-verificatie.

Met App Service-verificatie worden HTTP-headers ingesteld met de namen x-ms-client-principal-id en x-ms-client-principal-name, die respectievelijk de client-principal-id en de naam van de geverifieerde gebruiker bevatten.

U kunt de eigenschap UserId van de binding instellen op de waarde van de header met behulp van een bindingexpressie: {headers.x-ms-client-principal-id} of {headers.x-ms-client-principal-name}.

[FunctionName("WebPubSubConnectionInputBinding")]
public static WebPubSubConnection Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubConnection(Hub = "<hub>", UserId = "{headers.x-ms-client-principal-name}")] WebPubSubConnection connection)
{
    return connection;
}

Notitie

Beperkingen bij de bindingparametertypen ondersteunen geen manier om een lijst of array door te geven. De WebPubSubConnection wordt niet volledig ondersteund door alle parameters die de server-SDK heeft, met name roles, en omvat ook groups en expiresAfter. In het geval dat de klant rollen moet toevoegen of het bouwproces van het toegangstoken in de functie moet uitstellen, wordt aanbevolen om met de Server SDK voor C# te werken.

[FunctionName("WebPubSubConnectionCustomRoles")]
public static async Task<Uri> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req)
{
    var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "<hub>", "<web-pubsub-connection-string>");
    var userId = req.Query["userid"].FirstOrDefault();
    // your method to get custom roles.
    var roles = GetRoles(userId);
    return await serviceClient.GetClientAccessUriAsync(TimeSpan.FromMinutes(5), userId, roles);
}

Notitie

Beperkingen bij de bindingparametertypen ondersteunen geen manier om een lijst of array door te geven. De WebPubSubConnection wordt niet volledig ondersteund door alle parameters die de server-SDK heeft, met name roles, en omvat ook groups en expiresAfter. In het geval dat klanten rollen moeten toevoegen of het toegangstoken in een functie moeten opbouwen, wordt aanbevolen om te werken met de server-SDK voor JavaScript.

const { app } = require('@azure/functions');
const { WebPubSubServiceClient } = require('@azure/web-pubsub');
app.http('negotiate', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    handler: async (request, context) => {
        const serviceClient = new WebPubSubServiceClient(process.env.WebPubSubConnectionString, "<hub>");
        let token = await serviceClient.getAuthenticationToken({ userId: req.query.userid, roles: ["webpubsub.joinLeaveGroup", "webpubsub.sendToGroup"] });
        return { body: token.url };
    },
});

Notitie

Beperkingen bij de bindingparametertypen ondersteunen geen manier om een lijst of array door te geven. De WebPubSubConnection wordt niet volledig ondersteund door alle parameters die de server-SDK heeft, met name roles, en omvat ook groups en expiresAfter. In het geval dat klanten rollen moeten toevoegen of het toegangstoken in een functie moeten opbouwen, wordt aanbevolen om te werken met de server-SDK voor JavaScript.

Invoerbindingen definiëren in function.json.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req"
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    }
  ]
}

Definieer de functie in index.js.

const { WebPubSubServiceClient } = require('@azure/web-pubsub');

module.exports = async function (context, req) {
  const serviceClient = new WebPubSubServiceClient(process.env.WebPubSubConnectionString, "<hub>");
  let token = await serviceClient.getAuthenticationToken({ userId: req.query.userid, roles: ["webpubsub.joinLeaveGroup", "webpubsub.sendToGroup"] });
  context.res = { body: token.url };
  context.done();
};

Voorbeeld- `WebPubSubContext`

In het volgende voorbeeld ziet u een C#-functie die web pubsub upstream-aanvraaggegevens verkrijgt met behulp van de invoerbinding onder connect gebeurtenistype en retourneert deze via HTTP.

[FunctionName("WebPubSubContextInputBinding")]
public static object Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSubContext] WebPubSubContext wpsContext)
{
    // in the case request is a preflight or invalid, directly return prebuild response by extension.
    if (wpsContext.IsPreflight || wpsContext.HasError)
    {
        return wpsContext.Response;
    }
    var request = wpsContext.Request as ConnectEventRequest;
    var response = new ConnectEventResponse
    {
        UserId = wpsContext.Request.ConnectionContext.UserId
    };
    return response;
}

const { app, input } = require('@azure/functions');

const wpsContext = input.generic({
    type: 'webPubSubContext',
    name: 'wpsContext'
});

app.http('connect', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraInputs: [wpsContext],
    handler: async (request, context) => {
        var wpsRequest = context.extraInputs.get('wpsContext');

        return { "userId": wpsRequest.request.connectionContext.userId };
    }
});

Invoerbindingen definiëren in function.json.

{
  "disabled": false,
  "bindings": [
    {
      "authLevel": "anonymous",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "webPubSubContext",
      "name": "wpsContext",
      "direction": "in"
    }
  ]
}

Definieer de functie in index.js.

module.exports = async function (context, req, wpsContext) {
  // in the case request is a preflight or invalid, directly return prebuild response by extension.
  if (wpsContext.hasError || wpsContext.isPreflight)
  {
    return wpsContext.response;
  }
  // return an http response with connect event response as body.
  return { body: {"userId": wpsContext.connectionContext.userId} };
};

Configuratie

WebPubSubConnection

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u hebt ingesteld in het function.json-bestand en het WebPubSubConnection kenmerk.

function.json-eigenschap	Kenmerkeigenschap	Beschrijving
soort	n.v.t.	Moet worden ingesteld op `webPubSubConnection`
richting	n.v.t.	Moet worden ingesteld op `in`
naam	n.v.t.	Variabelenaam die wordt gebruikt in functiecode voor het bindingsobject voor invoerverbindingen.
hub	Knooppunt	Vereist: de waarde moet worden ingesteld op de naam van de Web PubSub-hub om de functie te activeren. We ondersteunen het instellen van de waarde in kenmerk als hogere prioriteit, of deze kan worden ingesteld in app-instellingen als een globale waarde.
userId	Gebruikers-id	Optioneel: de waarde van de claim voor de gebruikers-id die moet worden ingesteld in het toegangssleuteltoken.
verbinding	Verbinding	Vereist: de naam van de app-instelling die de verbindingsreeks van de Web PubSub-service bevat (standaard ingesteld op 'WebPubSubConnectionString').

WebPubSubContext

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u hebt ingesteld in het functions.json-bestand en het WebPubSubContext kenmerk.

function.json-bestandseigenschap	Attribuuteigenschap	Beschrijving
soort	n.v.t.	Moet worden ingesteld op `webPubSubContext`.
richting	n.v.t.	Moet worden ingesteld op `in`.
naam	n.v.t.	Variabelenaam dat wordt gebruikt in functiecode voor invoer van een Web PubSub-aanvraag.
verbinding	Verbinding	Optioneel: de naam van een app-instellingen of verzameling die de upstream Azure Web PubSub-service aangeeft. De waarde wordt gebruikt voor misbruikbeveiliging en handtekeningvalidatie. De waarde wordt standaard automatisch omgezet met WebPubSubConnectionString. En `null` betekent dat de validatie niet nodig is en altijd slaagt.

Gebruik

WebPubSubConnection

WebPubSubConnection bevat de onderstaande eigenschappen.

Bindingsnaam	Bindingstype	Beschrijving
BaseUri	URI	Web PubSub-client verbinding URI.
URI	URI	Absolute URI van de Web PubSub-verbinding, bevat `AccessToken` gegenereerd op basis van de aanvraag.
AccessToken	tekenreeks	Gegenereerd `AccessToken` op basis van aanvraag UserId en servicegegevens.

WebPubSubConnection bevat de onderstaande eigenschappen.

Bindingsnaam	Beschrijving
baseUrl	Web PubSub client verbindings-URI.
URL	Absolute URI van de Web PubSub-verbinding, bevat `AccessToken` basis gegenereerd op basis van het verzoek.
accessToken	Gegenereerd `AccessToken` op basis van aanvraag UserId en servicegegevens.

WebPubSubConnection bevat de onderstaande eigenschappen.

Bindingsnaam	Beschrijving
baseUrl	Web PubSub-clientverbindings-URI.
URL	Absolute URI van de Web PubSub-verbinding, bevat `AccessToken` die is gegenereerd op basis van de aanvraag.
accessToken	Gegenereerd `AccessToken` op basis van aanvraag UserId en servicegegevens.

WebPubSubContext

WebPubSubContext bevat de onderstaande eigenschappen.

Bindingsnaam	Bindingstype	Beschrijving	Eigenschappen
aanvraag	`WebPubSubEventRequest`	Aanvraag van client, zie de onderstaande tabel voor meer informatie.	`WebPubSubConnectionContext` van de header van het verzoek en andere eigenschappen die gedeserialiseerd zijn uit de body van het verzoek, beschrijven het verzoek, bijvoorbeeld `ReasonDisconnectedEventRequest`.
antwoord	`HttpResponseMessage`	Extensie-builds reageren voornamelijk op `AbuseProtection` en fouten.	-
foutmelding	tekenreeks	Beschrijf de foutdetails bij het verwerken van de upstream-aanvraag.	-
hasError	Bool	Vlag om aan te geven of het een geldige Web PubSub-upstream-aanvraag is.	-
isPreflight	Bool	Vlag om aan te geven of het een voorbereidende aanvraag van `AbuseProtection`is.	-

Wanneer WebPubSubEventRequest gedeserialiseerd wordt, resulteert het in verschillende klassen die specifieke informatie over het aanvraagscenario verschaffen. Voor PreflightRequest of ongeldige gevallen kan de gebruiker de indicatoren IsPreflight en HasError controleren om te weten. Het wordt aangeraden om rechtstreeks de systeem-build reactie WebPubSubContext.Response te retourneren, of de klant kan fouten loggen wanneer dat nodig is. In verschillende scenario's kan de klant de aanvraageigenschappen lezen zoals hieronder.

Afgeleide klasse	Beschrijving	Eigenschappen
`PreflightRequest`	Wordt gebruikt in `AbuseProtection` wanneer `IsPreflight`is waar	-
`ConnectEventRequest`	Wordt gebruikt in het gebeurtenistype van het systeem `Connect`	Claims, Query, Subprotocollen, Clientcertificaten
`ConnectedEventRequest`	Wordt gebruikt in het gebeurtenistype van het systeem `Connected`	-
`UserEventRequest`	Wordt gebruikt in het gebruikersgebeurtenistype	Gegevens, Gegevenstype
`DisconnectedEventRequest`	Wordt gebruikt in het gebeurtenistype van het systeem `Disconnected`	Reden

Notitie

Hoewel de WebPubSubContext invoerbinding een vergelijkbare methode voor het deserialiseren van aanvragen biedt onder HttpTrigger in vergelijking met WebPubSubTrigger, zijn er beperkingen; namelijk dat de verbindingsstatus na samenvoegen niet wordt ondersteund. Het retourantwoord wordt nog steeds gerespecteerd door de servicezijde, maar gebruikers moeten het antwoord zelf bouwen. Als gebruikers behoeften hebben om het antwoord op de gebeurtenis in te stellen, moet u een HttpResponseMessage die ConnectEventResponse bevat of berichten voor de gebruikersgebeurtenis retourneren als response body en de verbindingsstatus met de sleutel ce-connectionstate in de responseheader plaatsen.

Uitvoerbinding

Gebruik de Web PubSub-uitvoerbinding om de Azure Web PubSub-service aan te roepen om iets te doen. U kunt een bericht uitzenden naar:

Alle verbonden clients
Verbonden clients geverifieerd voor een specifieke gebruiker
Verbonden clients die lid zijn van een specifieke groep
Een specifieke clientverbinding

Met de uitvoerbinding kunt u niet alleen clients en groepen beheren, maar ook machtigingen gericht op een specifieke connectionId binnen een groep verlenen of intrekken.

Verbinding toevoegen aan groep
Gebruiker toevoegen aan groep
Verbinding uit een groep verwijderen
Gebruiker uit een groep verwijderen
Gebruiker verwijderen uit alle groepen
Alle clientverbindingen sluiten
Een specifieke clientverbinding sluiten
Verbindingen in een groep sluiten
Machtiging verlenen voor een verbinding
Machtiging voor een verbinding intrekken

Zie het overzicht voor informatie over de setup en configuratie.

Voorbeeld

[FunctionName("WebPubSubOutputBinding")]
public static async Task RunAsync(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
    [WebPubSub(Hub = "<hub>")] IAsyncCollector<WebPubSubAction> actions)
{
    await actions.AddAsync(WebPubSubAction.CreateSendToAllAction("Hello Web PubSub!", WebPubSubDataType.Text));
}

const { app, output } = require('@azure/functions');
const wpsMsg = output.generic({
    type: 'webPubSub',
    name: 'actions',
    hub: '<hub>',
});

app.http('message', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    extraOutputs: [wpsMsg],
    handler: async (request, context) => {
        context.extraOutputs.set(wpsMsg, [{
            "actionName": "sendToAll",
            "data": `Hello world`,
            "dataType": `text`
        }]);
    }
});

Bindingen definiëren in functions.json.

{
  "disabled": false,
  "bindings": [
    {
      "type": "webPubSub",
      "name": "actions",
      "hub": "<hub>",
      "direction": "out"
    }
  ]
}

Definieer de functie in index.js.

module.exports = async function (context) {
  context.bindings.actions = {
    "actionName": "sendToAll",
    "data": "hello",
    "dataType": "text"
  };
  context.done();
}

WebPubSubAction

WebPubSubAction is het abstracte basistype van uitvoerbindingen. De afgeleide typen vertegenwoordigen de actieserver die de service wil aanroepen.

In de C#-taal bieden we een aantal statische methoden WebPubSubAction om beschikbare acties te detecteren. De gebruiker kan bijvoorbeeld het SendToAllAction maken door WebPubSubAction.CreateSendToAllAction() aan te roepen.

Afgeleide klasse	Eigenschappen
`SendToAllAction`	Gegevens, DataType, Uitgesloten
`SendToGroupAction`	Groep, Gegevens, DataType, Uitgesloten
`SendToUserAction`	Gebruikers-ID, Gegevens, Gegevenstype
`SendToConnectionAction`	VerbindingsId, Gegevens, Gegevenstype
`AddUserToGroupAction`	UserId, groep
`RemoveUserFromGroupAction`	UserId, groep
`RemoveUserFromAllGroupsAction`	Gebruikers-id
`AddConnectionToGroupAction`	ConnectionId, Groep
`RemoveConnectionFromGroupAction`	ConnectionId, Groep
`CloseAllConnectionsAction`	Uitgesloten, reden
`CloseClientConnectionAction`	Connectie-id, Reden
`CloseGroupConnectionsAction`	Groep, uitgesloten, reden
`GrantPermissionAction`	VerbinderingsId, Machtiging, DoelNaam
`RevokePermissionAction`	VerbinderingsId, Machtiging, DoelNaam

In zwak getypte taal zoals javascript, actionName is de sleutelparameter om het type op te lossen, beschikbare acties worden vermeld zoals hieronder.

Actienaam	Eigenschappen
`sendToAll`	Gegevens, DataType, Uitgesloten
`sendToGroup`	Groep, Gegevens, DataType, Uitgesloten
`sendToUser`	Gebruikers-ID, Gegevens, Gegevenstype
`sendToConnection`	VerbindingsId, Gegevens, Gegevenstype
`addUserToGroup`	UserId, groep
`removeUserFromGroup`	UserId, groep
`removeUserFromAllGroups`	Gebruikers-id
`addConnectionToGroup`	Connectie-ID, Groep
`removeConnectionFromGroup`	Verbindings-ID, Groep
`closeAllConnections`	Uitgesloten, reden
`closeClientConnection`	ConnectionId, Reden
`closeGroupConnections`	Groep, uitgesloten, reden
`grantPermission`	VerbinderingsId, Machtiging, DoelNaam
`revokePermission`	VerbinderingsId, Machtiging, DoelNaam

Belangrijk

De eigenschap berichtgegevens in de acties voor het verzenden van berichten moet string zijn als het gegevenstype is ingesteld op json of text om dubbelzinnigheid bij gegevensconversie te voorkomen. JSON.stringify() Gebruik dit om het json-object te converteren dat nodig is. Dit wordt toegepast op elke locatie met behulp van de berichteigenschap, bijvoorbeeld bij het werken met UserEventResponse.Data en WebPubSubTrigger.

Wanneer binary het gegevenstype is ingesteld, is het toegestaan om binding te gebruiken die op natuurlijke wijze wordt ondersteund, zoals binary geconfigureerd in de function.json. Raadpleeg Trigger- en bindingsdefinities voor meer informatie.

In zwak getypte taal zoals javascript, actionName is de sleutelparameter om het type op te lossen, beschikbare acties worden vermeld zoals hieronder.

Actienaam	Eigenschappen
`sendToAll`	Gegevens, DataType, Uitgesloten
`sendToGroup`	Groep, Gegevens, DataType, Uitgesloten
`sendToUser`	Gebruikers-ID, Gegevens, Gegevenstype
`sendToConnection`	VerbindingsId, Gegevens, Gegevenstype
`addUserToGroup`	UserId, groep
`removeUserFromGroup`	UserId, groep
`removeUserFromAllGroups`	Gebruikers-id
`addConnectionToGroup`	ConnectionId, Groep
`removeConnectionFromGroup`	VerbindingsId, Groep
`closeAllConnections`	Uitgesloten, reden
`closeClientConnection`	ConnectionId, Reden
`closeGroupConnections`	Groep, uitgesloten, reden
`grantPermission`	VerbinderingsId, Machtiging, DoelNaam
`revokePermission`	VerbinderingsId, Machtiging, DoelNaam

Belangrijk

De berichtdata-eigenschap in de acties voor het verzenden van berichten moet string zijn als het gegevenstype is ingesteld op json of text om dubbelzinnigheid bij gegevensconversie te voorkomen. JSON.stringify() Gebruik dit om het json-object te converteren dat nodig is. Dit wordt toegepast op elke locatie met behulp van de berichteigenschap, bijvoorbeeld bij het werken met UserEventResponse.Data en WebPubSubTrigger.

Wanneer het gegevenstype is ingesteld op binary, is het toegestaan om natuurlijk ondersteunde bindingen te gebruiken zoals geconfigureerd is in de function.json, zie Trigger- en bindingsdefinities voor details.

Configuratie

WebPubSub

In de volgende tabel worden de bindingsconfiguratie-eigenschappen uitgelegd die u hebt ingesteld in het function.json-bestand en het WebPubSub kenmerk.

function.json-eigenschap	Attribuuteigenschap	Beschrijving
soort	n.v.t.	Moet worden ingesteld op `webPubSub`
richting	n.v.t.	Moet worden ingesteld op `out`
naam	n.v.t.	Variabelenaam die wordt gebruikt in functiecode voor uitvoerbindingsobject.
hub	Knooppunt	De waarde moet worden ingesteld op de naam van de Web PubSub-hub om de functie te activeren. We ondersteunen het instellen van de waarde in kenmerk als hogere prioriteit, of deze kan worden ingesteld in app-instellingen als een globale waarde.
verbinding	Verbinding	De naam van de app-instelling die de verbindingsreeks voor de Web PubSub-service bevat (standaard is ingesteld op 'WebPubSubConnectionString').

Probleemoplossing

Logboekregistratie van de console instellen

U kunt ook eenvoudig consolelogboekregistratie inschakelen als u dieper wilt ingaan op de aanvragen die u voor de service maakt.

Volgende stappen

Gebruik deze resources om te beginnen met het bouwen van uw eigen toepassing:

Zelfstudie: Berichten publiceren en erop abonneren in Azure Web PubSub

Zelfstudie: Een eenvoudige chatroom maken met Azure Web PubSub

Zelfstudie: Een door de service ondersteund subprotocol gebruiken voor clientstreaming

Zelfstudie: Serverloze chat bouwen met Azure Functions en Web PubSub

Zelfstudie: Een gebeurtenislistener configureren

Spelen met live demo's

Meer Voorbeelden van Azure Web PubSub verkennen

Feedback

Is deze pagina nuttig?

Last updated on 2026-02-26

Share via

Azure Web PubSub-triggers en -bindingen voor Azure Functions

Toevoegen aan uw functie-app

Belangrijke concepten

Triggerbinding

Voorbeeld

Kenmerken en aantekeningen

Configuratie

Gebruik

Antwoord retourneren

Invoerbinding

Voorbeeld- WebPubSubConnection

Geverifieerde tokens

Voorbeeld- WebPubSubContext

Configuratie

WebPubSubConnection

WebPubSubContext

Gebruik

WebPubSubConnection

WebPubSubContext

Uitvoerbinding

Voorbeeld

WebPubSubAction

Configuratie

WebPubSub

Probleemoplossing

Logboekregistratie van de console instellen

Volgende stappen

Feedback

Aanvullende resources

Voorbeeld- `WebPubSubConnection`

Voorbeeld- `WebPubSubContext`