通过

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

ServiceBusMessage interface

  • 参考
包:
@azure/service-bus

描述要发送到服务总线的消息。

属性

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”地址。 此属性保留供将来在路由方案中使用，目前被中转站本身忽略。 应用程序可以在规则驱动的 自动转发链接 方案中使用此值来指示消息的预期逻辑目标。

属性详细信息

applicationProperties

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

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

属性值

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

body

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

body: any

属性值

any

contentType

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

contentType?: string

属性值

string

correlationId

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

correlationId?: string | number | Buffer

属性值

string | number | Buffer

messageId

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

注意：不允许使用非整数的数字。

messageId?: string | number | Buffer

属性值

string | number | Buffer

partitionKey

用于向分区实体发送消息的分区键。 最大长度为 128 个字符。 对于 分区实体，设置此值可向同一内部分区分配相关消息，以便正确记录提交顺序。 分区是由哈希函数选择的，不能直接选择此值。

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

属性值

string

replyTo

要向其发送答复的实体的地址。 此可选值和应用程序定义值是向消息接收方表达答复路径的标准方法。 当发送方需要答复时，它会将值设置为队列或主题的绝对或相对路径，而该队列或主题要求将答复发送到该队列或主题。 请参阅 消息路由和关联。

replyTo?: string

属性值

string

replyToSessionId

扩充 replyTo 地址的会话标识符。 最大长度为 128 个字符。 此值扩充 ReplyTo 信息，并指定在发送到回复实体时应为答复设置哪些 SessionId。 请参阅 消息路由和关联。

replyToSessionId?: string

属性值

string

scheduledEnqueueTimeUtc

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

scheduledEnqueueTimeUtc?: Date

属性值

Date

sessionId

会话感知实体的会话标识符。 最大长度为 128 个字符。 对于会话感知实体，此应用程序定义的值指定消息的会话关联。 具有相同会话标识符的消息将受到摘要锁定的约束，并启用确切的无序处理和解体。 对于会话不知道的实体，将忽略此值。 消息会话。

sessionId?: string

属性值

string

subject

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

subject?: string

属性值

string

timeToLive

消息生存时间值。 此值是消息过期的相对持续时间，从中转站接受并存储消息的即时开始，如 enqueuedTimeUtc中捕获的那样。 如果未显式设置，则假定的值是相应队列或主题的 DefaultTimeToLive。 消息级 timeToLive 值不能超过实体的 DefaultTimeToLive 设置，如果这样做，则以无提示方式调整该值。 请参阅 过期。

timeToLive?: number

属性值

number

to

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

to?: string

属性值

string