通过

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

ServiceBusMessage 类

  • 参考

服务总线消息。

继承
builtins.object
ServiceBusMessage

构造函数

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

参数

body
Optional[Union[str, bytes]]
必需

要以单个消息发送的数据。

application_properties
Dict[str, Union[int 或 float 或 bool 或 bytes 或 str 或 UUID 或 datetime 或 None]]

消息上的用户定义的属性。

session_id
Optional[str]

会话实体的消息的会话标识符。

message_id
Optional[str]

用于标识消息的 ID。

scheduled_enqueue_time_utc
Optional[datetime]

消息的 utc 计划排队时间。

time_to_live
Optional[timedelta]

消息的生存期。

content_type
Optional[str]

内容类型描述符。

correlation_id
Optional[str]

相关标识符。

subject
Optional[str]

应用程序特定的主题，有时称为标签。

partition_key
Optional[str]

用于将消息发送到分区实体的分区键。

to
Optional[str]

用于auto_forward链接方案的 要地址。

reply_to
Optional[str]

要向其发送答复的实体的地址。

reply_to_session_id
Optional[str]

用于扩充 reply_to 地址的会话标识符。

示例

发送具有其他属性的消息


   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

属性

application_properties

消息上的用户定义的属性。

返回类型

dict[str,
bytes, <xref:PrimitiveTypes>],
None

body

消息的正文。 格式可能因正文类型而异：对于 DATA，正文可以是字节或 Iterable[bytes]。 对于 SEQUENCE，正文可以是 List 或 Iterable[List]。 对于 VALUE，正文可以是任意类型。

返回类型

Any

body_type

基础 AMQP 消息的正文类型。

返回类型

AmqpMessageBodyType

content_type

内容类型描述符。

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

返回类型

str,
None

correlation_id

相关标识符。

允许应用程序出于关联目的指定消息的上下文。例如，反映正在答复的消息的 MessageId。

请参阅 中的 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation消息路由和关联。

返回类型

str,
None

message

获取基础 uamqp。Message 或 LegacyMessage。 它已弃用，将在更高版本中删除。

返回类型

<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

用于标识消息的 ID。

消息标识符是应用程序定义的值，可用于唯一标识消息及其有效负载。 此标识符是自由格式字符串，可反映 GUID 或派生自应用程序上下文的标识符。 如果启用，重复检测 (看到 https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) 功能标识并删除具有相同消息 ID 的第二个和进一步提交的邮件。

返回类型

str,
None

partition_key

用于将消息发送到分区实体的分区键。

设置此值可向同一内部分区分配相关消息，以便正确记录提交顺序。 分区是由哈希函数通过此值进行选择，无法直接选择。

请参阅 中的 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning分区队列和主题。

返回类型

str,
None

raw_amqp_message

仅限高级用法。 发送或接收的内部 AMQP 消息有效负载。 ：rtype： ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

要向其发送答复的实体的地址。

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

请参阅 中的 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation消息路由和关联。

返回类型

str,
None

reply_to_session_id

用于扩充 reply_to 地址的会话标识符。

此值扩充 reply_to 信息，并指定在发送到回复实体时应为答复设置哪个会话 ID。

请参阅 中的 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation消息路由和关联。

返回类型

str,
None

scheduled_enqueue_time_utc

消息的 utc 计划排队时间。

此属性可用于通过 ServiceBusSender.send 方法发送消息时进行计划。 如果需要取消计划消息，则应使用 ServiceBusSender.schedule 方法，该方法返回可用于将来取消的序列号。 如果未设置，scheduled_enqueue_time_utc 为 None。

返回类型

datetime

session_id

会话实体的消息的会话标识符。

对于会话实体，此应用程序定义的值指定消息的会话隶属关系。 会话标识符相同的消息会处于摘要锁定状态，并确切启用依序处理和解多路复用。 对于非会话实体，此值将被忽略。

请参阅 中的 https://docs.microsoft.com/azure/service-bus-messaging/message-sessions消息会话。

返回类型

str,
None

subject

应用程序特定的主题，有时称为标签。

借助此属性，应用程序可以类似于电子邮件主题行的标准化方式，向接收程序指明消息目的。

返回类型

str

time_to_live

消息的生存期。

此值是消息过期的相对持续时间，从中转站接受并存储消息的瞬间开始， 如 enqueued_time_utc 中捕获的那样。 如果未明确设置，假设值为适用于相应队列或主题的 DefaultTimeToLive。 消息级别的生存时间值不能超过实体的生存时间设置，如果存在，则会以无提示方式对其进行调整。

请参阅 中的过期时间 https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

返回类型

timedelta

to

要地址的 。

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

有关详细信息，请参阅 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding 。

返回类型

str,
None