[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See
Storage Client Library for the latest version.]
Returns an enumerable collection of the queues in the storage account whose names begin with the specified prefix and that are retrieved lazily.
Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
Visual Basic |
---|
Dim instance As CloudQueueClient
Dim prefix As String
Dim detailsIncluded As QueueListingDetails
Dim returnValue As IEnumerable(Of CloudQueue)
returnValue = instance.ListQueues(prefix, detailsIncluded) |
Syntax
Visual Basic |
---|
Public Function ListQueues ( _
prefix As String, _
detailsIncluded As QueueListingDetails _
) As IEnumerable(Of CloudQueue) |
C# |
---|
public IEnumerable<CloudQueue> ListQueues (
string prefix,
QueueListingDetails detailsIncluded
) |
C++ |
---|
public:
IEnumerable<CloudQueue^>^ ListQueues (
String^ prefix,
QueueListingDetails detailsIncluded
) |
Parameters
- prefix
Type: System.String
The queue name prefix.
- detailsIncluded
Type: Microsoft.WindowsAzure.StorageClient.QueueListingDetails
One of the enumeration values that indicates which details to include in the listing.
Return Value
Type: System.Collections.Generic.IEnumerable
An enumerable collection of queues that are retrieved lazily.
Example
The following code example lists all of the queues in the account, next lists queues beginning with a specified prefix, and finally lists queues with metadata included in the listing.
| Copy Code |
---|
static void ListQueuesInAccount(Uri queueEndpoint, string accountName, string accountKey)
{
//Create service client for credentialed access to the Queue service.
CloudQueueClient queueClient = new CloudQueueClient(queueEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));
//List all of the queues in account.
foreach(var queue in queueClient.ListQueues())
{
Console.WriteLine(queue.Name);
}
Console.WriteLine();
//List all of the queues in account beginning with the specified prefix.
foreach(var queue in queueClient.ListQueues("my"))
{
Console.WriteLine(queue.Name);
}
Console.WriteLine();
//List all of the queues in account beginning with the specified prefix, and also return queue metadata.
foreach (var queue in queueClient.ListQueues("my", QueueListingDetails.Metadata))
{
Console.WriteLine(queue.Name);
//Enumerate the queue's metadata.
foreach (var metadataKey in queue.Metadata.Keys)
{
Console.WriteLine("\tMetadata name: " + metadataKey.ToString());
Console.WriteLine("\tMetadata value: " + queue.Metadata.Get(metadataKey.ToString()));
}
}
Console.WriteLine();
}
|
Remarks
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Change History
See Also