QueueDescription Class

Definition

Represents the metadata description of the queue.

public class QueueDescription : IEquatable<Microsoft.Azure.ServiceBus.Management.QueueDescription>
type QueueDescription = class
    interface IEquatable<QueueDescription>
Public Class QueueDescription
Implements IEquatable(Of QueueDescription)
Inheritance
QueueDescription
Implements

Constructors

QueueDescription(String)

Initializes a new instance of QueueDescription class with the specified relative path.

Properties

AuthorizationRules

The AuthorizationRules on the queue to control user access at entity level.

AutoDeleteOnIdle

The TimeSpan idle interval after which the queue is automatically deleted.

DefaultMessageTimeToLive

The default time to live value for the messages. This is the duration after which the message expires, starting from when the message is sent to Service Bus.

DuplicateDetectionHistoryTimeWindow

The TimeSpan duration of duplicate detection history that is maintained by the service.

EnableBatchedOperations

Indicates whether server-side batched operations are enabled.

EnableDeadLetteringOnMessageExpiration

Indicates whether this queue has dead letter support when a message expires.

EnablePartitioning

Indicates whether the queue is to be partitioned across multiple message brokers.

ForwardDeadLetteredMessagesTo

The path of the recipient entity to which all the dead-lettered messages of this queue are forwarded to.

ForwardTo

The path of the recipient entity to which all the messages sent to the queue are forwarded to.

LockDuration

Duration of a peek lock receive. i.e., the amount of time that the message is locked by a given receiver so that no other receiver receives the same message.

MaxDeliveryCount

The maximum delivery count of a message before it is dead-lettered.

MaxSizeInMB

The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.

Path

Path of the queue relative to the namespace base address.

RequiresDuplicateDetection

This value indicates if the queue requires guard against duplicate messages. If true, duplicate messages having same MessageId and sent to queue within duration of DuplicateDetectionHistoryTimeWindow will be discarded.

RequiresSession

This indicates whether the queue supports the concept of session. Sessionful-messages follow FIFO ordering.

Status

The current status of the queue (Enabled / Disabled).

UserMetadata

Custom metdata that user can associate with the description.

Methods

Equals(Object)
Equals(QueueDescription)
GetHashCode()

Operators

Equality(QueueDescription, QueueDescription)
Inequality(QueueDescription, QueueDescription)

Applies to