StorageAccounts interface
Interface representing a StorageAccounts.
Methods
| begin |
Abort live Migration of storage account to enable Hns |
| begin |
Abort live Migration of storage account to enable Hns |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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. |
| begin |
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 |
| begin |
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 |
| begin |
Live Migration of storage account to enable Hns |
| begin |
Live Migration of storage account to enable Hns |
| begin |
Restore blobs in the specified blob ranges |
| begin |
Restore blobs in the specified blob ranges |
| check |
Checks that the storage account name is valid and is not already in use. |
| delete(string, string, Storage |
Deletes a storage account in Microsoft Azure. |
| get |
Gets the status of the ongoing migration for the specified storage account. |
| get |
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(Storage |
Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this. |
| list |
List SAS credentials of a storage account. |
| list |
Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this. |
| list |
Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account. |
| list |
List service SAS credentials of a specific resource. |
| regenerate |
Regenerates one of the access keys or Kerberos keys for the specified storage account. |
| revoke |
Revoke user delegation keys. |
| update(string, string, Storage |
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.
The options parameters.
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.
The options parameters.
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.
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.
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.
The options parameters.
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.
The options parameters.
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.
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.
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.
The options parameters.
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.
The options parameters.
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.
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.
The options parameters.
Returns
Promise<BlobRestoreStatus>
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.
The options parameters.
Returns
Promise<CheckNameAvailabilityResult>
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.
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'
The options parameters.
Returns
Promise<StorageAccountMigration>
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.
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
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.
The options parameters.
Returns
Promise<ListAccountSasResponse>
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.
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.
The options parameters.
Returns
Promise<StorageAccountListKeysResult>
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.
The options parameters.
Returns
Promise<ListServiceSasResponse>
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.
The options parameters.
Returns
Promise<StorageAccountListKeysResult>
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.
The options parameters.
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.
The options parameters.
Returns
Promise<StorageAccount>