Поделиться через


BlobClient Класс

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

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

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

Конструктор

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

Параметры

account_url
str
Обязательно

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

container_name
str
Обязательно

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

blob_name
str
Обязательно

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

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

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

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

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

  • за исключением случаев AzureSasCredential, где конфликтующие маркеры SAS вызовут ValueError. При использовании экземпляра AzureNamedKeyCredential "name" должно быть именем учетной записи хранения, а "key" — ключом учетной записи хранения.
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 МБ.

version_id
str

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

Методы

abort_copy

Прерывание текущей операции копирования.

При этом конечный BLOB-объект останется с нулевой длиной и полными метаданными. Это приведет к ошибке, если операция копирования уже завершена.

acquire_lease

Запрашивает новую аренду.

Если у BLOB-объекта нет активной аренды, служба BLOB-объектов создает аренду большого двоичного объекта и возвращает новую аренду.

append_block

Фиксирует новый блок данных в конце существующего добавочного BLOB-объекта.

append_block_from_url

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

clear_page

Очищает диапазон страниц.

close

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

commit_block_list

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

create_append_blob

Создает новый добавочный BLOB-объект. Эта операция создает новый добавочный BLOB-объект длиной 0. Содержимое любого существующего большого двоичного объекта перезаписывается новым инициализированным добавительным BLOB-объектом. Чтобы добавить содержимое в добавочный BLOB-объект, вызовите append_block метод или append_block_from_url .

create_page_blob

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

create_snapshot

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

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

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

delete_blob

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

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

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

delete_immutability_policy

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

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

download_blob

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

exists

Возвращает значение True, если большой двоичный объект существует с определенными параметрами, в противном случае возвращает значение False.

from_blob_url

Создайте BlobClient из URL-адреса большого двоичного объекта. Это не поддерживает настраиваемый URL-адрес большого двоичного объекта с именем большого двоичного объекта "/".

from_connection_string

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

get_account_information

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

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

get_blob_properties

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

get_blob_tags

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

Новые возможности в версии 12.4.0: эта операция появилась в API версии 2019-12-12.

get_block_list

Операция Получить список блоков извлекает список блоков, которые были отправлены в составе блочного BLOB-объекта.

get_page_range_diff_for_managed_disk

Возвращает список допустимых диапазонов страниц для управляемого диска или snapshot.

Примечание

Эта операция доступна только для учетных записей управляемых дисков.

Новые возможности в версии 12.2.0: эта операция появилась в API версии 2019-07-07.

get_page_ranges

НЕ РЕКОМЕНДУЕТСЯ: возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или snapshot страничного BLOB-объекта.

list_page_ranges

Возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или snapshot страничного BLOB-объекта. Если указан previous_snapshot, результатом будет diff изменений между целевым BLOB-объектом и предыдущим snapshot.

query_blob

Позволяет пользователям выбирать или проектировать данные большого двоичного объекта или большого двоичного объекта snapshot путем предоставления простых выражений запроса. Эта операция возвращает BlobQueryReader, пользователям необходимо использовать readall() или readinto() для получения данных запроса.

resize_blob

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

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

seal_append_blob

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

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

set_blob_metadata

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

set_blob_tags

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

Новые возможности в версии 12.4.0: эта операция появилась в API версии 2019-12-12.

set_http_headers

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

Если для content_settings задано одно свойство, все свойства будут переопределены.

set_immutability_policy

Операция Set Immutability Policy (Задать политику неизменяемости) задает политику неизменяемости для большого двоичного объекта.

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

set_legal_hold

Операция Установить удержание по юридическим причинам устанавливает удержание blob-объекта по юридическим причинам.

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

set_premium_page_blob_tier

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

set_sequence_number

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

set_standard_blob_tier

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

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

stage_block

Создает новую блокировку, которую нужно зафиксировать как часть большого двоичного объекта.

stage_block_from_url

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

start_copy_from_url

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

Эта операция возвращает словарь, содержащий copy_status и copy_id, который можно использовать для проверка состояния или прерывания операции копирования. copy_status будет "успешно", если копирование выполнено синхронно, или "ожидание", если копирование было запущено асинхронно. Для асинхронных копий состояние можно проверить, опрашив get_blob_properties метод и проверив состояние копирования. Задайте для requires_sync значение True, чтобы принудительная синхронизация копирования. Служба BLOB-объектов копирует BLOB-объекты наилучшим возможным образом.

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

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

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

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

