NamespaceManager.GetQueues Method

Definition

Namespace:

Microsoft.ServiceBus

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Overloads

GetQueues()	Retrieves an enumerable collection of all queues in the service namespace.
GetQueues(String)	Retrieves an enumerable collection of all queues in the service namespace with the specified filter. You can filter by a combination of entity name (including starts with), entity length (Gt or Lt), created, updated, and accessed time (Gt or Lt).

GetQueues()

Retrieves an enumerable collection of all queues in the service namespace.

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.QueueDescription> GetQueues ();

member this.GetQueues : unit -> seq<Microsoft.ServiceBus.Messaging.QueueDescription>

Public Function GetQueues () As IEnumerable(Of QueueDescription)

Returns

IEnumerable<QueueDescription>

An IEnumerable<T> object that represents the collection of all queues in the service namespace or returns an empty collection if no queue exists.

Exceptions

TimeoutException

The operation times out. The timeout period is initialized through the NamespaceManagerSettings class. You may need to increase the value of the OperationTimeout property to avoid this exception if the timeout value is relatively low.

UnauthorizedAccessException

The NamespaceManager object does not have sufficient permission to perform this operation. You should check to ensure that your NamespaceManager has the correct TokenProvider credentials to perform this operation.

MessagingException

An internal error or unexpected exception occurs.

GetQueues(String)

Retrieves an enumerable collection of all queues in the service namespace with the specified filter. You can filter by a combination of entity name (including starts with), entity length (Gt or Lt), created, updated, and accessed time (Gt or Lt).

public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.QueueDescription> GetQueues (string filter);

member this.GetQueues : string -> seq<Microsoft.ServiceBus.Messaging.QueueDescription>

Public Function GetQueues (filter As String) As IEnumerable(Of QueueDescription)

Parameters

filter

String

A string used to filter the queues to be retrieved.

Returns

IEnumerable<QueueDescription>

An IEnumerable<T> object that represents the collection of all queues in the service namespace or returns an empty collection if no queue exists.

Examples

var queuesWithMessages = namespaceManager.GetQueues("messageCount Gt 0");
var queuesStartsWith = namespaceManager.GetQueues($"startswith(path, 'queue') eq true");

Remarks

Filter expression formats: {Propery} {Logical Operator} {Value} AND {Filter expression} {Function} {Logical Operator} {Value} AND {Filter expression} ----------------------------------------------------------------------------------------- Available properties: Path | ModifiedAt | AccessedAt | CreatedAt | MessageCount Logical operators: Eq | Ne | Gt | Ge | Lt | Le Value: A value of the corresponding property type Functions: startswith({Propery}, {Value})