CreateBatchOptions interface

參考

套件:: @azure/event-hubs

在 EventHubProducerClient上設定 createBatch 方法的選項。

partitionKey：哈希以產生分割區指派的值。
maxSizeInBytes：批次大小的上限。
abortSignal：發出要求以取消傳送作業的訊號。

範例用法：

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

Extends: 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

共用方式為