undelete_blob

Восстанавливает обратимо удаленные BLOB-объекты или моментальные снимки.

Операция будет успешной, только если используется в течение указанного числа дней, заданного в политике хранения удаления.

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

upload_blob

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

upload_blob_from_url

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

upload_page

Операция Отправить страницы записывает диапазон страниц в страничный BLOB-объект.

upload_pages_from_url

Операция Отправить страницы записывает диапазон страниц в страничный BLOB-объект, где содержимое считывается из URL-адреса.

abort_copy

Прерывание текущей операции копирования.

При этом конечный BLOB-объект останется с нулевой длиной и полными метаданными. Это приведет к ошибке, если операция копирования уже завершена.

abort_copy(copy_id: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> None

Параметры

copy_id
str или BlobProperties
Обязательно

Прервать операцию копирования. Это может быть строка идентификатора или экземпляр BlobProperties.

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

acquire_lease

Запрашивает новую аренду.

Если у BLOB-объекта нет активной аренды, служба BLOB-объектов создает аренду большого двоичного объекта и возвращает новую аренду.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> 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.

if_tags_match_condition
str

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

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

timeout
int

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

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

Объект BlobLeaseClient.

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

append_block

Фиксирует новый блок данных в конце существующего добавочного BLOB-объекта.

append_block(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Параметры

data
bytes или str или Iterable
Обязательно

Содержимое блока. Это могут быть байты, текст, итерируемый или файловый объект.

length
int
Обязательно

Размер блока в байтах.

validate_content
bool

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

maxsize_condition
int

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

appendpos_condition
int

Необязательный условный заголовок, используемый только для операции добавления блока. Число, указывающее смещение байтов для сравнения. Добавление блока будет выполнено успешно, только если позиция добавления равна этому числу. Если это не так, запрос завершится ошибкой AppendPositionConditionNotMet (код состояния HTTP 412 — сбой предварительного условия).

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

encoding
str

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag, последнее изменение, смещение добавления, число зафиксированных блоков).

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

append_block_from_url

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

append_block_from_url(copy_source_url: str, source_offset: int | None = None, source_length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Параметры

copy_source_url
str
Обязательно

URL-адрес исходных данных. Он может указывать на любой blob-объект Или Файл Azure, которые являются общедоступными или имеют присоединенную подписанный URL-адрес.

source_offset
int
Обязательно

Это указывает на начало диапазона байтов (включительно), который должен быть взят из источника копирования.

source_length
int
Обязательно

Это указывает конец диапазона байтов, который должен быть взят из источника копирования.

source_content_md5
bytearray

Если этот параметр задан, служба вычислит md5-хэш содержимого блока и сравнит его с этим значением.

maxsize_condition
int

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

appendpos_condition
int

Необязательный условный заголовок, используемый только для операции добавления блока. Число, указывающее смещение байтов для сравнения. Добавление блока будет выполнено успешно, только если позиция добавления равна этому числу. Если это не так, запрос завершится ошибкой AppendPositionConditionNotMet (код состояния HTTP 412 — сбой предварительного условия).

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

source_if_modified_since
datetime

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

source_if_unmodified_since
datetime

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

source_etag
str

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

source_match_condition
MatchConditions

Условие соответствия исходного кода, используемое для etag.

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

source_authorization
str

Проверка подлинности в качестве субъекта-службы с помощью секрета клиента для доступа к исходному BLOB-объекту. Убедитесь, что "bearer" является префиксом строки source_authorization.

clear_page

Очищает диапазон страниц.

clear_page(offset: int, length: int, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

offset
int
Обязательно

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

length
int
Обязательно

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

lease
BlobLeaseClient или str

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

if_sequence_number_lte
int

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

if_sequence_number_lt
int

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

if_sequence_number_eq
int

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение).

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

close

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

close()

commit_block_list

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

commit_block_list(block_list: List[BlobBlock], content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Параметры

block_list
list
Обязательно

Список блочных BLOB-объектов.

content_settings
ContentSettings
Обязательно

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

metadata
dict[str, str]
Обязательно

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

tags
dict(str, str)

Пары "имя-значение", связанные с большим двоичным объектом в виде тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые ключ тега и символы значения: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

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

lease
BlobLeaseClient или str

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

immutability_policy
ImmutabilityPolicy

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

legal_hold
bool

Указывает, следует ли установить юридическое удержание для большого двоичного объекта.

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

validate_content
bool

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

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.

if_tags_match_condition
str

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

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

standard_blob_tier
StandardBlobTier

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение).

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

create_append_blob

Создает новый добавочный BLOB-объект. Эта операция создает новый добавочный BLOB-объект длиной 0. Содержимое любого существующего большого двоичного объекта перезаписывается новым инициализированным добавительным BLOB-объектом. Чтобы добавить содержимое в добавочный BLOB-объект, вызовите append_block метод или append_block_from_url .

create_append_blob(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

content_settings
ContentSettings
Обязательно

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

metadata
dict(str, str)
Обязательно

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

tags
dict(str, str)

Пары "имя-значение", связанные с большим двоичным объектом в виде тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые ключ тега и символы значения: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

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

lease
BlobLeaseClient или str

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

immutability_policy
ImmutabilityPolicy

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

legal_hold
bool

Указывает, следует ли установить юридическое удержание для большого двоичного объекта.

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

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.

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение).

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

create_page_blob

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

create_page_blob(size: int, content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, premium_page_blob_tier: str | PremiumPageBlobTier | None = None, **kwargs) -> Dict[str, str | datetime]

Параметры

size
int
Обязательно

Этот параметр задает максимальный размер страничного BLOB-объекта до 1 ТБ. Размер страничного большого двоичного объекта необходимо выравнивать по границе в 512 байт.

content_settings
ContentSettings
Обязательно

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

metadata
dict(str, str)
Обязательно

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

premium_page_blob_tier
PremiumPageBlobTier
Обязательно

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

tags
dict(str, str)

Пары "имя-значение", связанные с большим двоичным объектом в виде тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые ключ тега и символы значения: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

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

sequence_number
int

Только для страничных BLOB-объектов. Порядковый номер — это значение, управляемое пользователем, которое можно использовать для отслеживания запросов. Значение порядкового номера должно находиться в пределах от 0 до 2^63 - 1. Значение по умолчанию — 0.

lease
BlobLeaseClient или str

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

immutability_policy
ImmutabilityPolicy

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

legal_hold
bool

Указывает, следует ли установить юридическое удержание для большого двоичного объекта.

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

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.

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение).

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

create_snapshot

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

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

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

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

Параметры

metadata
dict(str, str)
Обязательно

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

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.

if_tags_match_condition
str

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

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

lease
BlobLeaseClient или str

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Словарь свойств, обновленных blob-объектов (идентификатор моментального снимка, Etag и последнее изменение).

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

delete_blob

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

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

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

delete_blob(delete_snapshots: str = None, **kwargs: Any) -> None

Параметры

delete_snapshots
str
Обязательно

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

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

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

version_id
str

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

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

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

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

timeout
int

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

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

delete_immutability_policy

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

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

delete_immutability_policy(**kwargs: Any) -> None

Параметры

timeout
int

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

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

Пары "Ключ-значение" тегов BLOB-объектов.

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

download_blob

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

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

Параметры

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

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

if_unmodified_since
datetime

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

etag
str

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

match_condition
MatchConditions

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

if_tags_match_condition
str

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

Новые возможности в версии 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)

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

