CreateMessageBatchOptions interface

Options to configure the createBatch method on the Sender.

  • maxSizeInBytes: The upper limit for the size of batch.

Example usage:

{
    maxSizeInBytes: 1024 * 1024 // 1 MB
}
Extends

Properties

maxSizeInBytes

The upper limit for the size of batch. The tryAdd function will return false after this limit is reached.

Inherited Properties

abortSignal

The signal which can be used to abort requests.

tracingOptions

Options used when tracing is enabled.

Property Details

maxSizeInBytes

The upper limit for the size of batch. The tryAdd function will return false after this limit is reached.

maxSizeInBytes?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

Inherited From OperationOptionsBase.abortSignal

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From OperationOptionsBase.tracingOptions