BlobContainersOperations Класс

Предупреждение

НЕ следует создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

StorageManagementClient's

атрибут<xref:blob_containers> .

Наследование

builtins.object

BlobContainersOperations

Конструктор

BlobContainersOperations(*args, **kwargs)

Методы

clear_legal_hold	Очищает юридические теги удержания. Удаление того же или несуществующего тега приводит к идемпотентной операции. ClearLegalHold очищает только указанные теги в запросе.
create	Создает новый контейнер в указанной учетной записи, как описано в тексте запроса. Ресурс контейнера содержит метаданные и свойства для данного контейнера. Ресурс не включает список больших двоичных объектов, которые содержит контейнер.
create_or_update_immutability_policy	Создает или обновляет разблокированную политику неизменяемости. ETag в If-Match учитывается, если он задан, но не требуется для этой операции.
delete	Удаляет указанный контейнер из своей учетной записи.
delete_immutability_policy	Отменяет разблокированную политику неизменяемости. В ответе на удаление для параметра immutabilityPeriodSinceCreationInDays задано значение 0. Для этой операции требуется ETag в If-Match. Удаление заблокированной политики неизменяемости запрещено. Единственный способ — удалить контейнер после удаления всех просроченных BLOB-объектов в контейнере, заблокированном политикой.
extend_immutability_policy	Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной неизменяемостиPolicy. Единственное действие, разрешенное для заблокированной политики, — это действие. Для этой операции требуется ETag в If-Match.
get	Возвращает свойства указанного контейнера.
get_immutability_policy	Возвращает существующую политику неизменности вместе с соответствующим ETag в заголовках и тексте ответа.
lease	Операция аренды контейнера устанавливает блокировку контейнера для операций удаления и управляет им. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.
list	Выводит список всех контейнеров и не поддерживает префикс, например плоскость данных. Кроме того, сегодня SRP не возвращает маркер продолжения.
lock_immutability_policy	Устанавливает для параметра ImmutabilityPolicy значение Заблокировано. Единственным действием, разрешенным для заблокированной политики, является действие ExtendImmutabilityPolicy. Для этой операции требуется ETag в If-Match.
set_legal_hold	Задает теги удержания по юридическим причинам. Установка того же тега приводит к идемпотентной операции. SetLegalHold следует шаблону добавления и не очищает существующие теги, которые не указаны в запросе.
update	Обновления свойства контейнера, как указано в тексте запроса. Свойства, не указанные в запросе, останутся неизменными. Обновление завершается ошибкой, если указанный контейнер еще не существует.

clear_legal_hold

Очищает юридические теги удержания. Удаление того же или несуществующего тега приводит к идемпотентной операции. ClearLegalHold очищает только указанные теги в запросе.

async 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

Обязательно

Свойство LegalHold, которое будет удалено из контейнера BLOB-объектов. Тип LegalHold или тип ввода-вывода. Обязательный.

content_type

str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

LegalHold или результат cls(response)

Возвращаемый тип

LegalHold

Исключения

HttpResponseError

create

Создает новый контейнер в указанной учетной записи, как описано в тексте запроса. Ресурс контейнера содержит метаданные и свойства для данного контейнера. Ресурс не включает список больших двоичных объектов, которые содержит контейнер.

async 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 или тип ввода-вывода. Обязательный.

content_type

str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

BlobContainer или результат cls(response)

Возвращаемый тип

BlobContainer

Исключения

HttpResponseError

create_or_update_immutability_policy

Создает или обновляет разблокированную политику неизменяемости. ETag в If-Match учитывается, если он задан, но не требуется для этой операции.

async create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | _models.Enum31, 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 или Enum31

Обязательно

Имя контейнера больших двоичных объектов immutabilityPolicy в указанной учетной записи хранения. ImmutabilityPolicy Name должно иметь значение default. "default" Обязательный.

if_match

str

Обязательно

Версия состояния сущности (ETag) политики неизменяемости для обновления. Значение "*" можно использовать для применения операции, только если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда. Значение по умолчанию —Нет.

parameters

ImmutabilityPolicy или IO

Обязательно

Свойства ImmutabilityPolicy, которые будут созданы или обновлены для контейнера BLOB-объектов. Тип ImmutabilityPolicy или тип ввода-вывода. Значение по умолчанию —Нет.

content_type

str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

ImmutabilityPolicy или результат cls(response)

Возвращаемый тип

ImmutabilityPolicy

Исключения

HttpResponseError

delete

Удаляет указанный контейнер из своей учетной записи.

async 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

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

None

Исключения

HttpResponseError

delete_immutability_policy

