QueueServiceClient.GetQueuesAsync Method

Definition

Namespace:

Azure.Storage.Queues

Assembly:

Azure.Storage.Queues.dll

Package:

Azure.Storage.Queues v12.18.0

Source:

QueueServiceClient.cs

The GetQueuesAsync(QueueTraits, String, CancellationToken) operation returns an async collection of queues in the storage account. Enumerating the queues may make multiple requests to the service while fetching all the values. Queue names are returned in lexicographic order.

For more information, see List Queues.

public virtual Azure.AsyncPageable<Azure.Storage.Queues.Models.QueueItem> GetQueuesAsync (Azure.Storage.Queues.Models.QueueTraits traits = Azure.Storage.Queues.Models.QueueTraits.None, string prefix = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueuesAsync : Azure.Storage.Queues.Models.QueueTraits * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Queues.Models.QueueItem>
override this.GetQueuesAsync : Azure.Storage.Queues.Models.QueueTraits * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Queues.Models.QueueItem>

Public Overridable Function GetQueuesAsync (Optional traits As QueueTraits = Azure.Storage.Queues.Models.QueueTraits.None, Optional prefix As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of QueueItem)

Parameters

traits

QueueTraits

Optional trait options for shaping the queues.

prefix

String

Optional string that filters the results to return only queues whose name begins with the specified prefix.

cancellationToken

CancellationToken

CancellationToken

Returns

AsyncPageable<QueueItem>

The queues in the storage account.

Remarks

Use an empty marker to start enumeration from the beginning. Queue names are returned in lexicographic order. After getting a segment, process it, and then call ListQueuesSegment again (passing in the next marker) to get the next segment.