exists

Возвращает значение True, если большой двоичный объект существует с определенными параметрами, в противном случае возвращает значение False.

exists(**kwargs: Any) -> bool

Параметры

version_id
str

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

timeout
int

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

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

Логическое

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

from_blob_url

Создайте BlobClient из URL-адреса большого двоичного объекта. Это не поддерживает настраиваемый URL-адрес большого двоичного объекта с именем большого двоичного объекта "/".

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

Параметры

blob_url
str
Обязательно

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

credential
Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
значение по умолчанию: None

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

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

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

version_id
str

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

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

Клиент BLOB-объектов.

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

from_connection_string

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

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

Параметры

conn_str
str
Обязательно

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

container_name
str
Обязательно

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

blob_name
str
Обязательно

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

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

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

credential
Optional[Union[str, Dict[str, str], <xref:"AzureNamedKeyCredential">, <xref:"AzureSasCredential">, <xref:"TokenCredential">]] <xref:./>
значение по умолчанию: None

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

version_id
str

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

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

Клиент BLOB-объектов.

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

get_account_information

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

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

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

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

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

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

get_blob_properties

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

get_blob_properties(**kwargs: Any) -> BlobProperties

Параметры

lease
BlobLeaseClient или str

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

version_id
str

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

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

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

timeout
int

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

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

