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

BlobContainersOperations 类

警告

请勿直接实例化此类。

相反，应通过以下方式访问以下操作：

StorageManagementClient's

<xref:blob_containers> 属性。

继承

builtins.object

BlobContainersOperations

构造函数

BlobContainersOperations(*args, **kwargs)

方法

clear_legal_hold	清除法定保留标记。 清除相同或不存在的标记会导致幂等操作。 ClearLegalHold 仅清除请求中的指定标记。
create	根据请求正文所述，在指定的帐户下创建新容器。 容器资源包括容器的元数据和属性。 不包括容器所包含的 Blob 的列表。
create_or_update_immutability_policy	创建或更新未锁定的不可变性策略。 如果给定但不是此操作所必需的，则遵循 If-Match 中的 ETag。
delete	删除其帐户下的指定容器。
delete_immutability_policy	中止未锁定的不可变性策略。 delete 的响应将不可变性PeriodSinceCreationInDays 设置为 0。 此操作需要 If-Match 中的 ETag。 不允许删除锁定的不可变性策略，唯一的方法是删除策略锁定容器内所有过期的 Blob 后删除该容器。
extend_immutability_policy	扩展锁定的 immutabilityPolicy 的 immutabilityPeriodSinceCreationInDays。 锁定策略上允许的唯一操作是此操作。 此操作需要 If-Match 中的 ETag。
get	获取指定容器的属性。
get_immutability_policy	获取现有的不可变性策略以及响应标头和正文中的相应 ETag。
lease	租约容器操作建立和管理容器上的锁，以便执行删除操作。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。
list	列出所有容器，不支持数据平面等前缀。 此外，SRP 现在不返回继续标记。
lock_immutability_policy	将 ImmutabilityPolicy 设置为“锁定”状态。 锁定策略上允许的唯一操作是 ExtendImmutabilityPolicy 操作。 此操作需要 If-Match 中的 ETag。
set_legal_hold	设置法定保留标记。 设置相同的标记会导致幂等操作。 SetLegalHold 遵循追加模式，不会清除请求中未指定的现有标记。
update	汇报请求正文中指定的容器属性。 请求中未提及的属性将保持不变。 如果指定的容器尚不存在，更新将失败。

clear_legal_hold

清除法定保留标记。 清除相同或不存在的标记会导致幂等操作。 ClearLegalHold 仅清除请求中的指定标记。

clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

legal_hold

LegalHold 或 IO

必需

将从 Blob 容器中清除的 LegalHold 属性。 是 LegalHold 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

LegalHold 或 cls 的结果 (响应)

返回类型

LegalHold

例外

HttpResponseError

create

根据请求正文所述，在指定的帐户下创建新容器。 容器资源包括容器的元数据和属性。 不包括容器所包含的 Blob 的列表。

create(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

blob_container

BlobContainer 或 IO

必需

要创建的 Blob 容器的属性。 是 BlobContainer 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

BlobContainer 或 cls 的结果 (响应)

返回类型

BlobContainer

例外

HttpResponseError

create_or_update_immutability_policy

创建或更新未锁定的不可变性策略。 如果给定但不是此操作所必需的，则遵循 If-Match 中的 ETag。

create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | _models.Enum28, if_match: str | None = None, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

immutability_policy_name

str 或 Enum28

必需

指定存储帐户中 Blob 容器 immutabilityPolicy 的名称。 ImmutabilityPolicy 名称必须为“default”。 “default”必需。

if_match

str

必需

实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。 默认值为 None。

parameters

ImmutabilityPolicy 或 IO

必需

将创建或更新到 Blob 容器的 ImmutabilityPolicy 属性。 是 ImmutabilityPolicy 类型或 IO 类型。 默认值为 None。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

ImmutabilityPolicy 或 cls 的结果 (响应)

返回类型

ImmutabilityPolicy

例外

HttpResponseError

delete

删除其帐户下的指定容器。

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

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

cls

callable

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

返回

无或 cls 的结果 (响应)

返回类型

None

例外

HttpResponseError

delete_immutability_policy

中止未锁定的不可变性策略。 delete 的响应将不可变性PeriodSinceCreationInDays 设置为 0。 此操作需要 If-Match 中的 ETag。 不允许删除锁定的不可变性策略，唯一的方法是删除策略锁定容器内所有过期的 Blob 后删除该容器。

delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum28, if_match: str, **kwargs: Any) -> ImmutabilityPolicy

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

immutability_policy_name

str 或 Enum28

必需

指定存储帐户中 Blob 容器 immutabilityPolicy 的名称。 ImmutabilityPolicy 名称必须为“default”。 “default”必需。

if_match

str

必需

实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。 必需。

cls

callable

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

返回

ImmutabilityPolicy 或 cls 的结果 (响应)

返回类型

