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

ServiceBusSessionReceiverOptions interface

参考

包:: @azure/service-bus

描述在使用启用了会话的队列/订阅时传递给 acceptSession 和 acceptNextSession 方法的选项。

扩展: OperationOptionsBase

属性

identifier	设置用于标识会话接收器的名称。这可用于关联日志和异常。如果未指定或为空，将使用随机唯一的。
maxAutoLockRenewalDurationInMs	客户端将自动续订会话上的锁的最大持续时间（以毫秒为单位）。默认值： `300000`) 5 分钟 (毫秒。若要禁用自动锁定续订，请将此设置为 `0`。示例：如果锁在 2 分钟内过期，并且处理时间为 8 分钟... 将 maxAutoLockRenewalDurationInMs 设置为 10 分钟，锁将自动续订大约 4 次， (相当于通过利用锁续订) 将会话锁定 4 倍。
receiveMode	表示接收方的接收模式。在 receiveAndDelete 模式下，消息在接收时会从服务总线中删除。在 peekLock 模式下，接收方在队列/订阅中指定的持续时间内对消息进行锁定。未在锁定持续时间内解决的消息将重新传送到队列/订阅上设置的最大传递计数的次数，然后发送到单独的死信队列。可以通过对消息调用 complete () 、abandon () 、defer () 或 deadletter () 方法来解决消息。有关 peekLock 和消息解决工作原理的详细信息，请参阅： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	接收消息时，是否跳过将消息注释属性或应用程序属性上的日期类型转换为数字。默认情况下，日期类型的属性将转换为 UNIX 纪元编号，以保持兼容性。
skipParsingBodyAsJson	用于在接收消息时禁止客户端在消息正文上运行 JSON.parse () 的选项。如果消息是使用 AMQP 正文类型值或序列发送的，则不适用。如果希望直接处理消息正文中存在的字节，而不是让客户端尝试分析该字节，请使用此选项。

继承属性

abortSignal	可用于中止请求的信号。
tracingOptions	启用跟踪时使用的选项。

属性详细信息

identifier

设置用于标识会话接收器的名称。这可用于关联日志和异常。如果未指定或为空，将使用随机唯一的。

identifier?: string

属性值

string

maxAutoLockRenewalDurationInMs

客户端将自动续订会话上的锁的最大持续时间（以毫秒为单位）。

默认值： 300000) 5 分钟 (毫秒。
若要禁用自动锁定续订，请将此设置为 0。

示例：

如果锁在 2 分钟内过期，并且处理时间为 8 分钟...

将 maxAutoLockRenewalDurationInMs 设置为 10 分钟，锁将自动续订大约 4 次， (相当于通过利用锁续订) 将会话锁定 4 倍。

maxAutoLockRenewalDurationInMs?: number

属性值

number

receiveMode

表示接收方的接收模式。

在 receiveAndDelete 模式下，消息在接收时会从服务总线中删除。

在 peekLock 模式下，接收方在队列/订阅中指定的持续时间内对消息进行锁定。

未在锁定持续时间内解决的消息将重新传送到队列/订阅上设置的最大传递计数的次数，然后发送到单独的死信队列。

可以通过对消息调用 complete () 、abandon () 、defer () 或 deadletter () 方法来解决消息。

有关 peekLock 和消息解决工作原理的详细信息，请参阅： https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

属性值

"peekLock" | "receiveAndDelete"

skipConvertingDate

接收消息时，是否跳过将消息注释属性或应用程序属性上的日期类型转换为数字。默认情况下，日期类型的属性将转换为 UNIX 纪元编号，以保持兼容性。

skipConvertingDate?: boolean

属性值

boolean

skipParsingBodyAsJson

用于在接收消息时禁止客户端在消息正文上运行 JSON.parse () 的选项。如果消息是使用 AMQP 正文类型值或序列发送的，则不适用。如果希望直接处理消息正文中存在的字节，而不是让客户端尝试分析该字节，请使用此选项。

skipParsingBodyAsJson?: boolean

属性值

boolean

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 OperationOptionsBase.abortSignal

tracingOptions

启用跟踪时使用的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自 OperationOptionsBase.tracingOptions

通过