BlobProperties

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

get_blob_tags

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

Новые возможности в версии 12.4.0: эта операция появилась в API версии 2019-12-12.

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

Параметры

version_id
str

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

if_tags_match_condition
str

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

lease
BlobLeaseClient или str

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

timeout
int

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

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

Пары "Ключ-значение" тегов BLOB-объектов.

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

get_block_list

Операция Получить список блоков извлекает список блоков, которые были отправлены в составе блочного BLOB-объекта.

get_block_list(block_list_type: str | None = 'committed', **kwargs: Any) -> Tuple[List[BlobBlock], List[BlobBlock]]

Параметры

block_list_type
str
Обязательно

Указывает, следует вернуть список зафиксированных блокировок, список незафиксированных блокировок или оба списка одновременно. Возможные значения: "committed", "uncommitted", "all"

lease
BlobLeaseClient или str

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

if_tags_match_condition
str

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

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

timeout
int

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

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

Кортеж из двух списков — зафиксированных и незафиксированных блоков.

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

get_page_range_diff_for_managed_disk

Возвращает список допустимых диапазонов страниц для управляемого диска или snapshot.

Примечание

Эта операция доступна только для учетных записей управляемых дисков.

Новые возможности в версии 12.2.0: эта операция появилась в API версии 2019-07-07.

