ContainerClient Класс

Ссылка

Клиент для взаимодействия с определенным контейнером, хотя этот контейнер может еще не существовать.

Для операций, связанных с определенным большим двоичным объектом в этом контейнере, клиент BLOB-объекта можно получить с помощью get_blob_client функции .

Дополнительные сведения о настройке см. здесь.

Наследование: azure.storage.blob._shared.base_client.StorageAccountHostsMixin

ContainerClient

azure.storage.blob._encryption.StorageEncryptionMixin

ContainerClient

Конструктор

ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Параметры

account_url: str

Обязательно

Универсальный код ресурса (URI) учетной записи хранения. Чтобы создать клиент с полным универсальным кодом ресурса (URI) для контейнера, используйте from_container_url классmethod.

container_name: str

Обязательно

Имя контейнера для большого двоичного объекта.

credential

значение по умолчанию: None

Учетные данные, с помощью которых выполняется проверка подлинности. Это необязательно, если URL-адрес учетной записи уже содержит маркер SAS. Значением может быть строка маркера SAS, экземпляр AzureSasCredential или AzureNamedKeyCredential из azure.core.credentials, общий ключ доступа учетной записи или экземпляр класса TokenCredentials из azure.identity. Если URI ресурса уже содержит маркер SAS, он будет игнорироваться в пользу явных учетных данных.

за исключением случаев AzureSasCredential, где конфликтующие маркеры SAS вызовет ValueError. При использовании экземпляра AzureNamedKeyCredential "имя" должно быть именем учетной записи хранения, а "ключ" — ключом учетной записи хранения.

api_version: str

Версия API хранилища, используемая для запросов. Значение по умолчанию — последняя версия службы, совместимая с текущим пакетом SDK. Установка более старой версии может привести к снижению совместимости функций.

Новые возможности в версии 12.2.0.

secondary_hostname: str

Имя узла вторичной конечной точки.

max_block_size: int

Максимальный размер блока для отправки блочного BLOB-объекта блоками. Значение по умолчанию — 4*1024*1024 или 4 МБ.

max_single_put_size: int

Если размер большого двоичного объекта меньше или равен max_single_put_size, большой двоичный объект будет отправлен только с одним HTTP-запросом PUT. Если размер большого двоичного объекта превышает max_single_put_size, большой двоичный объект будет отправляться блоками. Значение по умолчанию — 64*1024*1024 или 64 МБ.

min_large_block_upload_threshold: int

Минимальный размер блока, необходимый для использования эффективного алгоритма использования памяти при отправке блочного BLOB-объекта. По умолчанию — 4*1024*1024+1.

use_byte_buffer: bool

Используйте буфер байтов для отправки блочных BLOB-объектов. Значение по умолчанию — False.

max_page_size: int

Максимальный размер блока для отправки страничного BLOB-объекта. Значение по умолчанию — 4*1024*1024 или 4 МБ.

max_single_get_size: int

Максимальный размер большого двоичного объекта, который будет скачан в одном вызове. Превышенная часть будет загружаться фрагментами (может быть параллельной). Значение по умолчанию — 32*1024*1024 или 32 МБ.

max_chunk_get_size: int

Максимальный размер блока, используемый для скачивания большого двоичного объекта. Значение по умолчанию — 4*1024*1024 или 4 МБ.

Методы

