ServiceBusMessage Class

An HTTP response object.

Inheritance

azure.functions._servicebus.ServiceBusMessage

ServiceBusMessage

Constructor

ServiceBusMessage(*, body: bytes, trigger_metadata: Optional[Mapping[str, Any]] = None, content_type: Optional[str] = None, correlation_id: Optional[str] = None, delivery_count: Optional[int] = 0, enqueued_time_utc: Optional[datetime.datetime] = None, expiration_time: Optional[datetime.datetime] = None, expires_at_utc: Optional[datetime.datetime] = None, label: Optional[str] = None, message_id: str, partition_key: Optional[str] = None, reply_to: Optional[str] = None, reply_to_session_id: Optional[str] = None, scheduled_enqueue_time: Optional[datetime.datetime] = None, session_id: Optional[str] = None, time_to_live: Optional[datetime.timedelta] = None, to: Optional[str] = None, user_properties: Dict[str, object])

Methods

get_body

Return message body as bytes.

get_body

Return message body as bytes.

get_body() -> bytes

Attributes

content_type

Message content type.

correlation_id

Message correlation identifier.

delivery_count

Number of times delivery has been attempted.

enqueued_time_utc

The date and time in UTC at which the message is enqueued

expiration_time

The date and time in UTC at which the message is set to expire.

expires_at_utc

The date and time in UTC at which the message is set to expire.

label

Application specific label.

message_id

Identifier used to identify the message.

metadata

Getting read-only trigger metadata in a Python dictionary.

Exposing the raw trigger_metadata to our customer. For cardinality=many scenarios, each event points to the common metadata of all the events.

So when using metadata field when cardinality=many, it only needs to take one of the events to get all the data (e.g. events[0].metadata).

typing.Mapping[str, object] Return the Python dictionary of trigger metadata

partition_key

Message partition key.

reply_to

The address of an entity to send replies to.

reply_to_session_id

A session identifier augmenting the reply_to address.

scheduled_enqueue_time

The date and time in UTC at which the message will be enqueued.

session_id

The session identifier for a session-aware entity.

time_to_live

The TTL time interval.

to

The address of an entity the message is addressed.

user_properties

User-defined message metadata.