get_page_range_diff_for_managed_disk(previous_snapshot_url: str, offset: int | None = None, length: int | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Параметры

previous_snapshot_url
Обязательно

Указывает URL-адрес предыдущего snapshot управляемого диска. Ответ будет содержать только страницы, которые были изменены между целевым BLOB-объектом и его предыдущим snapshot.

offset
int
Обязательно

Начало диапазона байтов, используемого для получения допустимых диапазонов страниц. Если длина не указана, выполняется поиск по всем байтам после смещения. Страницы должны быть выровнены по 512-байтовой границе, начальное смещение должно быть модулю 512, а длина должна быть 512.

length
int
Обязательно

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

lease
BlobLeaseClient или str

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

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

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

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

Кортеж из двух списков диапазонов страниц в виде словарей с ключами start и end. Первый элемент представляет собой заполненные диапазоны страниц, второй элемент очищает диапазоны страниц.

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

get_page_ranges

НЕ РЕКОМЕНДУЕТСЯ: возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или snapshot страничного BLOB-объекта.

get_page_ranges(offset: int | None = None, length: int | None = None, previous_snapshot_diff: str | Dict[str, Any] | None = None, **kwargs) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

Параметры

offset
int
Обязательно

Начало диапазона байтов, используемого для получения допустимых диапазонов страниц. Если длина не указана, выполняется поиск по всем байтам после смещения. Страницы должны быть выровнены по 512-байтовой границе, начальное смещение должно быть модулю 512, а длина должна быть 512.

length
int
Обязательно

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

previous_snapshot_diff
str
Обязательно

Параметр snapshot diff, содержащий непрозрачное значение DateTime, указывающее предыдущий snapshot большого двоичного объекта для сравнения с более поздним snapshot или текущим BLOB-объектом.

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

timeout
int

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

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

Кортеж из двух списков диапазонов страниц в виде словарей с ключами start и end. Первый элемент представляет собой заполненные диапазоны страниц, второй элемент очищает диапазоны страниц.

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

list_page_ranges

Возвращает список допустимых диапазонов страниц для страничного BLOB-объекта или snapshot страничного BLOB-объекта. Если указан previous_snapshot, результатом будет diff изменений между целевым BLOB-объектом и предыдущим snapshot.

list_page_ranges(*, offset: int | None = None, length: int | None = None, previous_snapshot: str | Dict[str, Any] | None = None, **kwargs: Any) -> ItemPaged[PageRange]

Параметры

offset
int

Начало диапазона байтов, используемого для получения допустимых диапазонов страниц. Если длина не указана, выполняется поиск по всем байтам после смещения. Страницы должны быть выровнены по 512-байтовой границе, начальное смещение должно быть модулю 512, а длина должна быть 512.

length
int

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

previous_snapshot
str или Dict[str, Any]

Значение snapshot, указывающее, что ответ будет содержать только страницы, которые были изменены между целевым BLOB-объектом и предыдущими snapshot. Измененные страницы включают как обновленные, так и очищенные страницы. Целевой BLOB-объект может быть snapshot, если snapshot, указанный previous_snapshot, является более старым из двух.

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

results_per_page
int

Максимальное количество диапазонов страниц для получения на вызов API.

timeout
int

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

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

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

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

query_blob

Позволяет пользователям выбирать или проектировать данные большого двоичного объекта или большого двоичного объекта snapshot путем предоставления простых выражений запроса. Эта операция возвращает BlobQueryReader, пользователям необходимо использовать readall() или readinto() для получения данных запроса.

query_blob(query_expression: str, **kwargs: Any) -> BlobQueryReader

Параметры

query_expression
str
Обязательно

Обязательный. оператор запроса. Дополнительные сведения см. в следующей статье: https://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

on_error
Callable[BlobQueryError]

Функция, вызываемая при любых ошибках обработки, возвращаемых службой.

blob_format
DelimitedTextDialect или DelimitedJsonDialect или QuickQueryDialect или str

Необязательный элемент. Определяет сериализацию данных, хранящихся в данный момент в большом двоичном объекте. По умолчанию данные большого двоичного объекта обрабатываются как данные CSV, отформатированные на диалекте по умолчанию. Его можно переопределить с помощью пользовательского элемента DelimitedTextDialect или DelimitedJsonDialect или ParquetDialect (передается в виде строки или перечисления). Эти диалекты можно передать через соответствующие классы, перечисление QuickQueryDialect или в виде строки.

output_format
DelimitedTextDialect или DelimitedJsonDialect или list[ArrowDialect] или QuickQueryDialect или str

Необязательный элемент. Определяет сериализацию выходных данных для потока данных. По умолчанию данные будут возвращены так, как они представлены в большом двоичном объекте (форматы Parquet по умолчанию — DelimitedTextDialect). Если предоставить выходной формат, данные BLOB-объекта будут переформатированы в соответствии с этим профилем. Это может быть значение DelimitedTextDialect, DelimitedJsonDialect или ArrowDialect. Эти диалекты можно передать через соответствующие классы, перечисление QuickQueryDialect или в виде строки.

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

timeout
int

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

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

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

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

resize_blob

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

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

resize_blob(size: int, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

size
int
Обязательно

Размер, используемый для изменения размера большого двоичного объекта. Максимальный размер страничного BLOB-объекта — до 1 ТБ. Размер страничного большого двоичного объекта необходимо выравнивать по границе в 512 байт.

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

premium_page_blob_tier
PremiumPageBlobTier

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение).

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

seal_append_blob

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

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

seal_append_blob(**kwargs) -> Dict[str, str | datetime | int]

Параметры

appendpos_condition
int

Необязательный условный заголовок, используемый только для операции добавления блока. Число, указывающее смещение байтов для сравнения. Добавление блока будет выполнено успешно, только если позиция добавления равна этому числу. Если это не так, запрос завершится ошибкой AppendPositionConditionNotMet (код состояния HTTP 412 — сбой предварительного условия).

lease
BlobLeaseClient или str

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

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

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

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

Изменение свойства BLOB-объекта (Etag, последнее изменение, смещение добавления, число зафиксированных блоков).

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

set_blob_metadata

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

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

Параметры

metadata
dict(str, str)
Обязательно

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

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение)

set_blob_tags

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

Новые возможности в версии 12.4.0: эта операция появилась в API версии 2019-12-12.

set_blob_tags(tags: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Параметры

tags
dict(str, str)
Обязательно

Пары "имя-значение", связанные с большим двоичным объектом в виде тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые ключ тега и символы значения: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

version_id
str

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

validate_content
bool

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

if_tags_match_condition
str

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

lease
BlobLeaseClient или str

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение)

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

set_http_headers

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

Если для content_settings задано одно свойство, все свойства будут переопределены.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs: Any) -> None

Параметры

content_settings
ContentSettings
Обязательно

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

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение)

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

set_immutability_policy

Операция Set Immutability Policy (Задать политику неизменяемости) задает политику неизменяемости для большого двоичного объекта.

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

set_immutability_policy(immutability_policy: ImmutabilityPolicy, **kwargs: Any) -> Dict[str, str]

