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

ServiceBusReceivedMessage interface

描述在速览操作期间从服务总线接收的消息,因此无法解决。

扩展

属性

deadLetterErrorDescription

对消息进行死信的错误说明。

deadLetterReason

消息死信的原因。

deadLetterSource

此消息在死信之前排队的队列或订阅的名称。 仅在死信消息中设置,然后自动从死信子队列转发到另一个实体的消息。 指明已成为死信的消息所在的实体。

deliveryCount

已尝试传递此消息的次数。 当消息锁过期,或者对消息使用 abandon() 方法显式放弃消息时,计数将递增。

enqueuedSequenceNumber

消息的原始序列号。 对于已自动转发的消息,此属性反映的是在原始提交点首次分配给消息的序列号。

enqueuedTimeUtc

接受消息并将其存储在服务总线中的 UTC 时刻。

expiresAtUtc

由于已过期而标记消息以供删除且无法再从实体中检索消息的即时 UTC。 此属性是从消息上的 2 个其他属性计算的: enqueuedTimeUtc + timeToLive

lockedUntilUtc

在队列/订阅中锁定消息前的 UTC 时刻。 当锁过期时, deliveryCount 将递增,并且消息再次可供检索。

  • 在接收模式下接收 receiveAndDelete 消息时不适用。 。
lockToken

锁令牌是对中转站在 peekLock 接收模式下持有的锁的引用。 锁在内部使用,如产品文档中更详细地说明的那样

  • 在接收模式下接收 receiveAndDelete 消息时不适用。 。
sequenceNumber

服务总线分配给消息的唯一编号。 序列号是在中转站接受并存储消息时分配给消息的唯一 64 位整数,可用作真正的标识符。 对于已分区实体,最前面的 16 位数反映的是分区标识符。 序列号单调增加。 在 48-64 位范围用尽后,序列号会回滚到 0。

Javascript 当前支持的最大安全整数2^53 - 1。 序列号是 AMQP Long 类型,长度可达 64 位。 为了表示我们使用的是名为 long.js库。 我们希望客户使用此 Long 库导出的类型。

state

消息的状态可以是活动、延迟或计划。 延迟消息具有延迟状态,计划消息具有计划状态,所有其他消息具有活动状态。

继承属性

applicationProperties

可用于自定义消息元数据的应用程序特定属性。

body

需要发送或接收的消息正文。 如果接收消息的应用程序未使用此 SDK,请将正文有效负载转换为字节数组或缓冲区,以提高跨语言兼容性。

contentType

消息的内容类型。 (可选)描述消息的有效负载,其描述符遵循 RFC2045 第 5 节的格式,例如“application/json”。

correlationId

相关标识符,它允许应用程序为消息指定上下文以实现关联,例如反映正在答复的消息的 MessageId。 请参阅 消息路由和关联

messageId

消息标识符是应用程序定义的值,可用于唯一标识消息及其有效负载。

注意:不允许使用不是整数的数字。

partitionKey

用于将消息发送到分区实体的分区键。 最大长度为 128 个字符。 对于已分区实体,设置此值后,可以将相关消息分配到同一内部分区,以便能够正确记录提交序列顺序。 分区是由哈希函数通过此值进行选择,无法直接选择。

  • 对于会话感知实体, sessionId 属性将替代此值。
  • 对于未分区的实体,将忽略分区键
replyTo

要向其发送答复的实体的地址。 应用程序定义的这一可选值是一种标准方法,可用于向消息接收程序明示答复路径。 如果发送程序希望收到答复,它会将此值设置为,要将答复发送到的队列或主题的绝对或相关路径。 请参阅 消息路由和关联

replyToSessionId

用于扩充地址的 replyTo 会话标识符。 最大长度为 128 个字符。 此值补充了 ReplyTo 信息,并指定了应为发送给答复实体的答复设置的 SessionId。 请参阅 消息路由和关联

scheduledEnqueueTimeUtc

消息排队的 UTC 日期和时间。 此属性返回 UTC 时间;设置 属性时,提供的 DateTime 值也必须采用 UTC 格式。 此值用于延迟消息发送。 它用于将消息发送延迟到将来的特定时间。 消息排队时间并不意味着将同时发送消息。 它将排队,但实际发送时间取决于队列的工作负荷及其状态。

