你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

StorageAccountsOperations 类

警告

请勿直接实例化此类。

相反,应通过以下方式访问以下操作:

StorageManagementClient

<xref:storage_accounts> 属性。

继承
builtins.object
StorageAccountsOperations

构造函数

StorageAccountsOperations(*args, **kwargs)

方法

begin_abort_hierarchical_namespace_migration

中止存储帐户的实时迁移以启用 Hns。

begin_create

使用指定的参数异步创建一个新的存储帐户。 如果已创建帐户并发出具有不同属性的后续创建请求,则会更新帐户属性。 如果已创建帐户,并且发出具有完全相同的属性集的后续创建或更新请求,则请求将成功。

begin_failover

如果主终结点因任何原因不可用,则可以为存储帐户触发故障转移请求。 从存储帐户的主群集故障转移到 RA-GRS 帐户的辅助群集。 故障转移后,辅助群集将成为主群集,并且帐户将转换为 LRS。 对于计划内故障转移,主群集和辅助群集在故障转移后交换,帐户保持异地复制状态。 在出现可用性问题时,应继续使用故障转移,因为计划内故障转移仅在主终结点和辅助终结点可用时可用。 计划内故障转移的主要用例是灾难恢复测试演练。 通过将 FailoverType 参数设置为“Planned”来调用此类型的故障转移。 在此处详细了解故障转移选项 - https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance

begin_hierarchical_namespace_migration

存储帐户的实时迁移以启用 Hns。

begin_restore_blob_ranges

还原指定 Blob 范围内的 Blob。

check_name_availability

检查存储帐户名称是否有效且尚未使用。

delete

删除 Microsoft Azure 中的存储帐户。

get_properties

返回指定存储帐户的属性,包括但不限于名称、SKU 名称、位置和帐户状态。 应使用 ListKeys 操作来检索存储密钥。

list

列出订阅下可用的所有存储帐户。 请注意,不会返回存储密钥;为此,请使用 ListKeys 操作。

list_account_sas

列出存储帐户的 SAS 凭据。

list_by_resource_group

列出给定资源组下可用的所有存储帐户。 请注意,不会返回存储密钥;为此,请使用 ListKeys 操作。

list_keys

列出访问密钥或 Kerberos 密钥(如果为指定的存储帐户启用了 active directory) ()。

list_service_sas

列出特定资源的服务 SAS 凭据。

regenerate_key

为指定的存储帐户重新生成访问密钥或 Kerberos 密钥之一。

revoke_user_delegation_keys

撤销用户委派密钥。

update

更新操作可用于更新存储帐户的 SKU、加密、访问层或标记。 它还可用于将帐户映射到自定义域。 每个存储帐户仅支持一个自定义域;不支持替换/更改自定义域。 若要替换旧的自定义域,必须先清除/取消注册旧值,然后才能设置新值。 支持更新多个属性。 此调用不会更改帐户的存储密钥。 如果要更改存储帐户密钥,请使用重新生成密钥操作。 创建后无法更改存储帐户的位置和名称。

begin_abort_hierarchical_namespace_migration

中止存储帐户的实时迁移以启用 Hns。

