QueueServiceResource.GetStorageQueueAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.Storage

Assembly:: Azure.ResourceManager.Storage.dll

Package:: Azure.ResourceManager.Storage v1.2.3

Package:: Azure.ResourceManager.Storage v1.2.0-beta.2

Source:: QueueServiceResource.cs

Source:: QueueServiceResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the queue with the specified queue name, under the specified account if it exists.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
Operation Id: Queue_Get
Default Api Version: 2022-09-01
Resource: StorageQueueResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.StorageQueueResource>> GetStorageQueueAsync (string queueName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetStorageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.StorageQueueResource>>
override this.GetStorageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Storage.StorageQueueResource>>

Public Overridable Function GetStorageQueueAsync (queueName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of StorageQueueResource))

Parameters

queueName: String

A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<StorageQueueResource>>

Exceptions

ArgumentNullException

queueName is null.

ArgumentException

queueName is an empty string, and was expected to be non-empty.

Applies to

Share via