Share via


StorageQueueCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
  • Operation Id: Queue_Get
  • Default Api Version: 2023-05-01
  • Resource: StorageQueueResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageQueueResource>> GetIfExistsAsync (string queueName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageQueueResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageQueueResource>>
Public Overridable Function GetIfExistsAsync (queueName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(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

Exceptions

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

queueName is null.

Applies to