ImmutabilityPolicy

例外

HttpResponseError

extend_immutability_policy

扩展锁定的 immutabilityPolicy 的 immutabilityPeriodSinceCreationInDays。 锁定策略上允许的唯一操作是此操作。 此操作需要 If-Match 中的 ETag。

extend_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

if_match

str

必需

实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。 必需。

parameters

ImmutabilityPolicy 或 IO

必需

将为 Blob 容器扩展的 ImmutabilityPolicy 属性。 是 ImmutabilityPolicy 类型或 IO 类型。 默认值为 None。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

ImmutabilityPolicy 或 cls 的结果 (响应)

返回类型

ImmutabilityPolicy

例外

HttpResponseError

get

获取指定容器的属性。

get(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> BlobContainer

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

cls

callable

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

返回

BlobContainer 或 cls 的结果 (响应)

返回类型

BlobContainer

例外

HttpResponseError

get_immutability_policy

获取现有的不可变性策略以及响应标头和正文中的相应 ETag。

get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum28, if_match: str | None = None, **kwargs: Any) -> ImmutabilityPolicy

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

immutability_policy_name

str 或 Enum28

必需

指定存储帐户中 Blob 容器 immutabilityPolicy 的名称。 ImmutabilityPolicy 名称必须为“default”。 “default”必需。

if_match

str

必需

实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。 默认值为 None。

cls

callable

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

返回

ImmutabilityPolicy 或 cls 的结果 (响应)

返回类型

ImmutabilityPolicy

例外

HttpResponseError

lease

租约容器操作建立和管理容器上的锁，以便执行删除操作。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。

lease(resource_group_name: str, account_name: str, container_name: str, parameters: _models.LeaseContainerRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseContainerResponse

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

parameters

LeaseContainerRequest 或 IO

必需

租用容器请求正文。 是 LeaseContainerRequest 类型或 IO 类型。 默认值为 None。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

LeaseContainerResponse 或 cls 的结果 (响应)

返回类型

LeaseContainerResponse

例外

HttpResponseError

list

列出所有容器，不支持数据平面等前缀。 此外，SRP 现在不返回继续标记。

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, include: str | ListContainersInclude | None = None, **kwargs: Any) -> Iterable[ListContainerItem]

参数

resource_group_name

str

必需

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

account_name

str

必需

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

maxpagesize

str

必需

可选。 指定列表中可包含的最大容器数。 默认值为 None。

filter

str

必需

可选。 指定后，仅列出以筛选器开头的容器名称。 默认值为 None。

include

str 或 ListContainersInclude

必需

可选，用于包含软删除的 Blob 容器的属性。 “deleted”默认值为 None。

cls

callable

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

返回

迭代器，如 ListContainerItem 的实例或 cls 的结果 (响应)

返回类型

ItemPaged[ListContainerItem]

例外

HttpResponseError

lock_immutability_policy

将 ImmutabilityPolicy 设置为“锁定”状态。 锁定策略上允许的唯一操作是 ExtendImmutabilityPolicy 操作。 此操作需要 If-Match 中的 ETag。

lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) -> ImmutabilityPolicy

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

if_match

str

必需

实体状态 (ETag) 要更新的不可变性策略版本。 仅当不可变性策略已存在时，值“*”才可用于应用操作。 如果省略，将始终应用此操作。 必需。

cls

callable

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

返回

ImmutabilityPolicy 或 cls 的结果 (响应)

返回类型

ImmutabilityPolicy

例外

HttpResponseError

set_legal_hold

设置法定保留标记。 设置相同的标记会导致幂等操作。 SetLegalHold 遵循追加模式，不会清除请求中未指定的现有标记。

set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

legal_hold

LegalHold 或 IO

必需

将设置为 Blob 容器的 LegalHold 属性。 是 LegalHold 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

LegalHold 或 cls 的结果 (响应)

返回类型

LegalHold

例外

HttpResponseError

update

汇报请求正文中指定的容器属性。 请求中未提及的属性将保持不变。 如果指定的容器尚不存在，更新将失败。

update(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer

参数

resource_group_name

str

必需

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

account_name

str

必需

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

container_name

str

必需

指定存储帐户中 Blob 容器的名称。 Blob 容器名称的长度必须介于 3 到 63 个字符之间，并且仅使用数字、小写字母和短划线 ( ) 。 每个短划线（-）字符的前后必须紧跟字母或数字。 必需。

blob_container

BlobContainer 或 IO

必需

要更新的 Blob 容器的属性。 是 BlobContainer 类型或 IO 类型。 必需。

content_type

str

Body 参数内容类型。 已知值为：“application/json”。 默认值为 None。

cls

callable

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

返回

BlobContainer 或 cls 的结果 (响应)

返回类型

BlobContainer

例外

HttpResponseError

属性

models

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