StorageAccounts interface

Interface representing a StorageAccounts.

Methods

beginAbortHierarchicalNamespaceMigration(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)

Abort live Migration of storage account to enable Hns

beginAbortHierarchicalNamespaceMigrationAndWait(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)

Abort live Migration of storage account to enable Hns

beginCreate(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

beginCreateAndWait(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

beginCustomerInitiatedMigration(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)

Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.

beginCustomerInitiatedMigrationAndWait(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)

Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.

beginFailover(string, string, StorageAccountsFailoverOptionalParams)

A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance

beginFailoverAndWait(string, string, StorageAccountsFailoverOptionalParams)

A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance

beginHierarchicalNamespaceMigration(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)

Live Migration of storage account to enable Hns

beginHierarchicalNamespaceMigrationAndWait(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)

Live Migration of storage account to enable Hns

beginRestoreBlobRanges(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)

Restore blobs in the specified blob ranges

beginRestoreBlobRangesAndWait(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)

Restore blobs in the specified blob ranges

checkNameAvailability(StorageAccountCheckNameAvailabilityParameters, StorageAccountsCheckNameAvailabilityOptionalParams)

Checks that the storage account name is valid and is not already in use.

delete(string, string, StorageAccountsDeleteOptionalParams)

Deletes a storage account in Microsoft Azure.

getCustomerInitiatedMigration(string, string, string, StorageAccountsGetCustomerInitiatedMigrationOptionalParams)

Gets the status of the ongoing migration for the specified storage account.

getProperties(string, string, StorageAccountsGetPropertiesOptionalParams)

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.

list(StorageAccountsListOptionalParams)

Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.

listAccountSAS(string, string, AccountSasParameters, StorageAccountsListAccountSASOptionalParams)

List SAS credentials of a storage account.

listByResourceGroup(string, StorageAccountsListByResourceGroupOptionalParams)

Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.

listKeys(string, string, StorageAccountsListKeysOptionalParams)

Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.

listServiceSAS(string, string, ServiceSasParameters, StorageAccountsListServiceSASOptionalParams)

List service SAS credentials of a specific resource.

regenerateKey(string, string, StorageAccountRegenerateKeyParameters, StorageAccountsRegenerateKeyOptionalParams)

Regenerates one of the access keys or Kerberos keys for the specified storage account.

revokeUserDelegationKeys(string, string, StorageAccountsRevokeUserDelegationKeysOptionalParams)

Revoke user delegation keys.

update(string, string, StorageAccountUpdateParameters, StorageAccountsUpdateOptionalParams)

The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.

Method Details

beginAbortHierarchicalNamespaceMigration(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)

Abort live Migration of storage account to enable Hns

function beginAbortHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginAbortHierarchicalNamespaceMigrationAndWait(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)

Abort live Migration of storage account to enable Hns

function beginAbortHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

Returns

Promise<void>

beginCreate(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

function beginCreate(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
StorageAccountCreateParameters

The parameters to provide for the created account.

options
StorageAccountsCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>

beginCreateAndWait(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<StorageAccount>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
StorageAccountCreateParameters

The parameters to provide for the created account.

options
StorageAccountsCreateOptionalParams

The options parameters.

Returns

Promise<StorageAccount>

beginCustomerInitiatedMigration(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)

Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.

function beginCustomerInitiatedMigration(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
StorageAccountMigration

The request parameters required to perform storage account migration.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCustomerInitiatedMigrationAndWait(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)

Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.

function beginCustomerInitiatedMigrationAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
StorageAccountMigration

The request parameters required to perform storage account migration.

Returns

Promise<void>

beginFailover(string, string, StorageAccountsFailoverOptionalParams)

A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance

function beginFailover(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

options
StorageAccountsFailoverOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginFailoverAndWait(string, string, StorageAccountsFailoverOptionalParams)

A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance

function beginFailoverAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

options
StorageAccountsFailoverOptionalParams

The options parameters.

Returns

Promise<void>

beginHierarchicalNamespaceMigration(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)

Live Migration of storage account to enable Hns

function beginHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

requestType

string

Required. Hierarchical namespace migration type can either be a hierarchical namespace validation request 'HnsOnValidationRequest' or a hydration request 'HnsOnHydrationRequest'. The validation request will validate the migration whereas the hydration request will migrate the account.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginHierarchicalNamespaceMigrationAndWait(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)

Live Migration of storage account to enable Hns

function beginHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

requestType

string

Required. Hierarchical namespace migration type can either be a hierarchical namespace validation request 'HnsOnValidationRequest' or a hydration request 'HnsOnHydrationRequest'. The validation request will validate the migration whereas the hydration request will migrate the account.

Returns

Promise<void>

beginRestoreBlobRanges(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)

Restore blobs in the specified blob ranges

function beginRestoreBlobRanges(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
BlobRestoreParameters

The parameters to provide for restore blob ranges.

options
StorageAccountsRestoreBlobRangesOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>

beginRestoreBlobRangesAndWait(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)

Restore blobs in the specified blob ranges

function beginRestoreBlobRangesAndWait(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<BlobRestoreStatus>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
BlobRestoreParameters

The parameters to provide for restore blob ranges.

options
StorageAccountsRestoreBlobRangesOptionalParams

The options parameters.

Returns

checkNameAvailability(StorageAccountCheckNameAvailabilityParameters, StorageAccountsCheckNameAvailabilityOptionalParams)

Checks that the storage account name is valid and is not already in use.

function checkNameAvailability(accountName: StorageAccountCheckNameAvailabilityParameters, options?: StorageAccountsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>

Parameters

accountName
StorageAccountCheckNameAvailabilityParameters

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.

options
StorageAccountsCheckNameAvailabilityOptionalParams

The options parameters.

Returns

delete(string, string, StorageAccountsDeleteOptionalParams)

Deletes a storage account in Microsoft Azure.

function delete(resourceGroupName: string, accountName: string, options?: StorageAccountsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

options
StorageAccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getCustomerInitiatedMigration(string, string, string, StorageAccountsGetCustomerInitiatedMigrationOptionalParams)

Gets the status of the ongoing migration for the specified storage account.

function getCustomerInitiatedMigration(resourceGroupName: string, accountName: string, migrationName: string, options?: StorageAccountsGetCustomerInitiatedMigrationOptionalParams): Promise<StorageAccountMigration>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

migrationName

string

The name of the Storage Account Migration. It should always be 'default'

Returns

getProperties(string, string, StorageAccountsGetPropertiesOptionalParams)

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.

function getProperties(resourceGroupName: string, accountName: string, options?: StorageAccountsGetPropertiesOptionalParams): Promise<StorageAccount>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

options
StorageAccountsGetPropertiesOptionalParams

The options parameters.

Returns

Promise<StorageAccount>

list(StorageAccountsListOptionalParams)

Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.

function list(options?: StorageAccountsListOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>

Parameters

options
StorageAccountsListOptionalParams

The options parameters.

Returns

listAccountSAS(string, string, AccountSasParameters, StorageAccountsListAccountSASOptionalParams)

List SAS credentials of a storage account.

function listAccountSAS(resourceGroupName: string, accountName: string, parameters: AccountSasParameters, options?: StorageAccountsListAccountSASOptionalParams): Promise<ListAccountSasResponse>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
AccountSasParameters

The parameters to provide to list SAS credentials for the storage account.

options
StorageAccountsListAccountSASOptionalParams

The options parameters.

Returns

listByResourceGroup(string, StorageAccountsListByResourceGroupOptionalParams)

Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.

function listByResourceGroup(resourceGroupName: string, options?: StorageAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options
StorageAccountsListByResourceGroupOptionalParams

The options parameters.

Returns

listKeys(string, string, StorageAccountsListKeysOptionalParams)

Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.

function listKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsListKeysOptionalParams): Promise<StorageAccountListKeysResult>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

options
StorageAccountsListKeysOptionalParams

The options parameters.

Returns

listServiceSAS(string, string, ServiceSasParameters, StorageAccountsListServiceSASOptionalParams)

List service SAS credentials of a specific resource.

function listServiceSAS(resourceGroupName: string, accountName: string, parameters: ServiceSasParameters, options?: StorageAccountsListServiceSASOptionalParams): Promise<ListServiceSasResponse>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
ServiceSasParameters

The parameters to provide to list service SAS credentials.

options
StorageAccountsListServiceSASOptionalParams

The options parameters.

Returns

regenerateKey(string, string, StorageAccountRegenerateKeyParameters, StorageAccountsRegenerateKeyOptionalParams)

Regenerates one of the access keys or Kerberos keys for the specified storage account.

function regenerateKey(resourceGroupName: string, accountName: string, regenerateKey: StorageAccountRegenerateKeyParameters, options?: StorageAccountsRegenerateKeyOptionalParams): Promise<StorageAccountListKeysResult>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

regenerateKey
StorageAccountRegenerateKeyParameters

Specifies name of the key which should be regenerated -- key1, key2, kerb1, kerb2.

options
StorageAccountsRegenerateKeyOptionalParams

The options parameters.

Returns

revokeUserDelegationKeys(string, string, StorageAccountsRevokeUserDelegationKeysOptionalParams)

Revoke user delegation keys.

function revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsRevokeUserDelegationKeysOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

Returns

Promise<void>

update(string, string, StorageAccountUpdateParameters, StorageAccountsUpdateOptionalParams)

The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.

function update(resourceGroupName: string, accountName: string, parameters: StorageAccountUpdateParameters, options?: StorageAccountsUpdateOptionalParams): Promise<StorageAccount>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

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.

parameters
StorageAccountUpdateParameters

The parameters to provide for the updated account.

options
StorageAccountsUpdateOptionalParams

The options parameters.

Returns

Promise<StorageAccount>