你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
StorageAccounts interface
表示 StorageAccounts 的接口。
方法
方法详细信息
beginAbortHierarchicalNamespaceMigration(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)
中止存储帐户的实时迁移以启用 Hns
function beginAbortHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginAbortHierarchicalNamespaceMigrationAndWait(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)
中止存储帐户的实时迁移以启用 Hns
function beginAbortHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
返回
Promise<void>
beginCreate(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)
使用指定参数异步创建一个新的存储帐户。 如果已创建帐户并发出具有不同属性的后续创建请求，则会更新帐户属性。 如果已创建帐户，并且发出具有完全相同的属性集的后续创建或更新请求，则请求将成功。
function beginCreate(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- StorageAccountCreateParameters
要为创建的帐户提供的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>
beginCreateAndWait(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)
使用指定参数异步创建一个新的存储帐户。 如果已创建帐户并发出具有不同属性的后续创建请求，则会更新帐户属性。 如果已创建帐户，并且发出具有完全相同的属性集的后续创建或更新请求，则请求将成功。
function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<StorageAccount>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- StorageAccountCreateParameters
要为创建的帐户提供的参数。
选项参数。
返回
Promise<StorageAccount>
beginCustomerInitiatedMigration(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)
可以为存储帐户触发帐户迁移请求，以更改其冗余级别。 迁移会将非区域冗余存储帐户更新为区域性冗余帐户，反之亦然，以便提供更好的可靠性和可用性。 区域冗余存储 (ZRS) 在主要区域中的三个 Azure 可用性区域同步复制存储帐户。
function beginCustomerInitiatedMigration(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- StorageAccountMigration
执行存储帐户迁移所需的请求参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginCustomerInitiatedMigrationAndWait(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)
可以为存储帐户触发帐户迁移请求，以更改其冗余级别。 迁移会将非区域冗余存储帐户更新为区域性冗余帐户，反之亦然，以便提供更好的可靠性和可用性。 区域冗余存储 (ZRS) 在主要区域中的三个 Azure 可用性区域同步复制存储帐户。
function beginCustomerInitiatedMigrationAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- StorageAccountMigration
执行存储帐户迁移所需的请求参数。
选项参数。
返回
Promise<void>
beginFailover(string, string, StorageAccountsFailoverOptionalParams)
如果主终结点因任何原因而不可用，则可以为存储帐户触发故障转移请求。 对于 RA-GRS 帐户，从存储帐户的主群集故障转移到辅助群集。 故障转移后，辅助群集将成为主群集，帐户将转换为 LRS。 对于计划内故障转移，主群集和辅助群集在故障转移后交换，帐户将保持异地复制状态。 在出现可用性问题时，应继续使用故障转移，因为计划内故障转移仅在主终结点和辅助终结点可用时可用。 计划内故障转移的主要用例是灾难恢复测试演练。 通过将 FailoverType 参数设置为“Planned”来调用此类型的故障转移。 在此处详细了解故障转移选项- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
function beginFailover(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFailoverAndWait(string, string, StorageAccountsFailoverOptionalParams)
如果主终结点因任何原因而不可用，则可以为存储帐户触发故障转移请求。 对于 RA-GRS 帐户，从存储帐户的主群集故障转移到辅助群集。 故障转移后，辅助群集将成为主群集，帐户将转换为 LRS。 对于计划内故障转移，主群集和辅助群集在故障转移后交换，帐户将保持异地复制状态。 在出现可用性问题时，应继续使用故障转移，因为计划内故障转移仅在主终结点和辅助终结点可用时可用。 计划内故障转移的主要用例是灾难恢复测试演练。 通过将 FailoverType 参数设置为“Planned”来调用此类型的故障转移。 在此处详细了解故障转移选项- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
function beginFailoverAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<void>
beginHierarchicalNamespaceMigration(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)
存储帐户的实时迁移以启用 Hns
function beginHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- requestType
-
string
必需。 分层命名空间迁移类型可以是分层命名空间验证请求“HnsOnValidationRequest”或水化请求“HnsOnHydrationRequest”。 验证请求将验证迁移，而混合请求将迁移帐户。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginHierarchicalNamespaceMigrationAndWait(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)
存储帐户的实时迁移以启用 Hns
function beginHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- requestType
-
string
必需。 分层命名空间迁移类型可以是分层命名空间验证请求“HnsOnValidationRequest”或冻结请求“HnsOnHydrationRequest”。 验证请求将验证迁移，而解除冻结请求将迁移帐户。
返回
Promise<void>
beginRestoreBlobRanges(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)
还原指定 Blob 范围内的 Blob
function beginRestoreBlobRanges(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- BlobRestoreParameters
要为还原 Blob 范围提供的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>
beginRestoreBlobRangesAndWait(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)
还原指定 Blob 范围内的 Blob
function beginRestoreBlobRangesAndWait(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<BlobRestoreStatus>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- BlobRestoreParameters
要为还原 Blob 范围提供的参数。
选项参数。
返回
Promise<BlobRestoreStatus>
checkNameAvailability(StorageAccountCheckNameAvailabilityParameters, StorageAccountsCheckNameAvailabilityOptionalParams)
检查存储帐户名称是否有效且尚未使用。
function checkNameAvailability(accountName: StorageAccountCheckNameAvailabilityParameters, options?: StorageAccountsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>参数
- accountName
- StorageAccountCheckNameAvailabilityParameters
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<CheckNameAvailabilityResult>
delete(string, string, StorageAccountsDeleteOptionalParams)
删除 Microsoft Azure 中的存储帐户。
function delete(resourceGroupName: string, accountName: string, options?: StorageAccountsDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<void>
getCustomerInitiatedMigration(string, string, string, StorageAccountsGetCustomerInitiatedMigrationOptionalParams)
获取指定存储帐户的正在进行的迁移状态。
function getCustomerInitiatedMigration(resourceGroupName: string, accountName: string, migrationName: string, options?: StorageAccountsGetCustomerInitiatedMigrationOptionalParams): Promise<StorageAccountMigration>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- migrationName
-
string
存储帐户迁移的名称。 它应始终为“default”
返回
Promise<StorageAccountMigration>
getProperties(string, string, StorageAccountsGetPropertiesOptionalParams)
返回指定存储帐户的属性，包括但不限于名称、SKU 名称、位置和帐户状态。 应使用 ListKeys 操作来检索存储密钥。
function getProperties(resourceGroupName: string, accountName: string, options?: StorageAccountsGetPropertiesOptionalParams): Promise<StorageAccount>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<StorageAccount>
list(StorageAccountsListOptionalParams)
列出订阅下可用的所有存储帐户。 请注意，不会返回存储密钥;为此，请使用 ListKeys 操作。
function list(options?: StorageAccountsListOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>参数
选项参数。
返回
listAccountSAS(string, string, AccountSasParameters, StorageAccountsListAccountSASOptionalParams)
列出存储帐户的 SAS 凭据。
function listAccountSAS(resourceGroupName: string, accountName: string, parameters: AccountSasParameters, options?: StorageAccountsListAccountSASOptionalParams): Promise<ListAccountSasResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- AccountSasParameters
要提供的用于列出存储帐户的 SAS 凭据的参数。
选项参数。
返回
Promise<ListAccountSasResponse>
listByResourceGroup(string, StorageAccountsListByResourceGroupOptionalParams)
列出给定资源组下可用的所有存储帐户。 请注意，不会返回存储密钥;为此，请使用 ListKeys 操作。
function listByResourceGroup(resourceGroupName: string, options?: StorageAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
选项参数。
返回
listKeys(string, string, StorageAccountsListKeysOptionalParams)
列出访问密钥或 Kerberos 密钥（如果为指定的存储帐户启用了 active directory) (）。
function listKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsListKeysOptionalParams): Promise<StorageAccountListKeysResult>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<StorageAccountListKeysResult>
listServiceSAS(string, string, ServiceSasParameters, StorageAccountsListServiceSASOptionalParams)
列出特定资源的服务 SAS 凭据。
function listServiceSAS(resourceGroupName: string, accountName: string, parameters: ServiceSasParameters, options?: StorageAccountsListServiceSASOptionalParams): Promise<ListServiceSasResponse>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- ServiceSasParameters
用于列出服务 SAS 凭据的参数。
选项参数。
返回
Promise<ListServiceSasResponse>
regenerateKey(string, string, StorageAccountRegenerateKeyParameters, StorageAccountsRegenerateKeyOptionalParams)
为指定的存储帐户重新生成访问密钥或 Kerberos 密钥之一。
function regenerateKey(resourceGroupName: string, accountName: string, regenerateKey: StorageAccountRegenerateKeyParameters, options?: StorageAccountsRegenerateKeyOptionalParams): Promise<StorageAccountListKeysResult>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- regenerateKey
- StorageAccountRegenerateKeyParameters
指定应重新生成的密钥的名称 -- key1、key2、kerb1、kerb2。
选项参数。
返回
Promise<StorageAccountListKeysResult>
revokeUserDelegationKeys(string, string, StorageAccountsRevokeUserDelegationKeysOptionalParams)
撤销用户委派密钥。
function revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsRevokeUserDelegationKeysOptionalParams): Promise<void>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
选项参数。
返回
Promise<void>
update(string, string, StorageAccountUpdateParameters, StorageAccountsUpdateOptionalParams)
更新操作可用于更新存储帐户的 SKU、加密、访问层或标记。 它还可用于将帐户映射到自定义域。 每个存储帐户仅支持一个自定义域;不支持替换/更改自定义域。 若要替换旧的自定义域，必须先清除/取消注册旧值，然后才能设置新值。 支持更新多个属性。 此调用不会更改帐户的存储密钥。 如果要更改存储帐户密钥，请使用重新生成密钥操作。 创建后无法更改存储帐户的位置和名称。
function update(resourceGroupName: string, accountName: string, parameters: StorageAccountUpdateParameters, options?: StorageAccountsUpdateOptionalParams): Promise<StorageAccount>参数
- resourceGroupName
-
string
用户订阅中的资源组的名称。 此名称不区分大小写。
- accountName
-
string
指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符，并且只能使用数字和小写字母。
- parameters
- StorageAccountUpdateParameters
要为更新的帐户提供的参数。
选项参数。
返回
Promise<StorageAccount>