你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。

WebPubSubFunctionOptions interface

扩展

属性

handler

当函数被触发时将执行的代码

trigger

对函数的主输入的配置,即将触发该函数的原因:这是在调用期间作为参数传递给函数处理程序的唯一输入

继承属性

clientProtocols

可选 - 指定哪个客户端协议可以触发 Web PubSub 触发函数默认为 'all'

connection

可选 - 包含 Web PubSub Service 连接字符串 的应用设置名称。 如果未指定,默认为“WebPubSubConnectionString”。

connections

可选 - 指定用于签名验证的上游 Azure Web PubSub 服务的应用设置或设置集合名称如果未指定,默认为“WebPubSubConnectionString”

eventName

必需 - 函数应响应的事件名称 对于系统事件类型:'connect'、'connected' 或 'disconnected' 对于用户定义的子协议:“message” 对于系统支持的子协议 json.webpubsub.azure.v1:用户定义的事件名称

eventType

必需 - 函数应响应的事件类型必须是“用户”或“系统”之一

extraInputs

在调用期间为可选辅助输入集配置,请使用 context.extraInputs.get() 获取这些值

extraOutputs

在调用期间为可选辅助输出集配置,请使用 context.extraOutputs.set() 设置这些值

hub

必需 - 该函数绑定的集线器名称

name

必需 - 函数代码中使用的接收事件数据参数的变量名

return

函数可选主输出的配置:这是在调用期间应设置为函数处理程序的返回值的主要输出

属性详细信息

handler

当函数被触发时将执行的代码

handler: WebPubSubHandler<T>

属性值

trigger

对函数的主输入的配置,即将触发该函数的原因:这是在调用期间作为参数传递给函数处理程序的唯一输入

trigger?: WebPubSubTrigger

属性值

继承属性详细信息

clientProtocols

可选 - 指定哪个客户端协议可以触发 Web PubSub 触发函数默认为 'all'

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

属性值

"all" | "webPubSub" | "mqtt"

继承自WebPubSubTriggerOptions.clientProtocols

connection

警告

现已弃用此 API。

Use connections instead.

可选 - 包含 Web PubSub Service 连接字符串 的应用设置名称。 如果未指定,默认为“WebPubSubConnectionString”。

connection?: string

属性值

string

继承自WebPubSubTriggerOptions.connection

connections

可选 - 指定用于签名验证的上游 Azure Web PubSub 服务的应用设置或设置集合名称如果未指定,默认为“WebPubSubConnectionString”

connections?: string[]

属性值

string[]

继承自WebPubSubTriggerOptions.connections

eventName

必需 - 函数应响应的事件名称 对于系统事件类型:'connect'、'connected' 或 'disconnected' 对于用户定义的子协议:“message” 对于系统支持的子协议 json.webpubsub.azure.v1:用户定义的事件名称

eventName: string

属性值

string

继承自WebPubSubTriggerOptions.eventName

eventType

必需 - 函数应响应的事件类型必须是“用户”或“系统”之一

eventType: "user" | "system"

属性值

"user" | "system"

继承自WebPubSubTriggerOptions.eventType

extraInputs

在调用期间为可选辅助输入集配置,请使用 context.extraInputs.get() 获取这些值

extraInputs?: FunctionInput[]

属性值

继承自 部分。额外输入

extraOutputs

在调用期间为可选辅助输出集配置,请使用 context.extraOutputs.set() 设置这些值

extraOutputs?: FunctionOutput[]

属性值

继承自 部分。额外输出

hub

必需 - 该函数绑定的集线器名称

hub: string

属性值

string

继承自WebPubSubTriggerOptions.hub

name

必需 - 函数代码中使用的接收事件数据参数的变量名

name: string

属性值

string

继承自WebPubSubTriggerOptions.name

return

函数可选主输出的配置:这是在调用期间应设置为函数处理程序的返回值的主要输出

return?: FunctionOutput

属性值

继承自 部分。返回