QueueDescription QueueDescription Class

Represents the metadata description of the queue.

Syntax

Declaration

[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 Hierarchy

Constructors summary

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

Fields summary

The message time to live default value in bytes

Properties summary

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

Gets the AuthorizationRules.

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

Gets the entity availability status for the queue.

Gets the exact time the message was created.

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.

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

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

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

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.

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

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

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

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

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.

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

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

Gets the number of messages in the queue.

Gets message details for a queue.

Gets or sets the name of the queue.

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

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

Gets the size of the queue in bytes.

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

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

Gets the exact time the message has been updated.

Gets or sets the user metadata.

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

      Path of the queue relative to the namespace base address.

Fields

  • MessageTimeToLiveDefaultValue
    MessageTimeToLiveDefaultValue

    The message time to live default value in bytes

    public static readonly TimeSpan MessageTimeToLiveDefaultValuePublic Shared ReadOnly MessageTimeToLiveDefaultValue As TimeSpan

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

    Property Value

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

  • Authorization
    Authorization

    Gets the AuthorizationRules.

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

    Property Value

  • 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

    Property Value

  • AvailabilityStatus
    AvailabilityStatus

    Gets the entity availability status for the queue.

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

    Property Value

  • CreatedAt
    CreatedAt

    Gets the exact time the message was created.

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

    Property Value

  • 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

    Property Value

  • 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

    Property Value

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

    • true if Express Entities are enabled; otherwise, false.

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

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

  • 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

    Property Value

  • 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

    Property Value

  • 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

    Property Value

    • The maximum size of the queue in megabytes.

  • MessageCount
    MessageCount

    Gets the number of messages in the queue.

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

    Property Value

  • MessageCountDetails
    MessageCountDetails

    Gets message details for a queue.

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

    Property Value

  • Path
    Path

    Gets or sets the name of the queue.

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

    Property Value

  • RequiresDuplicateDetection
    RequiresDuplicateDetection

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

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

    Property Value

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

  • 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

    Property Value

  • SizeInBytes
    SizeInBytes

    Gets the size of the queue in bytes.

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

    Property Value

  • 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

    Property Value

  • SupportOrdering
    SupportOrdering

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

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

    Property Value

    • true if the queue supports ordering; otherwise, false.

  • UpdatedAt
    UpdatedAt

    Gets the exact time the message has been updated.

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

    Property Value

  • UserMetadata
    UserMetadata

    Gets or sets the user metadata.

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

    Property Value

Details

Assembly

Microsoft.ServiceBus.dll