ServiceBusReceivedMessage Class

Definition

The ServiceBusReceivedMessage is used to receive data from Service Bus Queues and Subscriptions. When sending messages, the ServiceBusMessage is used.

public class ServiceBusReceivedMessage
type ServiceBusReceivedMessage = class
Public Class ServiceBusReceivedMessage
Inheritance
ServiceBusReceivedMessage

Remarks

The message structure is discussed in detail in the product documentation.

Properties

ApplicationProperties

Gets the application properties bag, which can be used for custom message metadata.

Body

Gets the body of the message.

ContentType

Gets the content type descriptor.

CorrelationId

Gets the correlation identifier.

DeadLetterErrorDescription

Gets the dead letter error description for the message.

DeadLetterReason

Gets the dead letter reason for the message.

DeadLetterSource

Gets the name of the queue or subscription that this message was enqueued on, before it was dead-lettered.

DeliveryCount

Get the current delivery count.

EnqueuedSequenceNumber

Gets the original sequence number of the message.

EnqueuedTime

Gets the date and time of the sent time in UTC.

ExpiresAt

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

LockedUntil

Gets the date and time in UTC until which the message will be locked in the queue/subscription.

LockToken

Gets the lock token for the current message.

MessageId

Gets the MessageId to identify the message.

PartitionKey

Gets a partition key for sending a message to a partitioned entity.

ReplyTo

Gets the address of an entity to send replies to.

ReplyToSessionId

Gets a session identifier augmenting the ReplyTo address.

ScheduledEnqueueTime

Gets or sets the date and time, in UTC, at which the message should be made available to receivers. This property does not control when a message is sent by the client. Sending happens immediately when SendAsync is called. Service Bus will hide the message from receivers until the the requested time.

SequenceNumber

Gets the unique number assigned to a message by Service Bus.

SessionId

Gets the session identifier for a session-aware entity.

State

Gets the state of the message.

Subject

Gets an application specific label.

TimeToLive

Gets the message’s "time to live" value.

To

Gets the "to" address.

TransactionPartitionKey

Gets a partition key for sending a message into an entity via a partitioned transfer queue.

Methods

FromAmqpMessage(AmqpAnnotatedMessage, BinaryData)

Constructs a ServiceBusReceivedMessage from its serialized AMQP form.

GetRawAmqpMessage()

Gets the raw Amqp message data that was transmitted over the wire. This can be used to enable scenarios that require reading AMQP header, footer, property, or annotation data that is not exposed as top level properties in the ServiceBusReceivedMessage.

ToString()

Returns a string that represents the current message.

Applies to