WebPubSubTriggerOptions interface

Properties

clientProtocols

Optional - Specifies which client protocol can trigger the Web PubSub trigger functions Default is 'all'

connection

Optional - The name of the app setting that contains the Web PubSub Service connection string. Defaults to "WebPubSubConnectionString" if not specified.

connections

Optional - The names of app settings or setting collections that specify the upstream Azure Web PubSub services Used for signature validation Defaults to "WebPubSubConnectionString" if not specified

eventName

Required - The name of the event to which the function should respond For system event type: 'connect', 'connected', or 'disconnected' For user-defined subprotocols: 'message' For system supported subprotocol json.webpubsub.azure.v1: user-defined event name

eventType

Required - The type of event to which the function should respond Must be either 'user' or 'system'

hub

Required - The name of the hub to which the function is bound

name

Required - The variable name used in function code for the parameter that receives the event data

Property Details

clientProtocols

Optional - Specifies which client protocol can trigger the Web PubSub trigger functions Default is 'all'

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

Property Value

"all" | "webPubSub" | "mqtt"

connection

Warning

This API is now deprecated.

Use connections instead.

Optional - The name of the app setting that contains the Web PubSub Service connection string. Defaults to "WebPubSubConnectionString" if not specified.

connection?: string

Property Value

string

connections

Optional - The names of app settings or setting collections that specify the upstream Azure Web PubSub services Used for signature validation Defaults to "WebPubSubConnectionString" if not specified

connections?: string[]

Property Value

string[]

eventName

Required - The name of the event to which the function should respond For system event type: 'connect', 'connected', or 'disconnected' For user-defined subprotocols: 'message' For system supported subprotocol json.webpubsub.azure.v1: user-defined event name

eventName: string

Property Value

string

eventType

Required - The type of event to which the function should respond Must be either 'user' or 'system'

eventType: "user" | "system"

Property Value

"user" | "system"

hub

Required - The name of the hub to which the function is bound

hub: string

Property Value

string

name

Required - The variable name used in function code for the parameter that receives the event data

name: string

Property Value

string