StorageAccountsOperations interface

Interface representing a StorageAccounts operations.

Properties

abortHierarchicalNamespaceMigration

Abort live Migration of storage account to enable Hns

beginAbortHierarchicalNamespaceMigration
beginAbortHierarchicalNamespaceMigrationAndWait
beginCreate
beginCreateAndWait
beginCustomerInitiatedMigration
beginCustomerInitiatedMigrationAndWait
beginFailover
beginFailoverAndWait
beginHierarchicalNamespaceMigration
beginHierarchicalNamespaceMigrationAndWait
beginRestoreBlobRanges
beginRestoreBlobRangesAndWait
checkNameAvailability

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

create

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.

customerInitiatedMigration

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.

delete

Deletes a storage account in Microsoft Azure.

failover

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://dotnet.territoriali.olinfo.it/azure/storage/common/storage-disaster-recovery-guidance

getCustomerInitiatedMigration

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

getProperties

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.

hierarchicalNamespaceMigration

Live Migration of storage account to enable Hns

list

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

listAccountSAS

List SAS credentials of a storage account.

listByResourceGroup

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

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

listServiceSAS

List service SAS credentials of a specific resource.

regenerateKey

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

restoreBlobRanges

Restore blobs in the specified blob ranges

revokeUserDelegationKeys

Revoke user delegation keys.

update

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.

Property Details

abortHierarchicalNamespaceMigration

Abort live Migration of storage account to enable Hns

abortHierarchicalNamespaceMigration: (resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams) => PollerLike<OperationState<void>, void>

beginAbortHierarchicalNamespaceMigration

Warning

This API is now deprecated.

use abortHierarchicalNamespaceMigration instead

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

Property Value

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

beginAbortHierarchicalNamespaceMigrationAndWait

Warning

This API is now deprecated.

use abortHierarchicalNamespaceMigration instead

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

Property Value

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

beginCreate

Warning

This API is now deprecated.

use create instead

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

Property Value

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

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

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

Property Value

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

beginCustomerInitiatedMigration

Warning

This API is now deprecated.

use customerInitiatedMigration instead

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

Property Value

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

beginCustomerInitiatedMigrationAndWait

Warning

This API is now deprecated.

use customerInitiatedMigration instead

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

Property Value

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

beginFailover

Warning

This API is now deprecated.

use failover instead

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

Property Value

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

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

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

Property Value

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

beginHierarchicalNamespaceMigration

Warning

This API is now deprecated.

use hierarchicalNamespaceMigration instead

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

Property Value

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

beginHierarchicalNamespaceMigrationAndWait

Warning

This API is now deprecated.

use hierarchicalNamespaceMigration instead

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

Property Value

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

beginRestoreBlobRanges

Warning

This API is now deprecated.

use restoreBlobRanges instead

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

Property Value

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

beginRestoreBlobRangesAndWait

Warning

This API is now deprecated.

use restoreBlobRanges instead

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

Property Value

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

checkNameAvailability

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

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

Property Value

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

create

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.

create: (resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams) => PollerLike<OperationState<StorageAccount>, StorageAccount>

Property Value

(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams) => PollerLike<OperationState<StorageAccount>, StorageAccount>

customerInitiatedMigration

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.

customerInitiatedMigration: (resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams) => PollerLike<OperationState<void>, void>

delete

Deletes a storage account in Microsoft Azure.

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

Property Value

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

failover

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://dotnet.territoriali.olinfo.it/azure/storage/common/storage-disaster-recovery-guidance

failover: (resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams) => PollerLike<OperationState<void>, void>

getCustomerInitiatedMigration

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

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

Property Value

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

getProperties

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.

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

Property Value

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

hierarchicalNamespaceMigration

Live Migration of storage account to enable Hns

hierarchicalNamespaceMigration: (resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams) => PollerLike<OperationState<void>, void>

list

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

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

Property Value

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

listAccountSAS

List SAS credentials of a storage account.

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

Property Value

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

listByResourceGroup

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

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

Property Value

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

listKeys

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

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

Property Value

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

listServiceSAS

List service SAS credentials of a specific resource.

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

Property Value

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

regenerateKey

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

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

Property Value

(resourceGroupName: string, accountName: string, regenerateKeyParameter: StorageAccountRegenerateKeyParameters, options?: StorageAccountsRegenerateKeyOptionalParams) => Promise<StorageAccountListKeysResult>

restoreBlobRanges

Restore blobs in the specified blob ranges

restoreBlobRanges: (resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams) => PollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>

Property Value

(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams) => PollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>

revokeUserDelegationKeys

Revoke user delegation keys.

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

Property Value

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

update

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.

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

Property Value

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