sessionId

会话感知实体的会话标识符。 最大长度为 128 个字符。 对于会话感知实体,应用程序定义的此值指定了消息的会话附属关系。 会话标识符相同的消息会处于摘要锁定状态,并确切启用依序处理和解多路复用。 对于非会话感知实体,可忽略此值。 消息会话

subject

应用程序特定标签。 此属性使应用程序能够在标准化中向接收方指示消息的用途。 fashion,类似于电子邮件主题行。 映射的 AMQP 属性为“subject”。

timeToLive

消息的生存时间值。 此值是消息过期的相对持续时间,从中转站接受并存储消息的即时开始,如 中 enqueuedTimeUtc捕获的那样。 如果未明确设置,假设值为适用于相应队列或主题的 DefaultTimeToLive。 消息级 timeToLive 值不能长于实体的 DefaultTimeToLive 设置,如果是,则会以静默方式调整该值。 请参阅 过期

to

“to”地址。 此属性已保留,以供将来用于路由方案,暂被中转站本身忽略。 应用程序可以在规则驱动的 自动转发链接 方案中使用此值来指示消息的预期逻辑目标。

属性详细信息

deadLetterErrorDescription

对消息进行死信的错误说明。

deadLetterErrorDescription?: string

属性值

string

deadLetterReason

消息死信的原因。

deadLetterReason?: string

属性值

string

deadLetterSource

此消息在死信之前排队的队列或订阅的名称。 仅在死信消息中设置,然后自动从死信子队列转发到另一个实体的消息。 指明已成为死信的消息所在的实体。

deadLetterSource?: string

属性值

string

deliveryCount

已尝试传递此消息的次数。 当消息锁过期,或者对消息使用 abandon() 方法显式放弃消息时,计数将递增。

deliveryCount?: number

属性值

number

enqueuedSequenceNumber

消息的原始序列号。 对于已自动转发的消息,此属性反映的是在原始提交点首次分配给消息的序列号。

enqueuedSequenceNumber?: number

属性值

number

enqueuedTimeUtc

接受消息并将其存储在服务总线中的 UTC 时刻。

enqueuedTimeUtc?: Date

属性值

Date

expiresAtUtc

由于已过期而标记消息以供删除且无法再从实体中检索消息的即时 UTC。 此属性是从消息上的 2 个其他属性计算的: enqueuedTimeUtc + timeToLive

expiresAtUtc?: Date

属性值

Date

lockedUntilUtc

在队列/订阅中锁定消息前的 UTC 时刻。 当锁过期时, deliveryCount 将递增,并且消息再次可供检索。

  • 在接收模式下接收 receiveAndDelete 消息时不适用。 。
lockedUntilUtc?: Date

属性值

Date

lockToken

锁令牌是对中转站在 peekLock 接收模式下持有的锁的引用。 锁在内部使用,如产品文档中更详细地说明的那样

  • 在接收模式下接收 receiveAndDelete 消息时不适用。 。
lockToken?: string

属性值

string

sequenceNumber

服务总线分配给消息的唯一编号。 序列号是在中转站接受并存储消息时分配给消息的唯一 64 位整数,可用作真正的标识符。 对于已分区实体,最前面的 16 位数反映的是分区标识符。 序列号单调增加。 在 48-64 位范围用尽后,序列号会回滚到 0。

Javascript 当前支持的最大安全整数2^53 - 1。 序列号是 AMQP Long 类型,长度可达 64 位。 为了表示我们使用的是名为 long.js库。 我们希望客户使用此 Long 库导出的类型。

sequenceNumber?: Long

属性值

Long

state

消息的状态可以是活动、延迟或计划。 延迟消息具有延迟状态,计划消息具有计划状态,所有其他消息具有活动状态。

state: "active" | "deferred" | "scheduled"

属性值

"active" | "deferred" | "scheduled"

继承属性详细信息

applicationProperties

可用于自定义消息元数据的应用程序特定属性。

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

属性值

