WebPubSubFunctionOptions interface
- Extends
-
WebPubSubTriggerOptions,Partial<FunctionOptions>
Propiedades
| handler | El código que se ejecutará cuando se active tu función |
| trigger | Configuración de la entrada principal a la función, también conocido como el motivo por el que se desencadenará Esta es la única entrada que se pasa como argumento al controlador de funciones durante la invocación. |
Propiedades heredadas
| client |
Opcional - Especifica qué protocolo cliente puede activar las funciones de disparo del Web PubSub El valor predeterminado es 'all' |
| connection | Opcional: el nombre de la configuración de la aplicación que contiene la cadena de conexión del servicio Web PubSub. Por defecto, se configura como "WebPubSubConnectionString" si no se especifica. |
| connections | Opcional: los nombres de la configuración de la aplicación o colecciones de configuraciones que especifican los servicios ascendentes de Azure Web PubSub Utilizados para la validación de firmas Predeterminadamente es "WebPubSubConnectionString" si no se especifica |
| event |
Obligatorio - El nombre del evento al que debe responder la función Para el tipo de evento del sistema: 'connect', 'connected' o 'disconnected' Para subprotocolos definidos por el usuario: 'message' Para el subprotocolo compatible con el sistema json.webpubsub.azure.v1: nombre de evento definido por el usuario |
| event |
Requerido - El tipo de evento al que debe responder la función debe ser 'usuario' o 'sistema' |
| extra |
Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con |
| extra |
Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con |
| hub | Obligatorio: el nombre del hub al que está vinculada la función |
| name | Required - El nombre de la variable usado en el código de función para el parámetro que recibe los datos del evento |
| return | Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación. |
Detalles de las propiedades
handler
El código que se ejecutará cuando se active tu función
handler: WebPubSubHandler<T>
Valor de propiedad
trigger
Configuración de la entrada principal a la función, también conocido como el motivo por el que se desencadenará Esta es la única entrada que se pasa como argumento al controlador de funciones durante la invocación.
trigger?: WebPubSubTrigger
Valor de propiedad
Detalles de las propiedades heredadas
clientProtocols
Opcional - Especifica qué protocolo cliente puede activar las funciones de disparo del Web PubSub El valor predeterminado es 'all'
clientProtocols?: "all" | "webPubSub" | "mqtt"
Valor de propiedad
"all" | "webPubSub" | "mqtt"
Heredado deWebPubSubTriggerOptions.clientProtocols
connection
Advertencia
Esta API ya está en desuso.
Use connections instead.
Opcional: el nombre de la configuración de la aplicación que contiene la cadena de conexión del servicio Web PubSub. Por defecto, se configura como "WebPubSubConnectionString" si no se especifica.
connection?: string
Valor de propiedad
string
Heredado deWebPubSubTriggerOptions.connection
connections
Opcional: los nombres de la configuración de la aplicación o colecciones de configuraciones que especifican los servicios ascendentes de Azure Web PubSub Utilizados para la validación de firmas Predeterminadamente es "WebPubSubConnectionString" si no se especifica
connections?: string[]
Valor de propiedad
string[]
Heredado deWebPubSubTriggerOptions.connections
eventName
Obligatorio - El nombre del evento al que debe responder la función Para el tipo de evento del sistema: 'connect', 'connected' o 'disconnected' Para subprotocolos definidos por el usuario: 'message' Para el subprotocolo compatible con el sistema json.webpubsub.azure.v1: nombre de evento definido por el usuario
eventName: string
Valor de propiedad
string
Heredado deWebPubSubTriggerOptions.eventName
eventType
Requerido - El tipo de evento al que debe responder la función debe ser 'usuario' o 'sistema'
eventType: "user" | "system"
Valor de propiedad
"user" | "system"
Heredado deWebPubSubTriggerOptions.eventType
extraInputs
Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con context.extraInputs.get()
extraInputs?: FunctionInput[]
Valor de propiedad
Heredado de Partial.extraInputs
extraOutputs
Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con context.extraOutputs.set()
extraOutputs?: FunctionOutput[]
Valor de propiedad
Heredado de Partial.extraOutputs
hub
Obligatorio: el nombre del hub al que está vinculada la función
hub: string
Valor de propiedad
string
Heredado deWebPubSubTriggerOptions.hub
name
Required - El nombre de la variable usado en el código de función para el parámetro que recibe los datos del evento
name: string
Valor de propiedad
string
Heredado deWebPubSubTriggerOptions.name
return
Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación.
return?: FunctionOutput
Valor de propiedad
Heredado de Partial.return