acquire_lease	Запрашивает новую аренду. Если контейнер не имеет активной аренды, то служба BLOB-объектов создает аренду для контейнера и возвращает новый идентификатор аренды.
close	Этот метод позволяет закрыть сокеты, открытые клиентом. Его не нужно использовать при использовании с диспетчером контекста.
create_container	Создает новый контейнер в указанной учетной записи. Если контейнер с таким именем уже существует, операция завершается ошибкой.
delete_blob	Помечает указанный большой двоичный объект или snapshot для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции delete_blob. Если для службы включена политика хранения удаления, то при выполнении этой операции выполняется обратимое удаление большого двоичного объекта или snapshot и сохранение большого двоичного объекта или snapshot в течение указанного количества дней. По истечении указанного количества дней данные BLOB-объекта удаляются из службы во время сборки мусора. Обратимо удаленный BLOB-объект или snapshot можно получить, list_blobs указав параметр include=["deleted"]. Обратимо удаленный BLOB-объект или snapshot можно восстановить с помощью<xref:azure.storage.blob.BlobClient.undelete>
delete_blobs	Помечает указанные большие двоичные объекты или моментальные снимки для удаления. Большие двоичные объекты позже удаляются во время сборки мусора. Обратите внимание, что для удаления больших двоичных объектов необходимо удалить все их моментальные снимки. Вы можете удалить оба одновременно с помощью операции delete_blobs. Если для службы включена политика хранения удаления, то при выполнении этой операции выполняется обратимое удаление больших двоичных объектов или моментальных снимков и сохранение больших двоичных объектов или моментальных снимков в течение указанного количества дней. По истечении указанного количества дней данные больших двоичных объектов удаляются из службы во время сборки мусора. Обратимо удаленные BLOB-объекты или моментальные снимки можно получить, list_blobs указав include=["deleted"] Обратимо удаленные blob-объекты или моментальные снимки можно восстановить с помощью <xref:azure.storage.blob.BlobClient.undelete> Максимальное количество BLOB-объектов, которые можно удалить в одном запросе, — 256.
delete_container	Помечает указанный контейнер для удаления. Контейнер и все большие двоичные объекты внутри него будут удалены позднее в процессе сборки мусора.
download_blob	Скачивает большой двоичный объект в StorageStreamDownloader. Для чтения всего содержимого необходимо использовать метод readall() или для скачивания большого двоичного объекта в поток. Использование chunks() возвращает итератор, который позволяет пользователю выполнять итерацию по содержимому в блоках.
exists	Возвращает значение True, если контейнер существует, в противном случае возвращает значение False.
find_blobs_by_tags	Возвращает генератор для вывода списка больших двоичных объектов в указанном контейнере, теги которого соответствуют заданному выражению поиска. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой.
from_connection_string	Создайте ContainerClient из строки подключения.
from_container_url	Создайте ContainerClient из URL-адреса контейнера.
get_account_information	Возвращает сведения, связанные с учетной записью хранения. Эти сведения также можно получить, если у пользователя есть SAS для контейнера или большого двоичного объекта. Ключи в возвращенном словаре включают "sku_name" и "account_kind".
get_blob_client	Получение клиента для взаимодействия с указанным большим двоичным объектом. Большой двоичный объект еще не должен существовать.
get_container_access_policy	Возвращает разрешения для указанного контейнера. Разрешения показывают, имеется ли общий доступ к данным контейнера.
get_container_properties	Возвращает все определяемые пользователем метаданные и системные свойства для указанного контейнера. Возвращаемые данные не включают список BLOB-объектов контейнера.
list_blob_names	Возвращает генератор для перечисления имен больших двоичных объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой. Обратите внимание, что при использовании этого API не будут возвращены дополнительные свойства или метаданные. Кроме того, этот API не может включать дополнительные большие двоичные объекты, такие как моментальные снимки, версии, обратимо удаленные BLOB-объекты и т. д. Чтобы получить эти данные, используйте .list_blobs
list_blobs	Возвращает генератор для вывода списка больших двоичных объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой.
set_container_access_policy	Задает разрешения для указанного контейнера или хранимых политик доступа, которые могут использоваться с подписанными URL-адресами. Разрешения показывают, имеется ли общий доступ к BLOB-объектам контейнера.
set_container_metadata	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанного контейнера. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к контейнеру. Чтобы удалить все метаданные из контейнера, вызовите эту операцию без дикта метаданных.
set_premium_page_blob_tier_blobs	Задает уровни страничных BLOB-объектов для всех BLOB-объектов. Этот API поддерживается только для страничных BLOB-объектов в учетных записях уровня "Премиум". Максимальное количество BLOB-объектов, которые можно обновить в одном запросе, — 256.
set_standard_blob_tier_blobs	Эта операция задает уровень для блочных BLOB-объектов. Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта. Максимальное количество BLOB-объектов, которые можно обновить в одном запросе, — 256.
upload_blob	Создает новый BLOB-объект из источника данных с автоматическим фрагментированием.
walk_blobs	Возвращает генератор для вывода списка больших двоичных объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращаемым службой. Эта операция выводит список больших двоичных объектов в соответствии с иерархией, разделенной указанным символом разделителя.

acquire_lease

Запрашивает новую аренду. Если контейнер не имеет активной аренды, то служба BLOB-объектов создает аренду для контейнера и возвращает новый идентификатор аренды.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs) -> BlobLeaseClient

Параметры

lease_duration: int

Обязательно

Указывает срок аренды в секундах или отрицательное число (-1) для бесконечной аренды. Конечная аренда может находиться в пределах от 15 до 60 секунд. Срок аренды нельзя изменить с помощью продления или изменения. Значение по умолчанию — -1 (бесконечная аренда).

lease_id: str

Обязательно

