StorageExtensions.GetStorageAccount Method

Definition

Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.

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

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

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

resourceGroupResource or accountName is null.

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

Applies to