Отменяет разблокированную политику неизменяемости. В ответе на удаление для параметра immutabilityPeriodSinceCreationInDays задано значение 0. Для этой операции требуется ETag в If-Match. Удаление заблокированной политики неизменяемости запрещено. Единственный способ — удалить контейнер после удаления всех просроченных BLOB-объектов в контейнере, заблокированном политикой.

async delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum31, 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 или Enum31

Обязательно

Имя контейнера больших двоичных объектов immutabilityPolicy в указанной учетной записи хранения. ImmutabilityPolicy Name должно быть "default". "default" — обязательный аргумент.

if_match

str

Обязательно

Версия состояния сущности (ETag) обновляемой политики неизменяемости. Значение "*" можно использовать для применения операции только в том случае, если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда. Обязательный.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

ImmutabilityPolicy или результат cls(response)

Возвращаемый тип

ImmutabilityPolicy

Исключения

HttpResponseError

extend_immutability_policy

Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной неизменяемостиPolicy. Единственное действие, разрешенное для заблокированной политики, — это действие. Для этой операции требуется ETag в If-Match.

async 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

Обязательно

Свойства ImmutabilityPolicy, которые будут расширены для контейнера BLOB-объектов. Тип ImmutabilityPolicy или тип ввода-вывода. Значение по умолчанию —Нет.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

ImmutabilityPolicy или результат cls(response)

Возвращаемый тип

ImmutabilityPolicy

Исключения

HttpResponseError

get

Возвращает свойства указанного контейнера.

async 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(response)

Возвращаемый тип

BlobContainer

Исключения

HttpResponseError

get_immutability_policy

Возвращает существующую политику неизменности вместе с соответствующим ETag в заголовках и тексте ответа.

async get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum31, 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 или Enum31

Обязательно

Имя контейнера больших двоичных объектов immutabilityPolicy в указанной учетной записи хранения. ImmutabilityPolicy Name должно быть "default". "default" — обязательный аргумент.

if_match

str

Обязательно

Версия состояния сущности (ETag) обновляемой политики неизменяемости. Значение "*" можно использовать для применения операции только в том случае, если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда. Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

ImmutabilityPolicy или результат cls(response)

Возвращаемый тип

ImmutabilityPolicy

Исключения

HttpResponseError

lease

Операция аренды контейнера устанавливает блокировку контейнера для операций удаления и управляет им. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.

async 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 или тип ввода-вывода. Значение по умолчанию —Нет.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

LeaseContainerResponse или результат cls(response)

Возвращаемый тип

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) -> AsyncIterable[ListContainerItem]

Параметры

resource_group_name

str

Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name

str

Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

maxpagesize

str

Обязательно

Необязательный элемент. Указано максимальное количество контейнеров, которые могут быть включены в список. Значение по умолчанию —Нет.

filter

str

Обязательно

Необязательный элемент. Если этот параметр указан, в списке будут перечислены только имена контейнеров, начинающиеся с фильтра. Значение по умолчанию —Нет.

include

str или ListContainersInclude

Обязательно

Необязательный параметр, используемый для включения свойств контейнеров обратимо удаленных BLOB-объектов. "deleted" Значение по умолчанию — None.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

Итератор, например экземпляр ListContainerItem или результат cls(response)

Возвращаемый тип

AsyncItemPaged[ListContainerItem]

Исключения

HttpResponseError

lock_immutability_policy

Устанавливает для параметра ImmutabilityPolicy значение Заблокировано. Единственным действием, разрешенным для заблокированной политики, является действие ExtendImmutabilityPolicy. Для этой операции требуется ETag в If-Match.

async 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(response)

Возвращаемый тип

ImmutabilityPolicy

Исключения

HttpResponseError

set_legal_hold

Задает теги удержания по юридическим причинам. Установка того же тега приводит к идемпотентной операции. SetLegalHold следует шаблону добавления и не очищает существующие теги, которые не указаны в запросе.

async 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

Обязательно

Свойство LegalHold, которое будет присвоено контейнеру BLOB-объектов. Тип LegalHold или тип ввода-вывода. Обязательный.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

LegalHold или результат cls(response)

Возвращаемый тип

LegalHold

Исключения

HttpResponseError

update

Обновления свойства контейнера, как указано в тексте запроса. Свойства, не указанные в запросе, останутся неизменными. Обновление завершается ошибкой, если указанный контейнер еще не существует.

async 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 или тип ввода-вывода. Обязательный.

content_type

str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls

callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

BlobContainer или результат cls(response)

Возвращаемый тип

BlobContainer

Исключения

HttpResponseError

Атрибуты

models

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