Параметры

immutability_policy
ImmutabilityPolicy
Обязательно

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

timeout
int

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

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

Пары "Ключ-значение" тегов BLOB-объектов.

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

Операция Установить удержание по юридическим причинам устанавливает удержание blob-объекта по юридическим причинам.

Новые возможности в версии 12.10.0: эта операция появилась в API версии 2020-10-02.

set_legal_hold(legal_hold: bool, **kwargs: Any) -> Dict[str, str | datetime | bool]

Параметры

legal_hold
bool
Обязательно

Указывает, следует ли установить юридическое удержание для большого двоичного объекта.

timeout
int

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

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

Пары "Ключ-значение" тегов BLOB-объектов.

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

set_premium_page_blob_tier

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

set_premium_page_blob_tier(premium_page_blob_tier: str | PremiumPageBlobTier, **kwargs: Any) -> None

Параметры

premium_page_blob_tier
PremiumPageBlobTier
Обязательно

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

if_tags_match_condition
str

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

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

timeout
int

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

lease
BlobLeaseClient или str

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

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

set_sequence_number

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

set_sequence_number(sequence_number_action: str | SequenceNumberAction, sequence_number: str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

sequence_number_action
str
Обязательно

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

sequence_number
str
Обязательно

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

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

timeout
int

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

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

Словарь свойств, обновленных blob-объектов (Etag и последнее изменение).

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

set_standard_blob_tier

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

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

set_standard_blob_tier(standard_blob_tier: str | StandardBlobTier, **kwargs: Any) -> None

Параметры

standard_blob_tier
str или StandardBlobTier
Обязательно

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

rehydrate_priority
RehydratePriority

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

version_id
str

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

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

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

if_tags_match_condition
str

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

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

timeout
int

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

lease
BlobLeaseClient или str

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

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

stage_block

Создает новую блокировку, которую нужно зафиксировать как часть большого двоичного объекта.

stage_block(block_id: str, data: Iterable | IO, length: int | None = None, **kwargs) -> Dict[str, Any]

Параметры

block_id
str
Обязательно

Строковое значение, идентифицирующее блок. Размер строки должен быть меньше или равен 64 байтам. Для данного большого двоичного объекта block_id должен иметь одинаковый размер для каждого блока.

data
Обязательно

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

length
int
Обязательно

Размер блока.

validate_content
bool

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

lease
BlobLeaseClient или str

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

encoding
str

По умолчанию — UTF-8.

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

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

Дикт свойства BLOB-объекта.

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

stage_block_from_url

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

stage_block_from_url(block_id: str | int, source_url: str, source_offset: int | None = None, source_length: int | None = None, source_content_md5: bytes | bytearray | None = None, **kwargs) -> Dict[str, Any]

Параметры

block_id
str
Обязательно

Строковое значение, идентифицирующее блок. Размер строки должен быть меньше или равен 64 байтам. Для данного большого двоичного объекта block_id должен иметь одинаковый размер для каждого блока.

source_url
str
Обязательно

URL-адрес.

source_offset
int
Обязательно

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

source_length
int
Обязательно

Размер блока в байтах.

source_content_md5
bytearray
Обязательно

Укажите значение md5, вычисленное для диапазона байтов, которые должны быть считаны из источника копирования.

lease
BlobLeaseClient или str

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

source_authorization
str

Проверка подлинности в качестве субъекта-службы с помощью секрета клиента для доступа к исходному BLOB-объекту. Убедитесь, что "bearer" является префиксом строки source_authorization.

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

Дикт свойства BLOB-объекта.

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

start_copy_from_url

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

Эта операция возвращает словарь, содержащий copy_status и copy_id, который можно использовать для проверка состояния или прерывания операции копирования. copy_status будет "успешно", если копирование выполнено синхронно, или "ожидание", если копирование было запущено асинхронно. Для асинхронных копий состояние можно проверить, опрашив get_blob_properties метод и проверив состояние копирования. Задайте для requires_sync значение True, чтобы принудительная синхронизация копирования. Служба BLOB-объектов копирует BLOB-объекты наилучшим возможным образом.

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

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

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

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

start_copy_from_url(source_url: str, metadata: Dict[str, str] | None = None, incremental_copy: bool = False, **kwargs: Any) -> Dict[str, str | datetime]

Параметры

source_url
str
Обязательно

URL-адрес длиной до 2 КБ, указывающий файл или большой двоичный объект. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

metadata
dict(str, str)
Обязательно

Пары «имя-значение», связанные с большим двоичным объектом как метаданные. Если пары "имя-значение" не указаны, операция скопирует метаданные из исходного большого двоичного объекта или файла в целевой BLOB-объект. Если указана одна или несколько пар "имя-значение", целевой BLOB-объект создается с указанными метаданными, а метаданные не копируются из исходного BLOB-объекта или файла.

incremental_copy
bool
Обязательно

Копирует snapshot исходного страничного BLOB-объекта в целевой страничный BLOB-объект. Snapshot копируется таким образом, что в место назначения передаются только разностные изменения между ранее скопированными snapshot. Скопированные моментальные снимки являются полными копиями исходного snapshot и могут быть прочитаны или скопированы из обычной копии. Значение по умолчанию — False.

tags
dict(str, str) или Literal["COPY"]

Пары "имя-значение", связанные с большим двоичным объектом в качестве тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые символы ключа и значения тега: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

Вместо этого литерал COPY (с учетом регистра) можно передать в теги копирования из исходного BLOB-объекта. Этот параметр доступен, только если incremental_copy=False и requires_sync=True.

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

immutability_policy
ImmutabilityPolicy

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

legal_hold
bool

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

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

source_if_modified_since
datetime

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

source_if_unmodified_since
datetime

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

source_etag
str

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

source_match_condition
MatchConditions

Условие соответствия исходного кода, используемое для etag.

if_modified_since
datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения был изменен после указанной даты-времени. Если BLOB-объект назначения не изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено).

