通过

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

SubscribeOptions interface

  • 参考
包:
@azure/event-hubs

在 EventHubConsumerClient上配置 subscribe 方法的选项。 例如，{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

属性

maxBatchSize

每个批请求的事件数
maxWaitTimeInSeconds

在将数据传递给用户代码进行处理之前，等待生成请求的消息计数的最长时间。 如果未提供，则默认为 60 秒。
ownerLevel

要用作此订阅的所有者级别订阅分区。
prefetchCount

请求的事件计数，而不考虑是否请求了读取。
skipParsingBodyAsJson

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

分区中的事件位置，从未找到检查点时开始接收事件。 如果要为每个分区使用不同的起始位置，请将分区 ID 的映射传递给位置。
tracingOptions

用于配置跟踪的选项。
trackLastEnqueuedEventProperties

指示使用者是否应请求有关其关联分区上最后排队事件的信息，并跟踪接收事件时的信息。

跟踪有关分区最后排队事件的信息时，从事件中心服务接收的每个事件都将携带有关分区的元数据，否则不会。 这会导致少量额外的网络带宽消耗，在考虑定期使用事件中心客户端对分区属性发出请求时，这通常是一种有利的权衡。

属性详细信息

maxBatchSize

每个批请求的事件数

maxBatchSize?: number

属性值

number

maxWaitTimeInSeconds

在将数据传递给用户代码进行处理之前，等待生成请求的消息计数的最长时间。 如果未提供，则默认为 60 秒。

maxWaitTimeInSeconds?: number

属性值

number

ownerLevel

要用作此订阅的所有者级别订阅分区。

ownerLevel?: number

属性值

number

prefetchCount

请求的事件计数，而不考虑是否请求了读取。

prefetchCount?: number

属性值

number

skipParsingBodyAsJson

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

skipParsingBodyAsJson?: boolean

属性值

boolean

startPosition

分区中的事件位置，从未找到检查点时开始接收事件。 如果要为每个分区使用不同的起始位置，请将分区 ID 的映射传递给位置。

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

属性值

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

用于配置跟踪的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

trackLastEnqueuedEventProperties

指示使用者是否应请求有关其关联分区上最后排队事件的信息，并跟踪接收事件时的信息。

跟踪有关分区最后排队事件的信息时，从事件中心服务接收的每个事件都将携带有关分区的元数据，否则不会。 这会导致少量额外的网络带宽消耗，在考虑定期使用事件中心客户端对分区属性发出请求时，这通常是一种有利的权衡。

trackLastEnqueuedEventProperties?: boolean

属性值

boolean