WebPubSubFunctionOptions interface

Extends

Proprietà

handler

Il codice che verrà eseguito quando la tua funzione verrà attivata

trigger

Configurazione per l'input primario per la funzione, ovvero il motivo per cui verrà attivato Questo è l'unico input passato come argomento al gestore di funzioni durante la chiamata

Proprietà ereditate

clientProtocols

Opzionale - Specifica quale protocollo client può attivare le funzioni di attivazione Web PubSub Il valore predefinito è 'all'.

connection

Opzionale - Il nome dell'impostazione dell'app che contiene la stringa di connessione del servizio Web PubSub. Imposta per impostazione predefinita su "WebPubSubConnectionString" se non specificato.

connections

Opzionale - I nomi delle impostazioni dell'app o delle raccolte di impostazioni che specificano i servizi Azure Web PubSub a monte usati per la validazione delle firme Imposta per impostazione predefinita "WebPubSubConnectionString" se non specificata

eventName

Obbligatorio - Il nome dell'evento a cui la funzione deve rispondere Per il tipo di evento di sistema: 'connect', 'connected' o 'disconnected' Per i sottoprotocolli definiti dall'utente: 'message' Per il sottoprotocollo supportato dal sistema json.webpubsub.azure.v1: nome dell'evento definito dall'utente

eventType

Richiesto - Il tipo di evento a cui la funzione deve rispondere deve essere 'user' o 'system'

extraInputs

Configurazione per un set facoltativo di input secondari durante la chiamata, ottenere questi valori con context.extraInputs.get()

extraOutputs

Configurazione per un set facoltativo di output secondari durante la chiamata, impostare questi valori con context.extraOutputs.set()

hub

Obbligatorio - Il nome dell'hub a cui è vincolata la funzione

name

Obbligatorio - Il nome della variabile utilizzato nel codice di funzione per il parametro che riceve i dati dell'evento

return

Configurazione per l'output primario facoltativo della funzione Questo è l'output principale che è necessario impostare come valore restituito del gestore di funzioni durante la chiamata

Dettagli proprietà

handler

Il codice che verrà eseguito quando la tua funzione verrà attivata

handler: WebPubSubHandler<T>

Valore della proprietà

trigger

Configurazione per l'input primario per la funzione, ovvero il motivo per cui verrà attivato Questo è l'unico input passato come argomento al gestore di funzioni durante la chiamata

trigger?: WebPubSubTrigger

Valore della proprietà

Dettagli proprietà ereditate

clientProtocols

Opzionale - Specifica quale protocollo client può attivare le funzioni di attivazione Web PubSub Il valore predefinito è 'all'.

clientProtocols?: "all" | "webPubSub" | "mqtt"

Valore della proprietà

"all" | "webPubSub" | "mqtt"

Ereditato daWebPubSubTriggerOptions.clientProtocols

connection

Avviso

Questa API è ora deprecata.

Use connections instead.

Opzionale - Il nome dell'impostazione dell'app che contiene la stringa di connessione del servizio Web PubSub. Imposta per impostazione predefinita su "WebPubSubConnectionString" se non specificato.

connection?: string

Valore della proprietà

string

Ereditato daWebPubSubTriggerOptions.connection

connections

Opzionale - I nomi delle impostazioni dell'app o delle raccolte di impostazioni che specificano i servizi Azure Web PubSub a monte usati per la validazione delle firme Imposta per impostazione predefinita "WebPubSubConnectionString" se non specificata

connections?: string[]

Valore della proprietà

string[]

Ereditato daWebPubSubTriggerOptions.connections

eventName

Obbligatorio - Il nome dell'evento a cui la funzione deve rispondere Per il tipo di evento di sistema: 'connect', 'connected' o 'disconnected' Per i sottoprotocolli definiti dall'utente: 'message' Per il sottoprotocollo supportato dal sistema json.webpubsub.azure.v1: nome dell'evento definito dall'utente

eventName: string

Valore della proprietà

string

Ereditato daWebPubSubTriggerOptions.eventName

eventType

Richiesto - Il tipo di evento a cui la funzione deve rispondere deve essere 'user' o 'system'

eventType: "user" | "system"

Valore della proprietà

"user" | "system"

Ereditato daWebPubSubTriggerOptions.eventType

extraInputs

Configurazione per un set facoltativo di input secondari durante la chiamata, ottenere questi valori con context.extraInputs.get()

extraInputs?: FunctionInput[]

Valore della proprietà

Ereditato da Partial.extraInputs

extraOutputs

Configurazione per un set facoltativo di output secondari durante la chiamata, impostare questi valori con context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Valore della proprietà

Ereditato da Partial.extraOutputs

hub

Obbligatorio - Il nome dell'hub a cui è vincolata la funzione

hub: string

Valore della proprietà

string

Ereditato daWebPubSubTriggerOptions.hub

name

Obbligatorio - Il nome della variabile utilizzato nel codice di funzione per il parametro che riceve i dati dell'evento

name: string

Valore della proprietà

string

Ereditato daWebPubSubTriggerOptions.name

return

Configurazione per l'output primario facoltativo della funzione Questo è l'output principale che è necessario impostare come valore restituito del gestore di funzioni durante la chiamata

return?: FunctionOutput

Valore della proprietà

Ereditato da Ritorno parziale