if_unmodified_since
datetime

Значение даты и времени. Azure ожидает, что переданное значение даты будет иметь формат UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения не был изменен после указанной даты-времени. Если BLOB-объект назначения изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено).

etag
str

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

match_condition
MatchConditions

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

destination_lease
BlobLeaseClient или str

Идентификатор аренды, указанный для этого заголовка, должен согласовываться с идентификатором аренды большого двоичного объекта назначения. Если запрос не включает идентификатор аренды или не является допустимым, операция оканчивается неудачей с кодом состояния 412 (необходимое условие не выполнено).

source_lease
BlobLeaseClient или str

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

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-объекта, которое необходимо задать для большого двоичного объекта. Для этой версии библиотеки это применимо только к блочных BLOB-объектам в стандартных учетных записях хранения.

rehydrate_priority
RehydratePriority

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

seal_destination_blob
bool

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

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

requires_sync
bool

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

source_authorization
str

Проверка подлинности в качестве субъекта-службы с помощью секрета клиента для доступа к исходному BLOB-объекту. Убедитесь, что "bearer" является префиксом строки source_authorization. Этот параметр доступен только в том случае, если incremental_copy имеет значение False, а requires_sync — значение True.

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

encryption_scope
str

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

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

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

Словарь свойств копирования (etag, last_modified, copy_id copy_status).

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

undelete_blob

Восстанавливает обратимо удаленные BLOB-объекты или моментальные снимки.

Операция будет успешной, только если используется в течение указанного числа дней, заданного в политике хранения удаления.

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

undelete_blob(**kwargs: Any) -> None

Параметры

timeout
int

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

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

upload_blob

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

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

Параметры

data
Обязательно

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

blob_type
BlobType
Обязательно

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

length
int
Обязательно

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

metadata
dict(str, str)
Обязательно

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

tags
dict(str, str)

Пары "имя-значение", связанные с большим двоичным объектом в качестве тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые символы ключа и значения тега: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_)

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

overwrite
bool

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

content_settings
ContentSettings

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

validate_content
bool

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

lease
BlobLeaseClient или str

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

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.

if_tags_match_condition
str

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

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

premium_page_blob_tier
PremiumPageBlobTier

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

standard_blob_tier
StandardBlobTier

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

immutability_policy
ImmutabilityPolicy

Указывает политику неизменяемости большого двоичного объекта, большого двоичного объекта snapshot или версии BLOB-объекта. В настоящее время этот параметр API upload_blob() предназначен только для BlockBlob.

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

legal_hold
bool

Указывает, следует ли установить удержание по юридическим причинам для большого двоичного объекта. В настоящее время этот параметр API upload_blob() предназначен только для BlockBlob.