Идентификатор предлагаемой аренды в формате строки GUID. Служба BLOB-объектов возвращает значение 400 (недопустимый запрос), если предлагаемый идентификатор аренды имеет неправильный формат.

if_modified_since: datetime

Значение даты и времени. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс был изменен в указанное время.

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

Значение ETag или подстановочный знак (*). Используется для проверка, если ресурс изменился, и действует в соответствии с условием, заданным параметром match_condition.

match_condition: MatchConditions

Условие соответствия, используемое для etag.

timeout: int

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

Объект BlobLeaseClient, который можно запустить в диспетчере контекста.

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

BlobLeaseClient

close

Этот метод позволяет закрыть сокеты, открытые клиентом. Его не нужно использовать при использовании с диспетчером контекста.

close()

create_container

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

create_container(metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

metadata: dict[str, str]

Обязательно

Диктовка с name_value парами для связывания с контейнером в качестве метаданных. Пример:{'Category':'test'}

public_access: PublicAccess

Обязательно

Возможные значения: "container", "blob".

container_encryption_scope: dict или ContainerEncryptionScope

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

Новые возможности в версии 12.2.0.

timeout: int

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

Словарь заголовков ответов.

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

Dict[str, Union[str, datetime]]

delete_blob

Помечает указанный большой двоичный объект или snapshot для удаления.

В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции delete_blob.

Если для службы включена политика хранения удаления, то при выполнении этой операции выполняется обратимое удаление большого двоичного объекта или snapshot и сохранение большого двоичного объекта или snapshot в течение указанного количества дней. По истечении указанного количества дней данные BLOB-объекта удаляются из службы во время сборки мусора. Обратимо удаленный BLOB-объект или snapshot можно получить, list_blobs указав параметр include=["deleted"]. Обратимо удаленный BLOB-объект или snapshot можно восстановить с помощью<xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str | BlobProperties, delete_snapshots: str | None = None, **kwargs) -> None

Параметры

blob: str или BlobProperties

Обязательно

Большой двоичный объект, с которым необходимо взаимодействовать. Если он указан, это значение переопределяет значение большого двоичного объекта, указанное в URL-адресе большого двоичного объекта.

delete_snapshots: str

Обязательно

Является обязательным, если у большого двоичного объекта имеются связанные моментальные снимки. К этим значениям относятся следующие.

"only": удаляет только моментальные снимки BLOB-объектов.
"include": удаляет большой двоичный объект вместе со всеми моментальными снимками.

version_id: str

Параметр идентификатора версии является непрозрачным значением DateTime, которое при его наличии указывает версию удаляемого большого двоичного объекта.

Новые возможности в версии 12.4.0.

Этот аргумент ключевое слово появился в API версии 2019-12-12.

lease: BlobLeaseClient или str

Требуется, если у большого двоичного объекта имеется активная аренда. Значением может быть объект BlobLeaseClient или идентификатор аренды в виде строки.

if_modified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс был изменен в указанное время.

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

match_condition: MatchConditions

Условие соответствия, используемое для etag.

if_tags_match_condition: str

Укажите предложение SQL where для тегов BLOB-объектов, чтобы работать только с BLOB-объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

Новые возможности в версии 12.4.0.

timeout: int

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

None

delete_blobs

Помечает указанные большие двоичные объекты или моментальные снимки для удаления.

Большие двоичные объекты позже удаляются во время сборки мусора. Обратите внимание, что для удаления больших двоичных объектов необходимо удалить все их моментальные снимки. Вы можете удалить оба одновременно с помощью операции delete_blobs.

Если для службы включена политика хранения удаления, то при выполнении этой операции выполняется обратимое удаление больших двоичных объектов или моментальных снимков и сохранение больших двоичных объектов или моментальных снимков в течение указанного количества дней. По истечении указанного количества дней данные больших двоичных объектов удаляются из службы во время сборки мусора. Обратимо удаленные BLOB-объекты или моментальные снимки можно получить, list_blobs указав include=["deleted"] Обратимо удаленные blob-объекты или моментальные снимки можно восстановить с помощью <xref:azure.storage.blob.BlobClient.undelete>

Максимальное количество BLOB-объектов, которые можно удалить в одном запросе, — 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Параметры

blobs: str или dict(str, Any) или BlobProperties

Обязательно

Большие двоичные объекты для удаления. Это может быть один большой двоичный объект или несколько значений, где каждое значение является именем большого двоичного объекта (str) или BlobProperties.

Примечание

Если тип большого двоичного объекта — dict, ниже приведен список ключей и правил значений.

Имя большого двоичного объекта:

key: 'name', тип значения: str

snapshot удаления:

