StorageAccountCollection.GetIfExistsAsync Method

Definition

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
  • Operation Id: StorageAccounts_GetProperties
  • Default Api Version: 2023-05-01
  • Resource: StorageAccountResource
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageAccountResource>> GetIfExistsAsync (string accountName, Azure.ResourceManager.Storage.Models.StorageAccountExpand? expand = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Storage.Models.StorageAccountExpand> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageAccountResource>>
override this.GetIfExistsAsync : string * Nullable<Azure.ResourceManager.Storage.Models.StorageAccountExpand> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.Storage.StorageAccountResource>>
Public Overridable Function GetIfExistsAsync (accountName As String, Optional expand As Nullable(Of StorageAccountExpand) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of StorageAccountResource))

Parameters

accountName
String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

expand
Nullable<StorageAccountExpand>

May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

accountName is null.

Applies to