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

ServiceBusQueueFunctionOptions interface

扩展

属性

handler

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

trigger

函数的主要输入配置,也就是触发原因。这是调用过程中唯一作为参数传递给函数处理器的输入

继承属性

autoCompleteMessages

获取或设置一个值,指示触发器在成功处理后是否应自动完成消息。 如果未明确设置,行为将基于 host.json中的 autoCompleteMessages 配置。 更多信息,请 <参见 cref=“https://aka.ms/AAp8dm9"/>”

cardinality

设置为 many 以启用批处理。 如果省略或设置为 one,则会向函数传递单个消息。

connection

具有服务总线连接字符串的应用设置(或环境变量)

extraInputs

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

extraOutputs

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

isSessionsEnabled

true 如果连接到 会话相关 队列。 默认值为 false

queueName

要监视的队列的名称

return

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

sdkBinding

是否为此 服务总线 触发器使用 SDK 绑定。

属性详细信息

handler

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

handler: ServiceBusQueueHandler<T>

属性值

trigger

函数的主要输入配置,也就是触发原因。这是调用过程中唯一作为参数传递给函数处理器的输入

trigger?: ServiceBusQueueTrigger

属性值

继承属性详细信息

autoCompleteMessages

获取或设置一个值,指示触发器在成功处理后是否应自动完成消息。 如果未明确设置,行为将基于 host.json中的 autoCompleteMessages 配置。 更多信息,请 <参见 cref=“https://aka.ms/AAp8dm9"/>”

autoCompleteMessages?: boolean

属性值

boolean

继承自ServiceBusQueueTriggerOptions.autoCompleteMessages

cardinality

设置为 many 以启用批处理。 如果省略或设置为 one,则会向函数传递单个消息。

cardinality?: "many" | "one"

属性值

"many" | "one"

继承自ServiceBusQueueTriggerOptions.cardinality

connection

具有服务总线连接字符串的应用设置(或环境变量)

connection: string

属性值

string

继承自ServiceBusQueueTriggerOptions.connection

extraInputs

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

extraInputs?: FunctionInput[]

属性值

继承自 部分。额外输入

extraOutputs

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

extraOutputs?: FunctionOutput[]

属性值

继承自 部分。额外输出

isSessionsEnabled

true 如果连接到 会话相关 队列。 默认值为 false

isSessionsEnabled?: boolean

属性值

boolean

继承自ServiceBusQueueTriggerOptions.isSessionsEnabled

queueName

要监视的队列的名称

queueName: string

属性值

string

继承自ServiceBusQueueTriggerOptions.queueName

return

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

return?: FunctionOutput

属性值

继承自 部分。返回

sdkBinding

是否为此 服务总线 触发器使用 SDK 绑定。

sdkBinding?: boolean

属性值

boolean

继承自ServiceBusQueueTriggerOptions.sdkBinding