Новые возможности в версии 12.10.0: эта версия появилась в API версии 2020-10-02.

maxsize_condition
int

Необязательный условный заголовок. Максимальная длина в байтах, разрешенная для добавочного 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, если размер неизвестен.

timeout
int

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

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

Изменение свойства BLOB-объекта (Etag и последнее изменение)

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

upload_blob_from_url

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

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

Параметры

source_url
str
Обязательно

URL-адрес длиной до 2 КБ, указывающий файл или большой двоичный объект. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob? snapshot=

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

overwrite
bool

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

include_source_blob_properties
bool

Указывает, следует ли копировать свойства из исходного BLOB-объекта. Значение по умолчанию — True.

tags
dict(str, str)

Пары "имя-значение", связанные с большим двоичным объектом в виде тега. Теги чувствительны к регистру. Набор тегов может содержать не более 10 тегов. Ключи тегов должны содержать от 1 до 128 символов, а значения тегов — от 0 до 256 символов. Допустимые ключ тега и символы значения: строчные и прописные буквы, цифры (0–9), пробел ( >><<), плюс (+), минус (-), точка (.), solidus (/), двоеточие (:), равно (=), подчеркивание (_).

source_content_md5
bytearray

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

source_if_modified_since
datetime

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

source_if_unmodified_since
datetime

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

source_etag
str

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

source_match_condition
MatchConditions

Условие соответствия исходного кода, используемое для etag.

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.

destination_lease
BlobLeaseClient или str

Идентификатор аренды, указанный для этого заголовка, должен согласовываться с идентификатором аренды большого двоичного объекта назначения. Если запрос не включает идентификатор аренды или не является допустимым, операция оканчивается неудачей с кодом состояния 412 (необходимое условие не выполнено).

timeout
int

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

content_settings
ContentSettings

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

standard_blob_tier
StandardBlobTier

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

source_authorization
str

Проверка подлинности в качестве субъекта-службы с помощью секрета клиента для доступа к исходному BLOB-объекту. Убедитесь, что "bearer" является префиксом строки source_authorization.

upload_page

Операция Отправить страницы записывает диапазон страниц в страничный BLOB-объект.

upload_page(page: bytes, offset: int, length: int, **kwargs) -> Dict[str, str | datetime]

Параметры

page
bytes
Обязательно

Содержимое страницы.

offset
int
Обязательно

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

length
int
Обязательно

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

lease
BlobLeaseClient или str

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

validate_content
bool

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

if_sequence_number_lte
int

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

if_sequence_number_lt
int

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

if_sequence_number_eq
int

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

encoding
str

По умолчанию — UTF-8.

timeout
int

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

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

Словарь свойств, обновленных blob-объектов (Etag и последнее изменение).

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

upload_pages_from_url

Операция Отправить страницы записывает диапазон страниц в страничный BLOB-объект, где содержимое считывается из URL-адреса.

upload_pages_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs) -> Dict[str, Any]

Параметры

source_url
str
Обязательно

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

offset
int
Обязательно

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

length
int
Обязательно

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

source_offset
int
Обязательно

Это указывает на начало диапазона байтов (включительно), который должен быть взят из источника копирования. Служба считывает то же количество байтов, что и диапазон назначения (смещение длины).

source_content_md5
bytes

Если этот параметр задан, служба вычислит md5-хэш содержимого блока и сравнит его с этим значением.

source_if_modified_since
datetime

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

source_if_unmodified_since
datetime

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

source_etag
str

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

source_match_condition
MatchConditions

Условие соответствия исходного кода, используемое для etag.

lease
BlobLeaseClient или str

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

if_sequence_number_lte
int

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

if_sequence_number_lt
int

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

if_sequence_number_eq
int

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

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.

if_tags_match_condition
str

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

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

cpk
CustomerProvidedEncryptionKey

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

encryption_scope
str

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

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

timeout
int

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

source_authorization
str

Проверка подлинности в качестве субъекта-службы с помощью секрета клиента для доступа к исходному BLOB-объекту. Убедитесь, что "bearer" является префиксом строки source_authorization.

Атрибуты

api_version

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

location_mode

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

По умолчанию это будет "основной". Возможные варианты: "primary" и "secondary".

primary_endpoint

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

primary_hostname

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

secondary_endpoint

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

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

Исключения

secondary_hostname

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

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

url

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

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