key: 'snapshot', тип значения: str

идентификатор версии:

key: 'version_id', тип значения: str

Следует ли удалять моментальные снимки при удалении BLOB-объекта:

key: "delete_snapshots", value: "include" или "only"

Если большой двоичный объект изменен или нет:

key: "if_modified_since", "if_unmodified_since", тип значения: datetime

Etag:

key: "etag", тип значения: str

соответствуют etag или нет:

key: "match_condition", тип значения: MatchConditions

условие соответствия тегов:

key: 'if_tags_match_condition', тип значения: str

Аренды:

key: 'lease_id', тип значения: Union[str, LeaseClient]

Время ожидания для вложенного запроса:

key: "timeout", тип значения: int

delete_snapshots: str

Требуется, если большой двоичный объект имеет связанные моментальные снимки. К этим значениям относятся следующие.

"only": удаляет только моментальные снимки BLOB-объектов.
"include": удаляет большой двоичный объект вместе со всеми моментальными снимками.

if_modified_since: datetime

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

if_tags_match_condition: str

Новые возможности в версии 12.4.0.

raise_on_any_failure: bool

Это логический параметр, который по умолчанию имеет значение True. Если этот параметр задан, возникает исключение, даже если произошел сбой одной операции.

timeout: int

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

Итератор ответов, по одному для каждого большого двоичного объекта в порядке

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

Iterator[HttpResponse]

delete_container

Помечает указанный контейнер для удаления. Контейнер и все большие двоичные объекты внутри него будут удалены позднее в процессе сборки мусора.

delete_container(**kwargs: Any) -> None

Параметры

lease: BlobLeaseClient или str

Если этот параметр указан, delete_container выполняется успешно, только если аренда контейнера активна и соответствует этому идентификатору. Требуется, если контейнер имеет активную аренду.

if_modified_since: datetime

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

match_condition: MatchConditions

Условие соответствия, используемое для etag.

timeout: int

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

None

download_blob

Скачивает большой двоичный объект в StorageStreamDownloader. Для чтения всего содержимого необходимо использовать метод readall() или для скачивания большого двоичного объекта в поток. Использование chunks() возвращает итератор, который позволяет пользователю выполнять итерацию по содержимому в блоках.

download_blob(blob: str | BlobProperties, offset: int = None, length: int = None, *, encoding: str, **kwargs) -> StorageStreamDownloader[str]

Параметры

blob: str или BlobProperties

Обязательно

Большой двоичный объект, с которым нужно взаимодействовать. Если указано, это значение переопределяет значение большого двоичного объекта, указанное в URL-адресе большого двоичного объекта.

offset: int

Обязательно

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

length: int

Обязательно

Число байтов, считываемых из потока. Это необязательный параметр, но его необходимо предоставить для оптимальной производительности.

version_id: str

Параметр идентификатора версии — это непрозрачное значение DateTime, которое при наличии указывает версию большого двоичного объекта для скачивания.

Новые возможности в версии 12.4.0.

Этот аргумент ключевое слово появился в API версии 2019-12-12.

validate_content: bool

Если значение равно true, вычисляет хэш MD5 для каждого блока большого двоичного объекта. Служба хранилища проверяет хэш содержимого, которое поступило вместе с отправленным хэшом. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если используется http вместо https, так как https (по умолчанию) уже проверяется. Учтите, что этот хэш MD5 не сохраняется в большом двоичном объекте. Кроме того, обратите внимание, что если этот параметр включен, алгоритм отправки с эффективным использованием памяти не будет использоваться, так как для вычисления хэша MD5 требуется буферизация целых блоков, и это приведет к поражению цели алгоритма, эффективного в памяти.

lease: BlobLeaseClient или str

Требуется, если у большого двоичного объекта имеется активная аренда. Если этот параметр указан, download_blob выполняется успешно, только если аренда BLOB-объекта активна и соответствует этому идентификатору. Значением может быть объект BlobLeaseClient или идентификатор аренды в виде строки.

if_modified_since: datetime

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

match_condition: MatchConditions

Условие соответствия, используемое для etag.

if_tags_match_condition: str

Новые возможности в версии 12.4.0.

cpk: CustomerProvidedEncryptionKey

Шифрует данные на стороне службы с помощью заданного ключа. Использование предоставленных клиентом ключей должно выполняться по протоколу HTTPS. Так как сам ключ шифрования указан в запросе, необходимо установить безопасное подключение для передачи ключа.

max_concurrency: int

Количество параллельных подключений, с помощью которых требуется скачать.

encoding: str

