QueueDescription QueueDescription Class

Definition

Represents the metadata description of the queue.

[DataContract(Name = "QueueDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class QueueDescription : EntityDescription, IExtensibleDataObject, IResourceDescription<DataContract(Name:="QueueDescription", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
Public NotInheritable Class QueueDescription
    Inherits EntityDescription
    Implements IExtensibleDataObject, IResourceDescription
Inheritance
QueueDescriptionQueueDescription
Attributes

Inherited Members

Microsoft.ServiceBus.Messaging.EntityDescription

System.Object

Constructors

QueueDescription(String) QueueDescription(String)

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

public QueueDescription(string path)Public Sub New(path As String)
Parameters
path
String String

Path of the queue relative to the namespace base address.

Attributes

Fields

MessageTimeToLiveDefaultValue MessageTimeToLiveDefaultValue

The message time to live default value in bytes

public static readonly TimeSpan MessageTimeToLiveDefaultValuePublic Shared ReadOnly MessageTimeToLiveDefaultValue As TimeSpan
Attributes

Properties

AccessedAt AccessedAt

Gets the last time a message was sent, or the last time there was a receive request to this queue.

public DateTime AccessedAt { get; }Public ReadOnly Property AccessedAt As Date
Value
DateTime DateTime

The last time a message was sent, or the last time there was a receive request to this queue.

Attributes

Authorization Authorization

Gets the AuthorizationRules.

public AuthorizationRules Authorization { get; }Public ReadOnly Property Authorization As AuthorizationRules
Attributes

AutoDeleteOnIdle AutoDeleteOnIdle

Gets or sets the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

public TimeSpan AutoDeleteOnIdle { get; set; }Public Property AutoDeleteOnIdle As TimeSpan
Value
TimeSpan TimeSpan

The auto delete on idle time span for the queue.

Attributes

AvailabilityStatus AvailabilityStatus

Gets the entity availability status for the queue.

public EntityAvailabilityStatus AvailabilityStatus { get; }Public ReadOnly Property AvailabilityStatus As EntityAvailabilityStatus
Value
EntityAvailabilityStatus EntityAvailabilityStatus

The entity availability status for the queue.

Attributes

CreatedAt CreatedAt

Gets the exact time the message was created.

public DateTime CreatedAt { get; }Public ReadOnly Property CreatedAt As Date
Value
DateTime DateTime

The time the message was created.

Attributes

DefaultMessageTimeToLive DefaultMessageTimeToLive

Gets or sets the default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.A message can have a lower TimeToLive value than that specified here, but by default TimeToLive is set to MaxValue. Therefore, this property becomes the default time to live value applied to messages.

public TimeSpan DefaultMessageTimeToLive { get; set; }Public Property DefaultMessageTimeToLive As TimeSpan
Value
TimeSpan TimeSpan

The default message time to live value.

Attributes

DuplicateDetectionHistoryTimeWindow DuplicateDetectionHistoryTimeWindow

Gets or sets the TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

public TimeSpan DuplicateDetectionHistoryTimeWindow { get; set; }Public Property DuplicateDetectionHistoryTimeWindow As TimeSpan
Value
TimeSpan TimeSpan

The TimeSpan structure that represents the time windows for duplication detection history.

Attributes

EnableBatchedOperations EnableBatchedOperations

Gets or sets a value that indicates whether server-side batched operations are enabled.

public bool EnableBatchedOperations { get; set; }Public Property EnableBatchedOperations As Boolean
Value
Boolean Boolean

true if the batched operations are enabled; otherwise, false.

Attributes

EnableDeadLetteringOnMessageExpiration EnableDeadLetteringOnMessageExpiration

Gets or sets a value that indicates whether this queue has dead letter support when a message expires.

public bool EnableDeadLetteringOnMessageExpiration { get; set; }Public Property EnableDeadLetteringOnMessageExpiration As Boolean
Value
Boolean Boolean

true if the queue has a dead letter support when a message expires; otherwise, false.

Attributes

EnableExpress EnableExpress

Gets or sets a value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

public bool EnableExpress { get; set; }Public Property EnableExpress As Boolean
Value
Boolean Boolean

true if Express Entities are enabled; otherwise, false.

Attributes

EnablePartitioning EnablePartitioning

Gets or sets a value that indicates whether the queue to be partitioned across multiple message brokers is enabled.

public bool EnablePartitioning { get; set; }Public Property EnablePartitioning As Boolean
Value
Boolean Boolean

true if the queue to be partitioned across multiple message brokers is enabled; otherwise, false.

Attributes

ForwardDeadLetteredMessagesTo ForwardDeadLetteredMessagesTo

Gets or sets the path to the recipient to which the dead lettered message is forwarded.

public string ForwardDeadLetteredMessagesTo { get; set; }Public Property ForwardDeadLetteredMessagesTo As String
Value
String String

The path to the recipient to which the dead lettered message is forwarded.

Attributes

ForwardTo ForwardTo

Gets or sets the path to the recipient to which the message is forwarded.

public string ForwardTo { get; set; }Public Property ForwardTo As String
Value
String String

The path to the recipient to which the message is forwarded.

Attributes

IsAnonymousAccessible IsAnonymousAccessible

Gets or sets a value that indicates whether the message is anonymous accessible.

public bool IsAnonymousAccessible { get; set; }Public Property IsAnonymousAccessible As Boolean
Value
Boolean Boolean

true if the message is anonymous accessible; otherwise, false.

Attributes

LockDuration LockDuration

Gets or sets the duration of a peek lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

public TimeSpan LockDuration { get; set; }Public Property LockDuration As TimeSpan
Value
TimeSpan TimeSpan

The duration of the lock.

Attributes

MaxDeliveryCount MaxDeliveryCount

Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries.

public int MaxDeliveryCount { get; set; }Public Property MaxDeliveryCount As Integer
Value
Int32 Int32

The number of maximum deliveries.

Attributes

MaxSizeInMegabytes MaxSizeInMegabytes

Gets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue.

public long MaxSizeInMegabytes { get; set; }Public Property MaxSizeInMegabytes As Long
Value
Int64 Int64

The maximum size of the queue in megabytes.

Attributes

MessageCount MessageCount

Gets the number of messages in the queue.

public long MessageCount { get; }Public ReadOnly Property MessageCount As Long
Value
Int64 Int64

The number of messages.

Attributes

MessageCountDetails MessageCountDetails

Gets message details for a queue.

public MessageCountDetails MessageCountDetails { get; }Public ReadOnly Property MessageCountDetails As MessageCountDetails
Value
MessageCountDetails MessageCountDetails

Returns MessageCountDetails with the number of active messages, dead letters, scheduled messages, messages transferred to other queues, subscriptions, or topics, and the number of messages transferred to the dead letter queue.

Attributes

Path Path

Gets or sets the name of the queue.

public string Path { get; set; }Public Property Path As String
Value
String String

The name of the queue.

Attributes

Remarks

This is a relative path to the Address.

RequiresDuplicateDetection RequiresDuplicateDetection

Gets or sets the value indicating if this queue requires duplicate detection.

public bool RequiresDuplicateDetection { get; set; }Public Property RequiresDuplicateDetection As Boolean
Value
Boolean Boolean

true if this queue requires duplicate detection; otherwise, false.

Attributes

RequiresSession RequiresSession

Gets or sets a value that indicates whether the queue supports the concept of session.

public bool RequiresSession { get; set; }Public Property RequiresSession As Boolean
Value
Boolean Boolean

true if the receiver application can only receive from the queue through a MessageSession; false if a queue cannot receive using MessageSession.

Attributes

SizeInBytes SizeInBytes

Gets the size of the queue in bytes.

public long SizeInBytes { get; }Public ReadOnly Property SizeInBytes As Long
Value
Int64 Int64

The size of the queue.

Attributes

Status Status

Gets or sets the current status of the queue (enabled or disabled). When an entity is disabled, that entity cannot send or receive messages.

public EntityStatus Status { get; set; }Public Property Status As EntityStatus
Value
EntityStatus EntityStatus

The current status of the queue.

Attributes

SupportOrdering SupportOrdering

Gets or sets a value that indicates whether the queue supports ordering.

public bool SupportOrdering { get; set; }Public Property SupportOrdering As Boolean
Value
Boolean Boolean

true if the queue supports ordering; otherwise, false.

Attributes

UpdatedAt UpdatedAt

Gets the exact time the message has been updated.

public DateTime UpdatedAt { get; }Public ReadOnly Property UpdatedAt As Date
Value
DateTime DateTime

The time the message has been updated.

Attributes

UserMetadata UserMetadata

Gets or sets the user metadata.

public string UserMetadata { get; set; }Public Property UserMetadata As String
Value
String String

The user metadata.

Attributes