ServiceBusMessage Class

An HTTP response object.

Inheritance

azure.functions._servicebus.ServiceBusMessage

ServiceBusMessage

Constructor

ServiceBusMessage(*, body: bytes, trigger_metadata: Mapping[str, Any] | None = None, application_properties: Dict[str, Any], content_type: str | None = None, correlation_id: str | None = None, dead_letter_error_description: str | None = None, dead_letter_reason: str | None = None, dead_letter_source: str | None = None, delivery_count: int | None = None, enqueued_sequence_number: int | None = None, enqueued_time_utc: datetime | None = None, expires_at_utc: datetime | None = None, label: str | None = None, locked_until: datetime | None = None, lock_token: str | None = None, message_id: str, partition_key: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, sequence_number: int | None = None, session_id: str | None = None, state: int | None = None, subject: str | None = None, time_to_live: timedelta | None = None, to: str | None = None, transaction_partition_key: str | None = None, user_properties: Dict[str, object])

Keyword-Only Parameters

Name	Description
body Required
trigger_metadata Required
application_properties Required
content_type Required
correlation_id Required
dead_letter_error_description Required
dead_letter_reason Required
dead_letter_source Required
delivery_count Required
enqueued_sequence_number Required
enqueued_time_utc Required
expires_at_utc Required
label Required
locked_until Required
lock_token Required
message_id Required
partition_key Required
reply_to Required
reply_to_session_id Required
scheduled_enqueue_time_utc Required
sequence_number Required
session_id Required
state Required
subject Required
time_to_live Required
to Required
transaction_partition_key Required
user_properties Required

Methods

get_body

get_body

get_body() -> bytes

Attributes

application_properties

content_type

correlation_id

dead_letter_error_description

dead_letter_reason

dead_letter_source

delivery_count

enqueued_sequence_number

enqueued_time_utc

expiration_time

(Deprecated) Use expires_at_utc instead

expires_at_utc

force_persistence

label

lock_token

locked_until

message_id

metadata

partition_key

reply_to

reply_to_session_id

scheduled_enqueue_time

(Deprecated) Use scheduled_enqueue_time_utc instead

scheduled_enqueue_time_utc

sequence_number

session_id

state

subject

time_to_live

to

transaction_partition_key

user_properties