Кодирование для декодирования скачанных байтов. Значение по умолчанию — Нет, т. е. без декодирования.

progress_hook: Callable[[int, int], None]

Обратный вызов для отслеживания хода выполнения длительной загрузки. Сигнатура — function(current: int, total: int), где current — это число переданных байтов, а total — общий размер скачиваемого файла.

timeout: int

Задает время ожидания на стороне сервера для операции в секундах. Дополнительные сведения см. в следующей статье: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Это значение не отслеживается и не проверяется на клиенте. Сведения о настройке времени ожидания сети на стороне клиента см. здесь. Этот метод может выполнять несколько вызовов службы, и время ожидания будет применяться к каждому вызову по отдельности. несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

Объект потоковой передачи (StorageStreamDownloader)

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

StorageStreamDownloader

exists

Возвращает значение True, если контейнер существует, в противном случае возвращает значение False.

exists(**kwargs: Any) -> bool

Параметры

timeout: int

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

Логическое

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

bool

find_blobs_by_tags

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

find_blobs_by_tags(filter_expression: str, **kwargs: Any | None) -> ItemPaged[FilteredBlob]

Параметры

filter_expression: str

Обязательно

Выражение для поиска больших двоичных объектов, теги которых соответствуют указанному условию. Например: ""yourtagname"='firsttag' и "yourtagname2"='secondtag'"

results_per_page: int

Максимальный результат на страницу при разбиении на страницы.

timeout: int

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

Итерируемый (автоматически разбиение по страницам) ответа FilteredBlob.

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

ItemPaged[BlobProperties]

from_connection_string

Создайте ContainerClient из строки подключения.

