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

ServiceBusMessageBatch interface

可以使用 方法创建的 <xref:createBatch> 一批消息。

属性

count

添加到批处理的消息数。

maxSizeInBytes

批的最大大小(以字节为单位)。 tryAddMessage如果正在添加的消息导致批的大小超过此限制,则批上的 函数将返回 falsecreateMessageBatch()使用 上的 Sender 方法来设置 maxSizeInBytes。

sizeInBytes

添加到批的事件已编码为单个 AMQP 消息后,批的大小(以字节为单位)。

方法

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

如果批的大小限制允许,则向批添加消息。 注意:在下次事件再次调用此方法之前,请始终记得检查此方法的返回值。

属性详细信息

count

添加到批处理的消息数。

count: number

属性值

number

maxSizeInBytes

批的最大大小(以字节为单位)。 tryAddMessage如果正在添加的消息导致批的大小超过此限制,则批上的 函数将返回 falsecreateMessageBatch()使用 上的 Sender 方法来设置 maxSizeInBytes。

maxSizeInBytes: number

属性值

number

sizeInBytes

添加到批的事件已编码为单个 AMQP 消息后,批的大小(以字节为单位)。

sizeInBytes: number

属性值

number

方法详细信息

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

如果批的大小限制允许,则向批添加消息。 注意:在下次事件再次调用此方法之前,请始终记得检查此方法的返回值。

function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

参数

message

ServiceBusMessage | AmqpAnnotatedMessage

要添加到批处理的消息。

options
TryAddOptions

返回

boolean

一个布尔值,指示消息是否已添加到批处理中。