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

CreateBatchOptions interface

包:: @azure/event-hubs

在 createBatch上配置 EventHubProducerClient 方法的选项。

partitionKey：用于生成分区分配的哈希值。
maxSizeInBytes：批大小的上限。
abortSignal：发出取消发送作的请求的信号。

示例用法：

{
    partitionKey: 'foo',
    maxSizeInBytes: 1024 * 1024 // 1 MB
}

扩展: OperationOptions

属性

maxSizeInBytes	批大小的上限。达到此限制后，`tryAdd` 函数将返回 `false`。
partitionId	此批处理将发送到的分区。如果设置了此值，则无法设置 partitionKey。
partitionKey	一个经过哈希处理以生成分区分配的值。它保证具有相同 partitionKey 的消息最终位于同一分区中。如果设置了此值，则无法设置 partitionId。

继承属性

abortSignal	可用于中止请求的信号。
tracingOptions	用于配置跟踪的选项。

属性详细信息

maxSizeInBytes

批大小的上限。达到此限制后，tryAdd 函数将返回 false。

maxSizeInBytes?: number

属性值

number

partitionId

此批处理将发送到的分区。如果设置了此值，则无法设置 partitionKey。

partitionId?: string

属性值

string

partitionKey

一个经过哈希处理以生成分区分配的值。它保证具有相同 partitionKey 的消息最终位于同一分区中。如果设置了此值，则无法设置 partitionId。

partitionKey?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 OperationOptions.abortSignal 的

tracingOptions

用于配置跟踪的选项。

tracingOptions?: OperationTracingOptions

属性值

OperationTracingOptions

继承自OperationOptions.tracingOptions

通过