from_connection_string(conn_str: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Параметры

conn_str: str

Обязательно

Строка подключения к учетной записи хранения Azure.

container_name: str

Обязательно

Имя контейнера для большого двоичного объекта.

credential

значение по умолчанию: None

Учетные данные для проверки подлинности. Это необязательно, если URL-адрес учетной записи уже содержит маркер SAS или строка подключения уже содержит значения общего ключа доступа. Это может быть строка маркера SAS, экземпляр AzureSasCredential или AzureNamedKeyCredential из azure.core.credentials, общий ключ доступа учетной записи или экземпляр класса TokenCredentials из azure.identity. Предоставленные здесь учетные данные будут иметь приоритет над учетными данными в строке подключения. При использовании экземпляра AzureNamedKeyCredential "name" должно быть именем учетной записи хранения, а "key" — ключом учетной записи хранения.

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

Клиент контейнера.

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

ContainerClient

from_container_url

Создайте ContainerClient из URL-адреса контейнера.

from_container_url(container_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Параметры

container_url: str

Обязательно

Полный URL-адрес конечной точки для контейнера, включая маркер SAS, если он используется. Это может быть основная или вторичная конечная точка в зависимости от текущего location_mode.

credential

значение по умолчанию: None

Учетные данные для проверки подлинности. Это необязательно, если URL-адрес учетной записи уже содержит маркер SAS или строка подключения уже содержит значения общего ключа доступа. Это может быть строка маркера SAS, экземпляр AzureSasCredential или AzureNamedKeyCredential из azure.core.credentials, общий ключ доступа учетной записи или экземпляр класса TokenCredentials из azure.identity. Если URI ресурса уже содержит маркер SAS, он будет игнорироваться в пользу явных учетных данных.

за исключением случаев AzureSasCredential, где конфликтующие маркеры SAS вызовут ValueError. При использовании экземпляра AzureNamedKeyCredential "name" должно быть именем учетной записи хранения, а "key" — ключом учетной записи хранения.

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

Клиент контейнера.

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

ContainerClient

get_account_information

Возвращает сведения, связанные с учетной записью хранения.

Эти сведения также можно получить, если у пользователя есть SAS для контейнера или большого двоичного объекта. Ключи в возвращенном словаре включают "sku_name" и "account_kind".

get_account_information(**kwargs: Any) -> Dict[str, str]

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

Словарь сведений об учетной записи (SKU и тип учетной записи).

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

dict(str, str)

get_blob_client

Получение клиента для взаимодействия с указанным большим двоичным объектом.

Большой двоичный объект еще не должен существовать.

get_blob_client(blob: str | BlobProperties, snapshot: str = None, *, version_id: str | None = None) -> BlobClient

Параметры

blob: str или BlobProperties

Обязательно

Большой двоичный объект, с которым нужно взаимодействовать.

snapshot: str

значение по умолчанию: None

Необязательный snapshot большого двоичного объекта, с которым нужно работать. Это может быть строка идентификатора snapshot или ответ, возвращенный из create_snapshot.

version_id: str

Параметр идентификатора версии — это непрозрачное значение DateTime, которое при наличии указывает версию большого двоичного объекта, с которым нужно работать.

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

A BlobClient.

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

BlobClient

get_container_access_policy

Возвращает разрешения для указанного контейнера. Разрешения показывают, имеется ли общий доступ к данным контейнера.

get_container_access_policy(**kwargs: Any) -> Dict[str, Any]

Параметры

lease: BlobLeaseClient или str

Если этот параметр указан, get_container_access_policy выполняется успешно, только если аренда контейнера активна и соответствует этому идентификатору.

timeout: int

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

Доступ к сведениям о политике в словаре.

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

dict[str, Any]

get_container_properties

Возвращает все определяемые пользователем метаданные и системные свойства для указанного контейнера. Возвращаемые данные не включают список BLOB-объектов контейнера.

get_container_properties(**kwargs: Any) -> ContainerProperties

Параметры

lease: BlobLeaseClient или str

Если этот параметр указан, get_container_properties выполняется успешно, только если аренда контейнера активна и соответствует этому идентификатору.

timeout: int

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

Свойства для указанного контейнера в объекте контейнера.

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

ContainerProperties

list_blob_names

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

Обратите внимание, что при использовании этого API не будут возвращены дополнительные свойства или метаданные. Кроме того, этот API не может включать дополнительные большие двоичные объекты, такие как моментальные снимки, версии, обратимо удаленные BLOB-объекты и т. д. Чтобы получить эти данные, используйте .list_blobs

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Параметры

name_starts_with: str

Фильтрует результаты для возвращения только тех BLOB-объектов, имена которых начинаются с указанного префикса.

timeout: int

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

Итерируемый (автоматически разбиение по страницам) ответ имен BLOB-объектов в виде строк.

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

ItemPaged[str]

list_blobs

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

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Параметры

name_starts_with: str

Обязательно

include: list[str] или str

Обязательно

Указывает один или несколько дополнительных наборов данных для включения в ответ. Возможные варианты: "snapshots", "metadata", "uncommittedblobs", "copy", "deleted", "deletedwithversions", "tags", "versions", "immutabilitypolicy", "legalhold".

timeout: int

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

Итерируемый (автоматически разбиение по страницам) ответ BlobProperties.

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

ItemPaged[BlobProperties]

set_container_access_policy

Задает разрешения для указанного контейнера или хранимых политик доступа, которые могут использоваться с подписанными URL-адресами. Разрешения показывают, имеется ли общий доступ к BLOB-объектам контейнера.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Параметры

signed_identifiers: dict[str, AccessPolicy]

Обязательно

Словарь политик доступа для связывания с контейнером. Словарь может содержать до 5 элементов. Пустой словарь очистит политики доступа, заданные для службы.

public_access: PublicAccess

Обязательно

Возможные значения: "container", "blob".

lease: BlobLeaseClient или str

Требуется, если контейнер имеет активную аренду. Значением может быть объект BlobLeaseClient или идентификатор аренды в виде строки.

if_modified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции, только если ресурс был изменен с указанной даты и времени.

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

timeout: int

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

Обновленный контейнером словарь свойств (Etag и последнее изменение).

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

dict[str, str,

datetime]

set_container_metadata

Задает одну или несколько определяемых пользователем пар "имя-значение" для указанного контейнера. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к контейнеру. Чтобы удалить все метаданные из контейнера, вызовите эту операцию без дикта метаданных.

set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Параметры

metadata: dict[str, str]

Обязательно

Словарь, содержащий пары "имя-значение", которые необходимо связать с контейнером в качестве метаданных. Пример: {'category':'test'}

lease: BlobLeaseClient или str

Если этот параметр указан, set_container_metadata выполняется успешно, только если аренда контейнера активна и соответствует этому идентификатору.

if_modified_since: datetime

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

timeout: int

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

Обновленный контейнером словарь свойств (Etag и последнее изменение).

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

dict[str, str,

datetime]

set_premium_page_blob_tier_blobs

Задает уровни страничных BLOB-объектов для всех BLOB-объектов. Этот API поддерживается только для страничных BLOB-объектов в учетных записях уровня "Премиум".

Максимальное количество BLOB-объектов, которые можно обновить в одном запросе, — 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Параметры

premium_page_blob_tier: PremiumPageBlobTier

Обязательно

Значение уровня страничного BLOB-объекта, которое необходимо задать для большого двоичного объекта. Уровень коррелирует с размером большого двоичного объекта и количеством разрешенных операций ввода-вывода в секунду. Это применимо только к страничные BLOB-объекты в учетных записях хранения класса Premium.

Примечание

Если вы хотите задать другой уровень для разных BLOB-объектов, задайте для этого позиционного параметра значение Нет.

Затем будет использоваться уровень BLOB-объекта для каждого blobProperties.

blobs: str или dict(str, Any) или BlobProperties

Обязательно

Большие двоичные объекты, с которыми необходимо взаимодействовать. Это может быть один большой двоичный объект или несколько значений, где каждое значение является именем большого двоичного объекта (str) или BlobProperties.

Примечание

Если тип большого двоичного объекта — dict, ниже приведен список ключей и правил значений.

Имя большого двоичного объекта:

key: 'name', тип значения: str

Уровень больших двоичных объектов уровня "Премиум":

key: "blob_tier", тип значения: PremiumPageBlobTier

Аренды:

key: 'lease_id', тип значения: Union[str, LeaseClient]

Время ожидания для вложенного запроса:

key: "timeout", тип значения: int

timeout: int

raise_on_any_failure: bool

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

Итератор ответов, по одному для каждого большого двоичного объекта в порядке

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

<xref:iterator>[HttpResponse]

set_standard_blob_tier_blobs

Эта операция задает уровень для блочных BLOB-объектов.

Уровень блочного BLOB-объекта определяет тип горячего, холодного и архивного хранилища. Эта операция не обновляет ETag BLOB-объекта.

Максимальное количество BLOB-объектов, которые можно обновить в одном запросе, — 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Параметры

standard_blob_tier: str или StandardBlobTier

Обязательно

Указывает уровень, который необходимо задать для всех BLOB-объектов. Возможные варианты: "Горячий", "Холодный", "Архив". Горячий уровень оптимизирован для хранения данных, к которым часто обращаются. Холодный уровень хранилища оптимизирован для хранения данных, к которым редко обращаются и хранятся не менее месяца. Архивный уровень оптимизирован для хранения данных, к которым редко обращаются и хранятся по крайней мере шесть месяцев с гибкими требованиями к задержке.

Примечание

Затем будет использоваться уровень BLOB-объекта для каждого blobProperties.

blobs: str или dict(str, Any) или BlobProperties

Обязательно

Примечание

Если тип большого двоичного объекта — dict, ниже приведен список ключей и правил значений.

Имя большого двоичного объекта:

key: 'name', тип значения: str

Стандартный уровень BLOB-объектов:

key: "blob_tier", тип значения: StandardBlobTier

Приоритет восстановления:

key: 'rehydrate_priority', тип значения: RehydratePriority

Аренды:

key: 'lease_id', тип значения: Union[str, LeaseClient]

snapshot:

key: "snapshot", тип значения: str

идентификатор версии:

key: "version_id", тип значения: str

условие соответствия тегов:

key: 'if_tags_match_condition', тип значения: str

Время ожидания для вложенного запроса:

key: "timeout", тип значения: int

rehydrate_priority: RehydratePriority

Указывает приоритет восстановления архивного большого двоичного объекта

if_tags_match_condition: str

Новые возможности в версии 12.4.0.

timeout: int

raise_on_any_failure: bool

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

Итератор ответов, по одному для каждого большого двоичного объекта в порядке

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

Iterator[HttpResponse]

upload_blob

Создает новый BLOB-объект из источника данных с автоматическим фрагментированием.

upload_blob(name: str | BlobProperties, data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> BlobClient

Параметры

name: str или BlobProperties

Обязательно

data

Обязательно

Данные большого двоичного объекта для отправки.

blob_type: BlobType

Обязательно

Тип большого двоичного объекта. Это может быть BlockBlob, PageBlob или AppendBlob. Значение по умолчанию — BlockBlob.

length: int

Обязательно

metadata: dict(str, str)

Обязательно

Пары «имя-значение», связанные с большим двоичным объектом как метаданные.

overwrite: bool

Указывает, должен ли отправляемый BLOB-объект перезаписывать текущие данные. Если значение равно True, upload_blob перезапишет существующие данные. Если задано значение False, операция завершится ошибкой resourceExistsError. Исключением из приведенного выше является добавление типов BLOB-объектов: если задано значение False и данные уже существуют, ошибка не будет вызвана и данные будут добавлены в существующий BLOB-объект. Если задано overwrite=True, то существующий добавочный BLOB-объект будет удален и создан новый. Значение по умолчанию — False.

content_settings: ContentSettings

Объект ContentSettings, используемый для задания свойств BLOB-объекта. Используется для задания типа контента, кодирования, языка, ликвидации, md5 и элемента управления кэшем.

validate_content: bool

lease: BlobLeaseClient или str

if_modified_since: datetime

if_unmodified_since: datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

etag: str

match_condition: MatchConditions

Условие соответствия, используемое для etag.

if_tags_match_condition: str

Новые возможности в версии 12.4.0.

timeout: int

Задает время ожидания на стороне сервера для операции в секундах. Дополнительные сведения см. в следующей статье: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Это значение не отслеживается и не проверяется на клиенте. Чтобы настроить время ожидания сети на стороне клиента, см. здесь. Этот метод может выполнять несколько вызовов службы, и время ожидания будет применяться к каждому вызову по отдельности.

premium_page_blob_tier: PremiumPageBlobTier

Значение уровня страничного BLOB-объекта, которое необходимо задать для большого двоичного объекта. Уровень соответствует размеру большого двоичного объекта и количеству разрешенных операций ввода-вывода в секунду. Это применимо только к страничные BLOB-объекты в учетных записях хранения класса Premium.

standard_blob_tier: StandardBlobTier

Значение уровня "Стандартный" для большого двоичного объекта. Для этой версии библиотеки это применимо только для блочных BLOB-объектов в стандартных учетных записях хранения.

maxsize_condition: int

Необязательный условный заголовок. Максимальная длина в байтах, разрешенная для добавочного BLOB-объекта. Если операция добавления блока приведет к тому, что blob-объект превысит это ограничение или размер большого двоичного объекта уже больше значения, указанного в этом заголовке, запрос завершится ошибкой MaxBlobSizeConditionNotMet (код состояния HTTP 412 — сбой условия).

max_concurrency: int

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

cpk: CustomerProvidedEncryptionKey

Шифрует данные на стороне службы с помощью заданного ключа. Использование ключей, предоставленных клиентом, должно выполняться по протоколу HTTPS. Так как сам ключ шифрования предоставляется в запросе, необходимо установить безопасное подключение для передачи ключа.

encryption_scope: str

Предопределенная область шифрования, используемая для шифрования данных в службе. Область шифрования можно создать с помощью API управления и ссылаться здесь по имени. Если в контейнере определена область шифрования по умолчанию, это значение переопределяет его, если область на уровне контейнера настроен для разрешения переопределений. В противном случае будет вызвана ошибка.

Новые возможности в версии 12.2.0.

encoding: str

Значение по умолчанию — UTF-8.

progress_hook: Callable[[int, Optional[int]], None]

Обратный вызов для отслеживания хода длительной отправки. Сигнатура — function(current: int, total: Optional[int]), где current — это количество переданных байтов, а total — это размер большого двоичного объекта или None, если размер неизвестен.

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

BlobClient для взаимодействия с вновь отправленным BLOB-объектом.

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

BlobClient

walk_blobs

Возвращает генератор для вывода списка больших двоичных объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращаемым службой. Эта операция выводит список больших двоичных объектов в соответствии с иерархией, разделенной указанным символом разделителя.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any | None) -> ItemPaged[BlobProperties]

Параметры

name_starts_with: str

Обязательно

include: list[str] или str

Обязательно

delimiter: str

Обязательно

Если запрос включает этот параметр, операция возвращает элемент BlobPrefix в тексте ответа, который выступает в качестве заполнителя для всех BLOB-объектов, имена которых начинаются с одной подстроки до появления символа разделителя. Разделитель может быть задан одним символом или строкой.

timeout: int

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

Итерируемый (автоматический) ответ BlobProperties.

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

ItemPaged[BlobProperties]

Атрибуты

api_version

Версия API хранилища, используемого для запросов.

location_mode

Режим расположения, который в настоящее время использует клиент.

По умолчанию это будет "primary". Варианты включают "primary" и "secondary".

primary_endpoint

Полный URL-адрес основной конечной точки.

primary_hostname

Имя узла основной конечной точки.

secondary_endpoint

Полный URL-адрес вторичной конечной точки, если он настроен.

Если он недоступен, будет вызван параметр ValueError. Чтобы явно указать дополнительное имя узла, используйте необязательный аргумент secondary_hostname ключевое слово при создании экземпляра.

Исключения

ValueError

secondary_hostname

Имя узла вторичной конечной точки.

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

url

Полный URL-адрес конечной точки для этой сущности, включая маркер SAS, если он используется.

Это может быть либо основная конечная точка, либо вторичная конечная точка в зависимости от текущей location_mode. :returns: полный URL-адрес конечной точки для этой сущности, включая маркер SAS, если используется. :rtype: str