Inheritance
ServiceBusReceivedMessage
Namespace: Azure.Messaging.ServiceBus
Assembly: Azure.Messaging.ServiceBus.dll
Syntax
public class ServiceBusReceivedMessage
Properties
AmqpMessage
Gets the raw Amqp message data that will be 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 ServiceBusMessage.
Declaration
public Azure.Core.Amqp.AmqpAnnotatedMessage AmqpMessage { get; }
Property Value
ApplicationProperties
Gets the application properties bag, which can be used for custom message metadata.
Declaration
public System.Collections.Generic.IReadOnlyDictionary<string,object> ApplicationProperties { get; }
Property Value
Body
Gets the body of the message.
Declaration
public Azure.BinaryData Body { get; }
Property Value
ContentType
Gets the content type descriptor.
Declaration
public string ContentType { get; }
Property Value
String RFC2045 Content-Type descriptor. |
CorrelationId
Gets the a correlation identifier.
Declaration
public string CorrelationId { get; }
Property Value
String Correlation identifier. |
DeadLetterErrorDescription
Declaration
public string DeadLetterErrorDescription { get; }
Property Value
DeadLetterReason
Declaration
public string DeadLetterReason { get; }
Property Value
DeadLetterSource
Gets the name of the queue or subscription that this message was enqueued on, before it was deadlettered.
Declaration
public string DeadLetterSource { get; }
Property Value
DeliveryCount
Get the current delivery count.
Declaration
public int DeliveryCount { get; }
Property Value
Int32 This value starts at 1. |
EnqueuedSequenceNumber
Gets or sets the original sequence number of the message.
Declaration
public long EnqueuedSequenceNumber { get; }
Property Value
Int64 The enqueued sequence number of the message. |
EnqueuedTime
Gets or sets the date and time of the sent time in UTC.
Declaration
public DateTimeOffset EnqueuedTime { get; }
Property Value
ExpiresAt
Gets the date and time in UTC at which the message is set to expire.
Declaration
public DateTimeOffset ExpiresAt { get; }
Property Value
DateTimeOffset The message expiration time in UTC. This property is read-only. |
Exceptions
LockedUntil
Gets the date and time in UTC until which the message will be locked in the queue/subscription.
Declaration
public DateTimeOffset LockedUntil { get; }
Property Value
DateTimeOffset The date and time until which the message will be locked in the queue/subscription. |
LockToken
Gets the lock token for the current message.
Declaration
public string LockToken { get; }
Property Value
MessageId
Gets the MessageId to identify the message.
Declaration
public string MessageId { get; }
Property Value
PartitionKey
Gets a partition key for sending a message to a partitioned entity.
Declaration
public string PartitionKey { get; }
Property Value
String The partition key. Maximum length is 128 characters. |
ReplyTo
Gets the address of an entity to send replies to.
Declaration
public string ReplyTo { get; }
Property Value
String The reply entity address. |
ReplyToSessionId
Gets a session identifier augmenting the ReplyTo address.
Declaration
public string ReplyToSessionId { get; }
Property Value
String Session identifier. Maximum length is 128 characters. |
ScheduledEnqueueTime
Gets the date and time in UTC at which the message will be enqueued. This property returns the time in UTC; when setting the property, the supplied DateTime value must also be in UTC.
Declaration
public DateTimeOffset ScheduledEnqueueTime { get; }
Property Value
DateTimeOffset The scheduled enqueue time in UTC. This value is for delayed message sending. It is utilized to delay messages sending to a specific time in the future. |
SequenceNumber
Gets the unique number assigned to a message by Service Bus.
Declaration
public long SequenceNumber { get; }
Property Value
SessionId
Gets the session identifier for a session-aware entity.
Declaration
public string SessionId { get; }
Property Value
String The session identifier. Maximum length is 128 characters. |
Subject
Gets an application specific label.
Declaration
public string Subject { get; }
Property Value
String The application specific label |
TimeToLive
Gets the message’s "time to live" value.
Declaration
public TimeSpan TimeToLive { get; }
Property Value
TimeSpan The message’s time to live value. |
To
Gets the "to" address.
Declaration
public string To { get; }
Property Value
ViaPartitionKey
Gets a partition key for sending a message into an entity via a partitioned transfer queue.
Declaration
public string ViaPartitionKey { get; }
Property Value
String The partition key. Maximum length is 128 characters. |
Methods
ToString()
Returns a string that represents the current message.
Declaration
public override string ToString ();
Returns
String The string representation of the current message. |
ncG1vNJzZmiZqqq%2Fpr%2FDpJuom6Njr627wWeaqKqVY8SqusOorqxmnprBcHDWnplonJ%2Bpu6bAjnqxrqqVY5qmv9KanqKml2Ogpr7VopqeeqWofHh6j2dnZqiimsOqsdZnb2iZoJ58gsbUq5xnhZWowKKzyKeeZ4uVp8Oqr8R7rKxnca%2FCs7GNhpysq5Gctq%2BzjYycq66ZmLKDwdJnip6qpp6wpo7UrImem5Wew6awrJ6qrJmXmnupwMyl