WebPubSubConnectionInputOptions interface
Properties
| client |
Optional - The client protocol type. Valid values are 'default' and 'mqtt'. For MQTT clients, you must set it to 'mqtt'. For other clients, you can omit the property or set it to 'default'. |
| connection | Optional - The name of the app setting that contains the Web PubSub Service connection string. Defaults to "WebPubSubConnectionString". |
| hub | Required - The name of the Web PubSub hub for the function to be triggered. Can be set in the attribute (higher priority) or in app settings as a global value. |
| name | Required - Variable name used in function code for input connection binding object. |
| user |
Optional - The value of the user identifier claim to be set in the access key token. |
Property Details
clientProtocol
Optional - The client protocol type. Valid values are 'default' and 'mqtt'. For MQTT clients, you must set it to 'mqtt'. For other clients, you can omit the property or set it to 'default'.
clientProtocol?: "mqtt" | "default"
Property Value
"mqtt" | "default"
connection
Optional - The name of the app setting that contains the Web PubSub Service connection string. Defaults to "WebPubSubConnectionString".
connection?: string
Property Value
string
hub
Required - The name of the Web PubSub hub for the function to be triggered. Can be set in the attribute (higher priority) or in app settings as a global value.
hub: string
Property Value
string
name
Required - Variable name used in function code for input connection binding object.
name: string
Property Value
string
userId
Optional - The value of the user identifier claim to be set in the access key token.
userId?: string
Property Value
string