begin_abort_hierarchical_namespace_migration(resource_group_name: str, account_name: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

cls
callable

将传递直接响应的自定义类型或函数

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例,返回 None 或 cls 的结果 (响应)

返回类型

例外

begin_create

使用指定的参数异步创建一个新的存储帐户。 如果已创建帐户并发出具有不同属性的后续创建请求,则会更新帐户属性。 如果已创建帐户,并且发出具有完全相同的属性集的后续创建或更新请求,则请求将成功。

begin_create(resource_group_name: str, account_name: str, parameters: _models.StorageAccountCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.StorageAccount]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

parameters
StorageAccountCreateParametersIO
必需

要为创建的帐户提供的参数。 是 StorageAccountCreateParameters 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例,返回 StorageAccount 或 cls (响应)

返回类型

例外

begin_failover

如果主终结点因任何原因不可用,则可以为存储帐户触发故障转移请求。 从存储帐户的主群集故障转移到 RA-GRS 帐户的辅助群集。 故障转移后,辅助群集将成为主群集,并且帐户将转换为 LRS。 对于计划内故障转移,主群集和辅助群集在故障转移后交换,帐户保持异地复制状态。 在出现可用性问题时,应继续使用故障转移,因为计划内故障转移仅在主终结点和辅助终结点可用时可用。 计划内故障转移的主要用例是灾难恢复测试演练。 通过将 FailoverType 参数设置为“Planned”来调用此类型的故障转移。 在此处详细了解故障转移选项 - https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance

begin_failover(resource_group_name: str, account_name: str, failover_type: Literal['Planned'] = 'Planned', **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

failover_type
str
必需

参数设置为“计划”以指示是否请求计划的故障转移。 已知值为“计划”和“无”。 默认值为“Planned”。

cls
callable

将传递直接响应的自定义类型或函数

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例,返回 None 或 cls 的结果 (响应)

返回类型

例外

begin_hierarchical_namespace_migration

存储帐户的实时迁移以启用 Hns。

begin_hierarchical_namespace_migration(resource_group_name: str, account_name: str, request_type: str, **kwargs: Any) -> LROPoller[None]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

request_type
str
必需

必需。 分层命名空间迁移类型可以是分层命名空间验证请求“HnsOnValidationRequest”或冻结请求“HnsOnHydrationRequest”。 验证请求将验证迁移,而解除冻结请求将迁移帐户。 必需。

cls
callable

将传递直接响应的自定义类型或函数

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例,返回 None 或 cls 的结果 (响应)

返回类型

例外

begin_restore_blob_ranges

还原指定 Blob 范围内的 Blob。

begin_restore_blob_ranges(resource_group_name: str, account_name: str, parameters: _models.BlobRestoreParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.BlobRestoreStatus]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

parameters
BlobRestoreParametersIO
必需

要为还原 Blob 范围提供的参数。 是 BlobRestoreParameters 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

continuation_token
str

用于从保存状态重启轮询的延续标记。

polling
boolPollingMethod

默认情况下,轮询方法将为 ARMPolling。 如果此操作不轮询,则传入 False,或者为个人轮询策略传入你自己的初始化轮询对象。

polling_interval
int

如果没有 Retry-After 标头,则 LRO 操作的两次轮询之间的默认等待时间。

返回

LROPoller 的实例,返回 BlobRestoreStatus 或 cls 的结果 (响应)

返回类型

例外

check_name_availability

检查存储帐户名称是否有效且尚未使用。

check_name_availability(account_name: _models.StorageAccountCheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityResult

参数

account_name
StorageAccountCheckNameAvailabilityParametersIO
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 是 StorageAccountCheckNameAvailabilityParameters 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

CheckNameAvailabilityResult 或 cls 的结果 (响应)

返回类型

例外

delete

删除 Microsoft Azure 中的存储帐户。

delete(resource_group_name: str, account_name: str, **kwargs: Any) -> None

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

无响应或 cls 的结果 (响应)

返回类型

例外

get_properties

返回指定存储帐户的属性,包括但不限于名称、SKU 名称、位置和帐户状态。 应使用 ListKeys 操作来检索存储密钥。

get_properties(resource_group_name: str, account_name: str, expand: str | StorageAccountExpand | None = None, **kwargs: Any) -> StorageAccount

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

expand
strStorageAccountExpand
必需

可用于扩展帐户属性中的属性。 默认情况下,提取属性时不包括数据。 目前,我们仅支持 geoReplicationStats 和 blobRestoreStatus。 已知值为:“geoReplicationStats”和“blobRestoreStatus”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageAccount 或 cls 的结果 (响应)

返回类型

例外

list

列出订阅下可用的所有存储帐户。 请注意,不会返回存储密钥;为此,请使用 ListKeys 操作。

list(**kwargs: Any) -> Iterable[StorageAccount]

参数

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器,如 StorageAccount 的实例或 cls 的结果 (响应)

返回类型

例外

list_account_sas

列出存储帐户的 SAS 凭据。

list_account_sas(resource_group_name: str, account_name: str, parameters: _models.AccountSasParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ListAccountSasResponse

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

parameters
AccountSasParametersIO
必需

要提供的用于列出存储帐户的 SAS 凭据的参数。 是 AccountSasParameters 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

ListAccountSasResponse 或 cls 的结果 (响应)

返回类型

例外

list_by_resource_group

列出给定资源组下可用的所有存储帐户。 请注意,不会返回存储密钥;为此,请使用 ListKeys 操作。

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[StorageAccount]

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

一个迭代器,如 StorageAccount 的实例或 cls 的结果 (响应)

返回类型

例外

list_keys

列出访问密钥或 Kerberos 密钥(如果为指定的存储帐户启用了 active directory) ()。

list_keys(resource_group_name: str, account_name: str, expand: Literal['kerb'] = 'kerb', **kwargs: Any) -> StorageAccountListKeysResult

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

expand
str
必需

指定要列出的密钥的类型。 可能的值为 kerb。 已知值为“kerb”和“None”。 默认值为“kerb”。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageAccountListKeysResult 或 cls 的结果 (响应)

返回类型

例外

list_service_sas

列出特定资源的服务 SAS 凭据。

list_service_sas(resource_group_name: str, account_name: str, parameters: _models.ServiceSasParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ListServiceSasResponse

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

parameters
ServiceSasParametersIO
必需

用于列出服务 SAS 凭据的参数。 是 ServiceSasParameters 类型还是 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

ListServiceSasResponse 或 cls 的结果 (响应)

返回类型

例外

regenerate_key

为指定的存储帐户重新生成访问密钥或 Kerberos 密钥之一。

regenerate_key(resource_group_name: str, account_name: str, regenerate_key: _models.StorageAccountRegenerateKeyParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageAccountListKeysResult

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

regenerate_key
StorageAccountRegenerateKeyParametersIO
必需

指定应重新生成的密钥的名称 - key1、key2、kerb1、kerb2。 是 StorageAccountRegenerateKeyParameters 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageAccountListKeysResult 或 cls 的结果 (响应)

返回类型

例外

revoke_user_delegation_keys

撤销用户委派密钥。

revoke_user_delegation_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> None

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

cls
callable

将传递直接响应的自定义类型或函数

返回

无响应或 cls 的结果 (响应)

返回类型

例外

update

更新操作可用于更新存储帐户的 SKU、加密、访问层或标记。 它还可用于将帐户映射到自定义域。 每个存储帐户仅支持一个自定义域;不支持替换/更改自定义域。 若要替换旧的自定义域,必须先清除/取消注册旧值,然后才能设置新值。 支持更新多个属性。 此调用不会更改帐户的存储密钥。 如果要更改存储帐户密钥,请使用重新生成密钥操作。 创建后无法更改存储帐户的位置和名称。

update(resource_group_name: str, account_name: str, parameters: _models.StorageAccountUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageAccount

参数

resource_group_name
str
必需

用户订阅中的资源组的名称。 此名称不区分大小写。 必需。

account_name
str
必需

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。 必需。

parameters
StorageAccountUpdateParametersIO
必需

要为更新的帐户提供的参数。 是 StorageAccountUpdateParameters 类型或 IO 类型。 必需。

content_type
str

正文参数内容类型。 已知值为:“application/json”。 默认值为 None。

cls
callable

将传递直接响应的自定义类型或函数

返回

StorageAccount 或 cls 的结果 (响应)

返回类型

例外

属性

models

models = <module 'azure.mgmt.storage.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2022_09_01\\models\\__init__.py'>