{[key: string]: number | boolean | string | Date | null}

继承自ServiceBusMessage.applicationProperties

body

需要发送或接收的消息正文。 如果接收消息的应用程序未使用此 SDK,请将正文有效负载转换为字节数组或缓冲区,以提高跨语言兼容性。

body: any

属性值

any

继承自ServiceBusMessage.body

contentType

消息的内容类型。 (可选)描述消息的有效负载,其描述符遵循 RFC2045 第 5 节的格式,例如“application/json”。

contentType?: string

属性值

string

继承自ServiceBusMessage.contentType

correlationId

相关标识符,它允许应用程序为消息指定上下文以实现关联,例如反映正在答复的消息的 MessageId。 请参阅 消息路由和关联

correlationId?: string | number | Buffer

属性值

string | number | Buffer

继承自ServiceBusMessage.correlationId

messageId

消息标识符是应用程序定义的值,可用于唯一标识消息及其有效负载。

注意:不允许使用不是整数的数字。

messageId?: string | number | Buffer

属性值

string | number | Buffer

继承自ServiceBusMessage.messageId

partitionKey

用于将消息发送到分区实体的分区键。 最大长度为 128 个字符。 对于已分区实体,设置此值后,可以将相关消息分配到同一内部分区,以便能够正确记录提交序列顺序。 分区是由哈希函数通过此值进行选择,无法直接选择。

  • 对于会话感知实体, sessionId 属性将替代此值。
  • 对于未分区的实体,将忽略分区键
partitionKey?: string

属性值

string

继承自ServiceBusMessage.partitionKey

replyTo

要向其发送答复的实体的地址。 应用程序定义的这一可选值是一种标准方法,可用于向消息接收程序明示答复路径。 如果发送程序希望收到答复,它会将此值设置为,要将答复发送到的队列或主题的绝对或相关路径。 请参阅 消息路由和关联

replyTo?: string

属性值

string

继承自ServiceBusMessage.replyTo

replyToSessionId

用于扩充地址的 replyTo 会话标识符。 最大长度为 128 个字符。 此值补充了 ReplyTo 信息,并指定了应为发送给答复实体的答复设置的 SessionId。 请参阅 消息路由和关联

replyToSessionId?: string

属性值

string

继承自ServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

消息排队的 UTC 日期和时间。 此属性返回 UTC 时间;设置 属性时,提供的 DateTime 值也必须采用 UTC 格式。 此值用于延迟消息发送。 它用于将消息发送延迟到将来的特定时间。 消息排队时间并不意味着将同时发送消息。 它将排队,但实际发送时间取决于队列的工作负荷及其状态。

scheduledEnqueueTimeUtc?: Date

属性值

Date

继承自ServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

会话感知实体的会话标识符。 最大长度为 128 个字符。 对于会话感知实体,应用程序定义的此值指定了消息的会话附属关系。 会话标识符相同的消息会处于摘要锁定状态,并确切启用依序处理和解多路复用。 对于非会话感知实体,可忽略此值。 消息会话

sessionId?: string

属性值

string

继承自ServiceBusMessage.sessionId

subject

应用程序特定标签。 此属性使应用程序能够在标准化中向接收方指示消息的用途。 fashion,类似于电子邮件主题行。 映射的 AMQP 属性为“subject”。

subject?: string

属性值

string

继承自ServiceBusMessage.subject

timeToLive

消息的生存时间值。 此值是消息过期的相对持续时间,从中转站接受并存储消息的即时开始,如 中 enqueuedTimeUtc捕获的那样。 如果未明确设置,假设值为适用于相应队列或主题的 DefaultTimeToLive。 消息级 timeToLive 值不能长于实体的 DefaultTimeToLive 设置,如果是,则会以静默方式调整该值。 请参阅 过期

timeToLive?: number

属性值

number

继承自ServiceBusMessage.timeToLive

to

“to”地址。 此属性已保留,以供将来用于路由方案,暂被中转站本身忽略。 应用程序可以在规则驱动的 自动转发链接 方案中使用此值来指示消息的预期逻辑目标。

to?: string

属性值

string

继承自ServiceBusMessage.to