BlockBlobService Класс

C помощью блочных больших двоичных объектов можно эффективно передавать большие наборы двоичных данных. Блочные большие двоичные объекты состоят из блокировок, каждая из которых обозначается идентификатором блокировки. Чтобы создать или изменить блочный большой двоичный объект, нужно записать набор блокировок и зафиксировать их, указав идентификаторы блокировок. Каждый блок может иметь разный размер, не более 100 МБ, а блочный BLOB-объект может включать до 50 000 блоков. Таким образом, максимальный размер блочного BLOB-объекта составляет примерно 4,75 ТБ (100 МБ x 50 000 блоков). Если вы записываете блочный BLOB-объект размером не более 64 МБ, вы можете отправить его целиком с помощью одной операции записи. см. create_blob_from_bytes.

:type ~azure.storage.common.TokenCredential

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

BaseBlobService

BlockBlobService

Конструктор

BlockBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)

Параметры

account_name

str

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

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

account_key

str

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

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

sas_token

str

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

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

is_emulated

bool

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

Следует ли использовать эмулятор. Значение по умолчанию — False. Если этот параметр указан, переопределяет все остальные параметры, кроме строка подключения и сеанса запроса.

protocol

str

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

Протокол, используемый для запросов. Значение по умолчанию — https.

endpoint_suffix

str

значение по умолчанию: core.windows.net

Базовый компонент узла URL-адреса за вычетом имени учетной записи. По умолчанию используется Azure (core.windows.net). Переопределите его, чтобы использовать облако для Китая (core.chinacloudapi.cn).

custom_domain

str

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

Используемый личный домен. Его можно задать на портале Azure. Например, "www.mydomain.com".

request_session

<xref:requests.Session>

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

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

connection_string

str

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

Если этот параметр указан, будут переопределяться все остальные параметры, кроме сеанса запроса. Формат строка подключения смhttp://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/. в этой статье.

socket_timeout

int

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

Если этот параметр указан, время ожидания сокета по умолчанию переопределяется. Указанное время ожидания — в секундах. Значение по умолчанию см. в разделе DEFAULT_SOCKET_TIMEOUT в _constants.py.

token_credential

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

Учетные данные маркера, используемые для проверки подлинности HTTPS-запросов. Значение токена должно быть обновлено до истечения срока его действия.

Переменные

MAX_SINGLE_PUT_SIZE

int

Самый большой размер отправки, поддерживаемый в одном вызове put. Используется методами create_blob_from_*, если длина содержимого известна и меньше этого значения.

MAX_BLOCK_SIZE

int

Размер блоков, помещаемых методами create_blob_from_*, если длина содержимого неизвестна или больше MAX_SINGLE_PUT_SIZE. Можно поместить более мелкие блоки. Максимальный размер блока, поддерживаемый службой, составляет 100 МБ.

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD

int

Минимальный размер блока, при котором учитывается оптимизированный для памяти алгоритм отправки блоков. Этот алгоритм применим только к методам create_blob_from_file и create_blob_from_stream и предотвращает полную буферизацию блоков. В дополнение к размеру блока необходимо отключить проверку ContentMD5 и шифрование, так как для этих параметров требуется буферизация блоков.

Методы

abort_copy_blob	Прерывает ожидающие операции copy_blob и оставляет целевой BLOB-объект нулевой длины и полные метаданные.
acquire_blob_lease	Запрашивает новую аренду. Если большой двоичный объект не имеет активной аренды, то служба BLOB-объектов создает аренду и возвращает ее идентификатор.
acquire_container_lease	Запрашивает новую аренду. Если контейнер не имеет активной аренды, то служба BLOB-объектов создает аренду для контейнера и возвращает новый идентификатор аренды.
batch_delete_blobs	Отправляет пакет из нескольких запросов на удаление BLOB-объектов. Метод удаления большого двоичного объекта удаляет указанный большой двоичный объект или snapshot. Обратите внимание, что при удалении большого двоичного объекта также удаляются все его моментальные снимки. Дополнительные сведения см. в разделе https://docs.microsoft.com/rest/api/storageservices/delete-blob.
batch_set_standard_blob_tier	Отправляет пакет из нескольких заданных запросов на уровни блочных BLOB-объектов. Этот API поддерживается только для блочных BLOB-объектов в учетных записях хранения уровня "Стандартный".
break_blob_lease	Прекращает аренду, если большой двоичный объект имеет активную аренду. После прекращения аренду нельзя продлить. Авторизованный запрос может прекратить аренду. В запросе не обязательно указывать соответствующий идентификатор аренды. При прерывании аренды допускается истечение периода перерыва аренды, в течение которого в большом двоичном объекте не может быть выполнена операция аренды, кроме перерыва и освобождения. После успешного прекращения аренды ответ указывает интервал в секундах, прежде чем можно будет приобрести новую аренду. Прекращенную аренду также можно освободить, в этом случае другой клиент сразу сможет приобрести аренду на большой двоичный объект.
break_container_lease	Прекращение аренды, если у контейнера есть активная аренда. После прекращения аренду нельзя продлить. Авторизованный запрос может прекратить аренду. В запросе не обязательно указывать соответствующий идентификатор аренды. При прерывании аренды допускается период перерыва аренды, в течение которого в контейнере не может быть выполнена операция аренды, кроме перерыва и освобождения. После успешного прекращения аренды ответ указывает интервал в секундах, прежде чем можно будет приобрести новую аренду.
change_blob_lease	Изменяет идентификатор активной аренды. Изменение должно включать текущий идентификатор аренды и новый идентификатор аренды.
change_container_lease	Изменение идентификатора активной аренды. Изменение должно включать текущий идентификатор аренды и новый идентификатор аренды.
copy_blob	Копирует большой двоичный объект. Эта операция возвращает объект свойств операции копирования. Операция копирования может быть настроена как асинхронная операция с наилучшими усилиями или синхронная операция. Если requires_sync имеет значение true, источником должен быть блочный BLOB-объект. Все существующие BLOB-объекты назначения будут перезаписаны. BLOB-объект назначения не может быть изменен, пока происходит операция копирования. При копировании из блочного BLOB-объекта копируются все зафиксированные блоки и их идентификаторы блоков. Незафиксированные блоки не копируются. В конце операции копирования целевой BLOB-объект будет иметь то же количество зафиксированных блоков, что и источник. Для проверка состояния операции копирования можно вызвать get_blob_properties в целевом BLOB-объекте. После завершения копирования конечный BLOB-объект будет зафиксирован. Имя контейнера назначения. Контейнер должен существовать. :p aram str blob_name: имя целевого большого двоичного объекта. Если целевой BLOB-объект существует, он будет перезаписан. В противном случае он будет создан. :p aram str copy_source: URL-адрес длиной до 2 КБ, указывающий файл Или большой двоичный объект Azure. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken метаданные :p aram: пары "имя-значение", связанные с большим двоичным объектом в качестве метаданных. Если пары "имя-значение" не указаны, операция скопирует метаданные из исходного большого двоичного объекта или файла в целевой BLOB-объект. Если указана одна или несколько пар "имя-значение", целевой BLOB-объект создается с указанными метаданными, а метаданные не копируются из исходного BLOB-объекта или файла. :type metadata: dict(str, str) :p aram datetime source_if_modified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если BLOB-объект источника был изменен, начиная с указанной даты-времени. :p aram datetime source_if_unmodified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если BLOB-объект источника не был изменен, начиная с указанной даты-времени. :p aram ETag source_if_match: значение ETag или подстановочный знак (). Укажите этот условный заголовок, чтобы скопировать исходный BLOB-объект, только если его ETag соответствует указанному значению. Если значения ETag не совпадают, служба BLOB-объектов возвращает код состояния 412 (сбой условия). Этот заголовок нельзя указать, если источником является файл Azure. :p aram ETag source_if_none_match: значение ETag или подстановочный знак (). Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если его значение ETag не согласуется с указанным значением. Если значения совпадают, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). Этот заголовок нельзя указать, если источником является файл Azure. :p aram datetime destination_if_modified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения был изменен после указанной даты-времени. Если BLOB-объект назначения не изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p aram datetime destination_if_unmodified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения не был изменен после указанной даты-времени. Если BLOB-объект назначения изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p destination_if_match ETag: значение ETag или подстановочный знак (). Укажите значение ETag для этого условного заголовка, чтобы скопировать большой двоичный объект, только если указанное значение ETag совпадает со значением ETag для существующего целевого BLOB-объекта. Если ETag для целевого BLOB-объекта не соответствует ETag, указанному в параметре If-Match, служба BLOB-объектов возвращает код состояния 412 (сбой предварительного условия). :p aram ETag destination_if_none_match: значение ETag или подстановочный знак (). Укажите значение ETag для этого заголовка условной операции, чтобы копировать BLOB-объект, только если указанное значение ETag не согласуется со значением ETag для большого двоичного объекта назначения. Укажите символ-шаблон (*), чтобы операция выполнялась, только если BLOB-объект назначения не существует. Если указанное условие не соблюдено, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p aram str destination_lease_id: идентификатор аренды, указанный для этого заголовка, должен соответствовать идентификатору аренды целевого blob-объекта. Если запрос не включает идентификатор аренды или не является допустимым, операция оканчивается неудачей с кодом состояния 412 (необходимое условие не выполнено). :p aram str source_lease_id. Укажите этот параметр, чтобы выполнить операцию копирования BLOB-объекта, только если предоставленный идентификатор аренды соответствует идентификатору активной аренды исходного BLOB-объекта. :p aram int timeout: параметр timeout выражается в секундах. :p bool requires_sync. Указывает, что служба не вернет ответ до завершения копирования. :p aram StandardBlobTier standard_blob_tier: значение уровня "Стандартный" для большого двоичного объекта. Для этой версии библиотеки это применимо только для блочных BLOB-объектов в стандартных учетных записях хранения. :p aram RehydratePriority rehydrate_priority: указывает приоритет восстановления архивного большого двоичного объекта :return: свойства операции копирования, такие как состояние, источник и идентификатор. :rtype: CopyProperties
create_blob_from_bytes	Создает новый большой двоичный объект из массива байтов или обновляет содержимое существующего большого двоичного объекта с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_blob_from_path	Создает новый BLOB-объект из пути к файлу или обновляет содержимое существующего большого двоичного объекта с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_blob_from_stream	Создает новый BLOB-объект из файла или потока или обновляет содержимое существующего большого двоичного объекта с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_blob_from_text	Создает новый большой двоичный объект из str/Unicode или обновляет содержимое существующего большого двоичного объекта с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_container	Создает новый контейнер в указанной учетной записи. Если контейнер с тем же именем уже существует, операция завершается ошибкой, если fail_on_exist имеет значение True.
delete_blob	Помечает указанный большой двоичный объект или snapshot для удаления. В дальнейшем большой двоичный объект удаляется в процессе сборки мусора. Обратите внимание, что для удаления большого двоичного объекта необходимо удалить все его моментальные снимки. Вы можете удалить оба одновременно с помощью операции Удалить BLOB-объект. Если для службы включена политика хранения удаления, то при выполнении этой операции выполняется обратимое удаление большого двоичного объекта или snapshot и сохранение большого двоичного объекта или snapshot в течение указанного количества дней. По истечении указанного количества дней данные BLOB-объекта удаляются из службы во время сборки мусора. Обратимо удаленный BLOB-объект или snapshot доступен через API списка BLOB-объектов, указав параметр include=Include.Deleted. Обратимо удаленный BLOB-объект или snapshot можно восстановить с помощью API отмены удаления.
delete_container	Помечает указанный контейнер для удаления. Контейнер и все большие двоичные объекты внутри него будут удалены позднее в процессе сборки мусора.
exists	Возвращает логическое значение, указывающее, существует ли контейнер (если blob_name имеет значение None), или логическое значение, указывающее, существует ли большой двоичный объект.
extract_date_and_request_id
generate_account_shared_access_signature	Создает подписанный URL-адрес для службы BLOB-объектов. Используйте возвращенную сигнатуру с параметром sas_token любого объекта BlobService.
generate_blob_shared_access_signature	Создает подписанный URL-адрес для большого двоичного объекта или одного из его моментальных снимков. Используйте возвращенную сигнатуру с параметром sas_token любого объекта BlobService.
generate_container_shared_access_signature	Создает подписанный URL-адрес для контейнера. Используйте возвращенную сигнатуру с параметром sas_token любого объекта BlobService.
get_blob_account_information	Получает сведения, связанные с учетной записью хранения. Сведения также можно получить, если у пользователя есть SAS для контейнера или большого двоичного объекта.
get_blob_metadata	Возвращает все пользовательские метаданные для указанного большого двоичного объекта или snapshot.
get_blob_properties	Возвращает все пользовательские метаданные, стандартные свойства HTTP и системные свойства большого двоичного объекта. Операция не возвращает содержимое большого двоичного объекта. Возвращает Blob с BlobProperties и дикт метаданных.
get_blob_service_properties	Возвращает свойства службы BLOB-объектов учетной записи хранения, включая azure Аналитика Службы хранилища.
get_blob_service_stats	Получает статистику, связанную с репликацией службы BLOB-объектов. Он доступен, только если для учетной записи хранения включена геоизбыточная репликация с доступом на чтение. Благодаря географически избыточной репликации хранилище Azure надежно хранит ваши данные в двух расположениях. В обоих расположениях хранилище Azure поддерживает несколько работоспособных копий данных. Расположение, в котором вы читаете, создаете, обновляете или удаляете данные, является первичным расположением учетной записи хранилища. Основное расположение находится в регионе, выбранном при создании учетной записи с помощью классического портала Azure управления Azure, например в центрально-северной части США. Расположение, в которое ваши данные реплицируются, — это вторичное расположение. Оно определяется автоматически, исходя из выбранного первичного расположения. Это второй центр обработки данных в том же регионе, где находится первичное расположение. Во вторичном расположении предоставляется доступ только для чтения, если для вашей учетной записи хранилища включена географически избыточная репликация с доступом только для чтения.
get_blob_to_bytes	Загружает BLOB-объект в виде массива байтов с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами, метаданными и содержимым.
get_blob_to_path	Загружает BLOB-объект в путь к файлу с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами и метаданными.
get_blob_to_stream	Загружает BLOB-объект в поток с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами и метаданными.
get_blob_to_text	Загружает BLOB-объект в виде текста Юникода с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами, метаданными и содержимым.
get_block_list	Извлекает список блокировок, которые были загружены как часть блочного большого двоичного объекта. Для BLOB-объектов поддерживаются два списка блокировок. Список блокировок фиксации. Список блоков, успешно зафиксированных в заданном большом двоичном объекте с помощью put block List. Список незафиксированных блокировок. Список блоков, которые были отправлены для большого двоичного объекта с помощью put block, но еще не зафиксированы. Эти блокировки хранятся в Azure в сопоставлении с BLOB-объектом, но еще не являются его частью.
get_container_acl	Возвращает разрешения для указанного контейнера. Разрешения показывают, имеется ли общий доступ к данным контейнера.
get_container_metadata	Возвращает все определяемые пользователем метаданные для указанного контейнера.
get_container_properties	Возвращает все определяемые пользователем метаданные и системные свойства для указанного контейнера. Возвращаемые данные не включают список BLOB-объектов контейнера.
get_user_delegation_key	Получите ключ делегирования пользователя для подписывания маркеров SAS. Для успешного выполнения этого запроса в объекте службы должны присутствовать учетные данные маркера.
list_blob_names	Возвращает генератор для перечисления имен BLOB-объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться, когда будут возвращены все большие двоичные объекты или достигнут num_results. Если указано num_results и в учетной записи больше указанного количества BLOB-объектов, генератор будет иметь заполненное поле next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
list_blobs	Возвращает генератор для вывода списка больших двоичных объектов в указанном контейнере. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возвращении всех больших двоичных объектов или достижении num_results. Если указано num_results и в учетной записи больше, чем это количество BLOB-объектов, генератор будет иметь заполненное поле next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
list_containers	Возвращает генератор для вывода списка контейнеров в указанной учетной записи. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возвращении всех контейнеров или достижении num_results. Если указано num_results и у учетной записи больше контейнеров, генератор будет иметь заполненное поле next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
make_blob_url	Создает URL-адрес для доступа к большому двоичному объекту.
make_container_url	Создает URL-адрес для доступа к контейнеру.
put_block	Создает новую блокировку, которую нужно зафиксировать как часть большого двоичного объекта.
put_block_from_url	Создает новую блокировку, которую нужно зафиксировать как часть большого двоичного объекта.
put_block_list	Записывает большой двоичный объект, указывая список идентификаторов составляющих его блокировок. Чтобы записать как часть большого двоичного объекта, блок должен быть успешно записан на сервер в ходе предыдущей операции put block. Вы можете вызвать команду Put Block List, чтобы обновить большой двоичный объект, отправив только те блоки, которые изменились, а затем зафиксировав новые и существующие блоки вместе. Это можно сделать, указав, следует фиксировать блокировку из списка зафиксированных блокировок или из списка незафиксированных блокировок, либо можно зафиксировать последнюю переданную версию блокировки, к какому бы списку она ни принадлежала.
release_blob_lease	Освобождает аренду. Аренду можно освободить, если ее идентификатор, указанный в запросе, соответствует идентификатору, связанному с большим двоичным объектом. Освобождение аренды позволяет другому клиенту сразу приобрести аренду для большого двоичного объекта.
release_container_lease	Освобождает аренду. Аренда может быть освобождена, если указанный lease_id соответствует связанному с контейнером. Освобождение аренды позволяет другому клиенту сразу приобрести аренду для контейнера.
renew_blob_lease	Продлевает аренду. Аренду можно продлить, если ее идентификатор, указанный в запросе, соответствует идентификатору, связанному с большим двоичным объектом. Обратите внимание, что аренда может быть продлена, если ее срок истек и если большой двоичный объект не был изменен и не получил новую аренду с момента истечения срока. При продлении аренды срок действия начинается заново.
renew_container_lease	Продлевает аренду. Аренда может быть продлена, если указанный идентификатор аренды соответствует связанному с контейнером. Обратите внимание, что аренда может быть продлена, если ее срок истек и если для контейнера не было повторной аренды с момента истечения срока. При продлении аренды срок действия начинается заново.
set_blob_metadata	Задает определяемые пользователем метаданные для определенного большого двоичного объекта в виде одной или нескольких пар "имя — значение".
set_blob_properties	Задает системные свойства для большого двоичного объекта. Если для content_settings задано одно свойство, все свойства будут переопределены.
set_blob_service_properties	Задает свойства службы BLOB-объектов учетной записи хранения, включая Аналитика Службы хранилища Azure. Если элемент (например, Ведение журнала) остается как Нет, существующие в службе параметры для этой функции сохраняются.
set_container_acl	Задает разрешения для указанного контейнера или хранимых политик доступа, которые могут использоваться с подписанными URL-адресами. Разрешения показывают, имеется ли общий доступ к BLOB-объектам контейнера.
set_container_metadata	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанного контейнера. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к контейнеру. Чтобы удалить все метаданные из контейнера, вызовите эту операцию без дикта метаданных.
set_proxy	Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT.
set_standard_blob_tier	Задает уровни блочных BLOB-объектов в большом двоичном объекте. Этот API поддерживается только для блочных BLOB-объектов в учетных записях хранения уровня "Стандартный". :p aram RehydratePriority rehydrate_priority: указывает приоритет восстановления архивного большого двоичного объекта.
snapshot_blob	Создает доступный только для чтения моментальный снимок BLOB-объекта.
undelete_blob	Операция отмены удаления большого двоичного объекта восстанавливает содержимое и метаданные обратимо удаленного BLOB-объекта или snapshot. Попытка отменить удаление большого двоичного объекта или snapshot, которые не являются обратимо удаленными, будет выполнена без каких-либо изменений.

abort_copy_blob

Прерывает ожидающие операции copy_blob и оставляет целевой BLOB-объект нулевой длины и полные метаданные.

abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя целевого контейнера.

blob_name

str

Обязательно

Имя целевого BLOB-объекта.

copy_id

str

Обязательно

Идентификатор копирования, указанный в copy.id исходной операции copy_blob.

lease_id

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

acquire_blob_lease

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

acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

lease_duration

int

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

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

proposed_lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

str

acquire_container_lease

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

acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_duration

int

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

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

proposed_lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

str

batch_delete_blobs

Отправляет пакет из нескольких запросов на удаление BLOB-объектов.

Метод удаления большого двоичного объекта удаляет указанный большой двоичный объект или snapshot. Обратите внимание, что при удалении большого двоичного объекта также удаляются все его моментальные снимки. Дополнительные сведения см. в разделе https://docs.microsoft.com/rest/api/storageservices/delete-blob.

batch_delete_blobs(batch_delete_sub_requests, timeout=None)

Параметры

batch_delete_sub_requests

list(BatchDeleteSubRequest)

Обязательно

Запросы на удаление BLOB-объекта для отправки в виде пакета.

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

проанализированный пакетный ответ на удаление HTTP

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

list <xref:of> BatchSubResponse

batch_set_standard_blob_tier

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

batch_set_standard_blob_tier(batch_set_blob_tier_sub_requests, timeout=None)

Параметры

batch_set_blob_tier_sub_requests

list(BatchSetBlobTierSubRequest)

Обязательно

Заданный уровень блочных BLOB-объектов запрашивает отправку в виде пакета.

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

проанализированный http-ответ уровня пакетного набора, который указывает, успешно ли выполнен каждый вложенный запрос.

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

list <xref:of> BatchSubResponse

break_blob_lease

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

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

break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

lease_break_period

int

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

Для операции перерыва это предлагаемая продолжительность в секундах, когда аренда должна продолжаться, прежде чем она будет прервана, в диапазоне от 0 до 60 секунд. Период прерывания используется только в том случае, если он не превышает оставшееся время аренды. В противном случае используется оставшееся время аренды. Новая аренда не будет доступна до истечения срока прерывания, однако аренду можно удерживать дольше срока прерывания. Если этот заголовок не отображается с операцией приостановки, по истечении оставшегося периода аренды будет разрыв фиксированной длительности, а также немедленное прерывание бесконечной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

INT

break_container_lease

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

break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_break_period

int

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

Это предлагаемая продолжительность аренды в секундах, прежде чем она будет нарушена, в диапазоне от 0 до 60 секунд. Период прерывания используется только в том случае, если он не превышает оставшееся время аренды. В противном случае используется оставшееся время аренды. Новая аренда не будет доступна до истечения срока прерывания, однако аренду можно удерживать дольше срока прерывания. Если этот заголовок не отображается с операцией приостановки, по истечении оставшегося периода аренды будет разрыв фиксированной длительности, а также немедленное прерывание бесконечной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

INT

change_blob_lease

Изменяет идентификатор активной аренды. Изменение должно включать текущий идентификатор аренды и новый идентификатор аренды.

change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

lease_id

str

Обязательно

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

proposed_lease_id

str

Обязательно

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

change_container_lease

Изменение идентификатора активной аренды. Изменение должно включать текущий идентификатор аренды и новый идентификатор аренды.

change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

str

Обязательно

Идентификатор аренды для активной аренды.

proposed_lease_id

str

Обязательно

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

copy_blob

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

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

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

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

Имя контейнера назначения. Контейнер должен существовать. :p aram str blob_name: имя целевого большого двоичного объекта. Если целевой BLOB-объект существует, он будет перезаписан. В противном случае он будет создан. :p aram str copy_source: URL-адрес длиной до 2 КБ, указывающий файл Или большой двоичный объект Azure. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.blob.core.windows.net/mycontainer/myblobhttps://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken метаданные :p aram: пары "имя-значение", связанные с большим двоичным объектом в качестве метаданных. Если пары "имя-значение" не указаны, операция скопирует метаданные из исходного большого двоичного объекта или файла в целевой BLOB-объект. Если указана одна или несколько пар "имя-значение", целевой BLOB-объект создается с указанными метаданными, а метаданные не копируются из исходного BLOB-объекта или файла. :type metadata: dict(str, str) :p aram datetime source_if_modified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если BLOB-объект источника был изменен, начиная с указанной даты-времени. :p aram datetime source_if_unmodified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если BLOB-объект источника не был изменен, начиная с указанной даты-времени. :p aram ETag source_if_match: значение ETag или подстановочный знак (). Укажите этот условный заголовок, чтобы скопировать исходный BLOB-объект, только если его ETag соответствует указанному значению. Если значения ETag не совпадают, служба BLOB-объектов возвращает код состояния 412 (сбой условия). Этот заголовок нельзя указать, если источником является файл Azure. :p aram ETag source_if_none_match: значение ETag или подстановочный знак (). Задайте этот заголовок условной операции, чтобы BLOB-объект копировался, только если его значение ETag не согласуется с указанным значением. Если значения совпадают, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). Этот заголовок нельзя указать, если источником является файл Azure. :p aram datetime destination_if_modified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения был изменен после указанной даты-времени. Если BLOB-объект назначения не изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p aram datetime destination_if_unmodified_since: значение DateTime. Azure ожидает, что передаваемое значение даты должно быть в формате UTC. Если включен часовой пояс, все значения даты и времени, отличные от UTC, будут преобразованы в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC. Задайте этот заголовок условной операции, чтобы копировать BLOB-объект, только если BLOB-объект назначения не был изменен после указанной даты-времени. Если BLOB-объект назначения изменен, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p destination_if_match ETag: значение ETag или подстановочный знак (). Укажите значение ETag для этого условного заголовка, чтобы скопировать большой двоичный объект, только если указанное значение ETag совпадает со значением ETag для существующего целевого BLOB-объекта. Если ETag для целевого BLOB-объекта не соответствует ETag, указанному в параметре If-Match, служба BLOB-объектов возвращает код состояния 412 (сбой предварительного условия). :p aram ETag destination_if_none_match: значение ETag или подстановочный знак (). Укажите значение ETag для этого заголовка условной операции, чтобы копировать BLOB-объект, только если указанное значение ETag не согласуется со значением ETag для большого двоичного объекта назначения. Укажите символ-шаблон (*), чтобы операция выполнялась, только если BLOB-объект назначения не существует. Если указанное условие не соблюдено, то служба BLOB-объектов возвращает код состояния 412 (необходимое условие не выполнено). :p aram str destination_lease_id: идентификатор аренды, указанный для этого заголовка, должен соответствовать идентификатору аренды целевого blob-объекта. Если запрос не включает идентификатор аренды или не является допустимым, операция оканчивается неудачей с кодом состояния 412 (необходимое условие не выполнено). :p aram str source_lease_id. Укажите этот параметр, чтобы выполнить операцию копирования BLOB-объекта, только если предоставленный идентификатор аренды соответствует идентификатору активной аренды исходного BLOB-объекта. :p aram int timeout: параметр timeout выражается в секундах. :p bool requires_sync. Указывает, что служба не вернет ответ до завершения копирования. :p aram StandardBlobTier standard_blob_tier: значение уровня "Стандартный" для большого двоичного объекта. Для этой версии библиотеки это применимо только для блочных BLOB-объектов в стандартных учетных записях хранения. :p aram RehydratePriority rehydrate_priority: указывает приоритет восстановления архивного большого двоичного объекта :return: свойства операции копирования, такие как состояние, источник и идентификатор. :rtype: CopyProperties

copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None, requires_sync=None, standard_blob_tier=None, rehydrate_priority=None)

Параметры

container_name

str

Обязательно

blob_name

Обязательно

copy_source

Обязательно

metadata

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

source_if_modified_since

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

source_if_unmodified_since

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

source_if_match

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

source_if_none_match

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

destination_if_modified_since

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

destination_if_unmodified_since

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

destination_if_match

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

destination_if_none_match

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

destination_lease_id

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

source_lease_id

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

timeout

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

requires_sync

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

standard_blob_tier

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

rehydrate_priority

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

create_blob_from_bytes

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

create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

blob

bytes

Обязательно

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

index

int

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

Начальный индекс в массиве байтов.

count

int

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

Количество байтов для отправки. Задайте значение Нет или отрицательное значение, чтобы передать все байты, начиная с индекса.

content_settings

ContentSettings

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

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

metadata

dict(str, str)

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

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

validate_content

bool

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

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, или None, если общий размер неизвестен.

max_connections

int

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

standard_blob_tier

StandardBlobTier

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

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

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

ETag и последние измененные свойства для блочного BLOB-объекта

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

ResourceProperties

create_blob_from_path

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

create_blob_from_path(container_name, blob_name, file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

file_path

str

Обязательно

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

content_settings

ContentSettings

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

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

metadata

dict(str, str)

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

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

validate_content

bool

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

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, или None, если общий размер неизвестен.

max_connections

int

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.

standard_blob_tier

StandardBlobTier

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

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

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

ETag и последние измененные свойства блочного BLOB-объекта

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

ResourceProperties

create_blob_from_stream

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

create_blob_from_stream(container_name, blob_name, stream, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, use_byte_buffer=False, standard_blob_tier=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

stream

IOBase

Обязательно

Открыт файл или поток для отправки в качестве содержимого BLOB-объекта.

count

int

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

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

content_settings

ContentSettings

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

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

metadata

dict(str, str)

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

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

validate_content

bool

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

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, или None, если общий размер неизвестен.

max_connections

int

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.

use_byte_buffer

bool

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

Если задано значение True, это приведет к принудительному использованию исходного пути передачи буферизации полного блока. По умолчанию это значение равно False и будет использовать эффективный в памяти алгоритм потоковой передачи при следующих условиях: предоставленный поток доступен для поиска, require_encryption — False, а MAX_BLOCK_SIZE >= MIN_LARGE_BLOCK_UPLOAD_THRESHOLD. Следует учитывать недостатки использования этого подхода. Для достижения эффективности памяти поток IOBase или файлоподобный объект сегментируется на логические блоки с помощью оболочки SubStream. Чтобы прочитать правильные данные, каждый вложенный поток должен получить блокировку, чтобы он смог безопасно искать нужную позицию в общем базовом потоке. Если max_connections > 1, параллелизм приведет к значительному количеству поиска в базовом потоке. Для наиболее распространенных входных данных, таких как файловый объект потока, поиск является недорогой операцией, и это не очень важно. Однако для других вариантов потоков это может быть не так. Компромисс для эффективности памяти должен быть взвешен с затратами на поиск с помощью входного потока. Класс SubStream попытается выполнить внутренний буфер размером до 4 МБ, чтобы уменьшить количество вызовов поиска и чтения к базовому потоку. Это особенно полезно при отправке больших блоков.

standard_blob_tier

StandardBlobTier

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

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

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

ETag и последние измененные свойства блочного BLOB-объекта

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

ResourceProperties

create_blob_from_text

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

create_blob_from_text(container_name, blob_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

text

str

Обязательно

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

encoding

str

значение по умолчанию: utf-8

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

content_settings

ContentSettings

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

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

metadata

dict(str, str)

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

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

validate_content

bool

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

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

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, или None, если общий размер неизвестен.

max_connections

int

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.

standard_blob_tier

StandardBlobTier

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

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

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

ETag и последние измененные свойства блочного BLOB-объекта

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

ResourceProperties

create_container

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

create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)

Параметры

container_name

str

Обязательно

Имя создаваемого контейнера. Имя контейнера может содержать только строчные буквы, цифры и дефисы и должно начинаться с буквы или цифры. Перед каждым дефисом должен быть знак без дефиса. Количество символов в имени должно быть от 3 до 63.

metadata

dict(str, str)

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

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

public_access

PublicAccess

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

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

fail_on_exist

bool

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

Укажите, следует ли создавать исключение при наличии контейнера.

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Значение true, если контейнер создан, false, если контейнер уже существует.

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

bool

delete_blob

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

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

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

delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

snapshot

str

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

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

lease_id

str

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

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

delete_snapshots

DeleteSnapshot

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

delete_container

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

delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя удаляемого контейнера.

fail_not_exist

bool

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

Укажите, следует ли создавать исключение, если контейнер не существует.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Значение true, если контейнер удален, контейнер False не существует.

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

bool

exists

Возвращает логическое значение, указывающее, существует ли контейнер (если blob_name имеет значение None), или логическое значение, указывающее, существует ли большой двоичный объект.

exists(container_name, blob_name=None, snapshot=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя контейнера.

blob_name

str

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

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

snapshot

str

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

Параметр snapshot является непрозрачным значением DateTime, которое при наличии указывает snapshot.

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Логическое значение, указывающее, существует ли ресурс.

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

bool

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

Параметры

retry_context

Обязательно

generate_account_shared_access_signature

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

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

Параметры

resource_types

<xref:ResourceTypes>

Обязательно

Указывает типы ресурсов, доступные с помощью SAS учетной записи.

permission

<xref:AccountPermissions>

Обязательно

Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Требуется, если не предоставлен идентификатор, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.

expiry

datetime или str

Обязательно

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

start

datetime или str

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

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

ip

str

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

Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.

protocol

str

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

Указывает протокол, разрешенный для выполненного запроса. Значение по умолчанию — https,http. Возможные значения приведены в разделе Protocol.

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

Маркер подписанного URL-адреса (SAS).

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

str

generate_blob_shared_access_signature

Создает подписанный URL-адрес для большого двоичного объекта или одного из его моментальных снимков. Используйте возвращенную сигнатуру с параметром sas_token любого объекта BlobService.

generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Параметры

container_name

str

Обязательно

Имя контейнера.

blob_name

str

Обязательно

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

snapshot

str

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

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

permission

BlobPermissions

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

Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Разрешения должны быть упорядочены для чтения, записи, удаления, списка. Требуется, если идентификатор не указан, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.

expiry

datetime или str

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

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

start

datetime или str

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

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

id

str

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

Уникальное значение длиной до 64 символов, коррелирует с хранимой политикой доступа. Чтобы создать хранимую политику доступа, используйте .set_container_acl

ip

str

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

Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.

protocol

str

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

Указывает протокол, разрешенный для выполненного запроса. Значение по умолчанию — https,http. Возможные значения приведены в разделе Protocol.

cache_control

str

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

Значение заголовка ответа для Cache-Control при обращении к ресурсу с помощью этой подписанной URL-адреса.

content_disposition

str

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

Значение заголовка ответа для Content-Disposition при доступе к ресурсу с помощью этой подписанной url-адреса.

content_encoding

str

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

Значение заголовка ответа для Content-Encoding при доступе к ресурсу с помощью этой подписанной url-адреса.

content_language

str

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

Значение заголовка ответа для Content-Language при доступе к ресурсу с помощью этой подписанной url-адреса.

content_type

str

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

Значение заголовка ответа content-Type при доступе к ресурсу с помощью этой подписанной url-адреса.

user_delegation_key

UserDelegationKey

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

Вместо ключа учетной записи пользователь может передать ключ делегирования пользователя. Ключ делегирования пользователя можно получить из службы, выполнив проверку подлинности с помощью удостоверения AAD; Это можно сделать, вызвав get_user_delegation_key. При наличии SAS подписывается с помощью ключа делегирования пользователя.

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

Маркер подписанного URL-адреса (SAS).

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

str

generate_container_shared_access_signature

Создает подписанный URL-адрес для контейнера. Используйте возвращенную сигнатуру с параметром sas_token любого объекта BlobService.

generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)

Параметры

container_name

str

Обязательно

Имя контейнера.

permission

ContainerPermissions

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

Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Разрешения должны быть упорядочены для чтения, записи, удаления, списка. Требуется, если идентификатор не указан, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.

expiry

datetime или str

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

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

start

datetime или str

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

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

id

str

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

Уникальное значение длиной до 64 символов, коррелирует с хранимой политикой доступа. Чтобы создать хранимую политику доступа, используйте set_blob_service_properties.

ip

str

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

Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.

protocol

str

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

Указывает протокол, разрешенный для выполненного запроса. Значение по умолчанию — https,http. Возможные значения приведены в разделе Protocol.

cache_control

str

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

Значение заголовка ответа для Cache-Control при обращении к ресурсу с помощью этой подписанной URL-адреса.

content_disposition

str

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

Значение заголовка ответа для Content-Disposition при доступе к ресурсу с помощью этой подписанной url-адреса.

content_encoding

str

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

Значение заголовка ответа для Content-Encoding при доступе к ресурсу с помощью этой подписанной url-адреса.

content_language

str

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

Значение заголовка ответа для Content-Language при доступе к ресурсу с помощью этой подписанной url-адреса.

content_type

str

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

Значение заголовка ответа content-Type при доступе к ресурсу с помощью этой подписанной url-адреса.

user_delegation_key

UserDelegationKey

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

Вместо ключа учетной записи пользователь может передать ключ делегирования пользователя. Ключ делегирования пользователя можно получить из службы, выполнив проверку подлинности с помощью удостоверения AAD; Это можно сделать, вызвав get_user_delegation_key. При наличии SAS подписывается с помощью ключа делегирования пользователя.

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

Маркер подписанного URL-адреса (SAS).

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

str

get_blob_account_information

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

get_blob_account_information(container_name=None, blob_name=None, timeout=None)

Параметры

container_name

str

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

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

blob_name

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

AccountInformation.

get_blob_metadata

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

get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

snapshot

str

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

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

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

dict(str, str)

get_blob_properties

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

get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

snapshot

str

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

объект BLOB-объекта, включающий свойства и метаданные.

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

Blob

get_blob_service_properties

Возвращает свойства службы BLOB-объектов учетной записи хранения, включая azure Аналитика Службы хранилища.

get_blob_service_properties(timeout=None)

Параметры

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Большой двоичный объект ServiceProperties с присоединенным свойством target_version.

get_blob_service_stats

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

Благодаря географически избыточной репликации хранилище Azure надежно хранит ваши данные в двух расположениях. В обоих расположениях хранилище Azure поддерживает несколько работоспособных копий данных. Расположение, в котором вы читаете, создаете, обновляете или удаляете данные, является первичным расположением учетной записи хранилища. Основное расположение находится в регионе, выбранном при создании учетной записи с помощью классического портала Azure управления Azure, например в центрально-северной части США. Расположение, в которое ваши данные реплицируются, — это вторичное расположение. Оно определяется автоматически, исходя из выбранного первичного расположения. Это второй центр обработки данных в том же регионе, где находится первичное расположение. Во вторичном расположении предоставляется доступ только для чтения, если для вашей учетной записи хранилища включена географически избыточная репликация с доступом только для чтения.

get_blob_service_stats(timeout=None)

Параметры

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Статистика службы BLOB-объектов.

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

ServiceStats

get_blob_to_bytes

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

get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

snapshot

str

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

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

start_range

int

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

Начало диапазона байтов, используемого для скачивания раздела большого двоичного объекта. Если end_range не задано, скачиваются все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

end_range

int

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

Конец диапазона байтов, используемый для скачивания раздела большого двоичного объекта. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

validate_content

bool

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

Если задано значение true, проверяет хэш MD5 для каждой извлеченной части большого двоичного объекта. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные MD5 только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если самостоятельно. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, возникает ошибка. Поскольку вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может увеличиться.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, если он известен.

max_connections

int

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

Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов большого двоичного объекта. Если это весь большой двоичный объект, метод возвращает на этом этапе. Если это не так, он будет скачивать оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый кусок будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если следует использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если ожидается, что многие большие двоичные объекты будут пустыми, так как для пустых больших двоичных объектов требуется дополнительный запрос, если max_connections больше 1.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

Большой двоичный объект со свойствами и метаданными. Если max_connections больше 1, content_md5 (если он задан в большом двоичном объекте) не возвращается. Если требуется это значение, используйте get_blob_properties или задайте для max_connections значение 1.

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

Blob

get_blob_to_path

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

get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

file_path

str

Обязательно

Путь к файлу для записи.

open_mode

str

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

Режим, используемый при открытии файла. Обратите внимание, что указание только добавления open_mode предотвращает параллельную загрузку. Таким образом, max_connections необходимо задать значение 1, если используется эта open_mode.

snapshot

str

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

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

start_range

int

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

Начало диапазона байтов, используемого для скачивания раздела большого двоичного объекта. Если end_range не задано, скачиваются все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

end_range

int

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

Конец диапазона байтов, используемый для скачивания раздела большого двоичного объекта. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

validate_content

bool

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

Если задано значение true, проверяет хэш MD5 для каждой извлеченной части большого двоичного объекта. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные MD5 только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если самостоятельно. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, возникает ошибка. Поскольку вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может увеличиться.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, если он известен.

max_connections

int

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

Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов большого двоичного объекта. Если это весь большой двоичный объект, метод возвращает на этом этапе. Если это не так, он будет скачивать оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый кусок будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если следует использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если ожидается, что многие большие двоичные объекты будут пустыми, так как для пустых больших двоичных объектов требуется дополнительный запрос, если max_connections больше 1.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

Большой двоичный объект со свойствами и метаданными. Если max_connections больше 1, content_md5 (если он задан в большом двоичном объекте) не возвращается. Если требуется это значение, используйте get_blob_properties или задайте для max_connections значение 1.

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

Blob

get_blob_to_stream

Загружает BLOB-объект в поток с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами и метаданными.

get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

stream

IOBase

Обязательно

Открыт поток для записи.

snapshot

str

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

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

start_range

int

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

Начало диапазона байтов, используемого для скачивания раздела большого двоичного объекта. Если end_range не задано, скачиваются все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

end_range

int

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

Конец диапазона байтов, используемый для скачивания раздела большого двоичного объекта. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

validate_content

bool

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

Если задано значение true, проверяет хэш MD5 для каждой извлеченной части большого двоичного объекта. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные MD5 только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если самостоятельно. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, возникает ошибка. Поскольку вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может увеличиться.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, если он известен.

max_connections

int

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

Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов большого двоичного объекта. Если это весь большой двоичный объект, метод возвращает на этом этапе. Если это не так, он будет скачивать оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый кусок будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если следует использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если ожидается, что многие большие двоичные объекты будут пустыми, так как для пустых больших двоичных объектов требуется дополнительный запрос, если max_connections больше 1.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

Большой двоичный объект со свойствами и метаданными. Если max_connections больше 1, content_md5 (если он задан в большом двоичном объекте) не возвращается. Если требуется это значение, используйте get_blob_properties или задайте для max_connections значение 1.

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

Blob

get_blob_to_text

Загружает BLOB-объект в виде текста Юникода с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со Blob свойствами, метаданными и содержимым.

get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

encoding

str

значение по умолчанию: utf-8

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

snapshot

str

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

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

start_range

int

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

Начало диапазона байтов, используемого для скачивания раздела большого двоичного объекта. Если end_range не задано, скачиваются все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

end_range

int

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

Конец диапазона байтов, используемый для скачивания раздела большого двоичного объекта. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт большого двоичного объекта.

validate_content

bool

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

Если задано значение true, проверяет хэш MD5 для каждой извлеченной части большого двоичного объекта. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные MD5 только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если самостоятельно. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, возникает ошибка. Поскольку вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может увеличиться.

progress_callback

<xref:func>(<xref:current>, <xref:total>)

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

Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер большого двоичного объекта, если он известен.

max_connections

int

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

Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов большого двоичного объекта. Если это весь большой двоичный объект, метод возвращает на этом этапе. Если это не так, он будет скачивать оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый кусок будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если следует использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если ожидается, что многие большие двоичные объекты будут пустыми, так как для пустых больших двоичных объектов требуется дополнительный запрос, если max_connections больше 1.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

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

Большой двоичный объект со свойствами и метаданными. Если max_connections больше 1, content_md5 (если он задан в большом двоичном объекте) не возвращается. Если требуется это значение, используйте get_blob_properties или задайте для max_connections значение 1.

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

Blob

get_block_list

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

Список блокировок фиксации. Список блоков, успешно зафиксированных в заданном большом двоичном объекте с помощью put block List.

Список незафиксированных блокировок. Список блоков, которые были отправлены для большого двоичного объекта с помощью put block, но еще не зафиксированы. Эти блокировки хранятся в Azure в сопоставлении с BLOB-объектом, но еще не являются его частью.

get_block_list(container_name, blob_name, snapshot=None, block_list_type=None, lease_id=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

snapshot

str

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

Datetime для определения времени получения блоков.

block_list_type

str

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

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

lease_id

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

вывод списка зафиксированных и незафиксированных блоков для блочного BLOB-объекта

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

BlobBlockList

get_container_acl

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

get_container_acl(container_name, lease_id=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Словарь политик доступа, связанных с контейнером. dict of str to AccessPolicy и свойство public_access, если общий доступ включен

get_container_metadata

Возвращает все определяемые пользователем метаданные для указанного контейнера.

get_container_metadata(container_name, lease_id=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

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

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

dict(str, str)

get_container_properties

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

get_container_properties(container_name, lease_id=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

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

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

Container

get_user_delegation_key

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

get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)

Параметры

key_start_time

datetime

Обязательно

Значение даты и времени. Указывает, когда ключ становится действительным.

key_expiry_time

datetime

Обязательно

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

Ключ делегирования пользователя.

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

UserDelegationKey

list_blob_names

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

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

list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

prefix

str

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

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

num_results

int

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

Указывает максимальное количество больших двоичных объектов для возвращения, включая все элементы <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Если в запросе не указано num_results или указано значение больше 5000, сервер вернет до 5000 элементов. Установка num_results значения меньше или равного нулю приводит к возникновению кода ответа об ошибке 400 (недопустимый запрос).

include

Include

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

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

delimiter

str

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

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

marker

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

list_blobs

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

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

list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

prefix

str

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

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

num_results

int

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

Указывает максимальное количество больших двоичных объектов для возвращения, включая все элементы <xref:azure.storage.blob.blockblobservice.BlobPrefix>. Если в запросе не указано num_results или указано значение больше 5000, сервер вернет до 5000 элементов. Установка num_results значения меньше или равного нулю приводит к ошибке с кодом ответа 400 (недопустимый запрос).

include

Include

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

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

delimiter

str

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

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

marker

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

list_containers

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

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

list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)

Параметры

prefix

str

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

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

num_results

int

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

Указывает максимальное количество возвращаемых контейнеров. Один запрос списка может возвращать до 1000 contianers и, возможно, маркер продолжения, который следует использовать для получения дополнительных повторов.

include_metadata

bool

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

Указывает, что в ответе возвращаются метаданные контейнера.

marker

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

make_blob_url

Создает URL-адрес для доступа к большому двоичному объекту.

make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)

Параметры

container_name

str

Обязательно

Имя контейнера.

blob_name

str

Обязательно

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

protocol

str

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

Используемый протокол: "http" или "https". Если значение не указано, использует протокол, указанный при инициализации BaseBlobService.

sas_token

str

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

Маркер подписанного URL-адреса, созданный с помощью generate_shared_access_signature.

snapshot

str

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

Строковое значение, однозначно определяющее snapshot. Значение этого параметра запроса указывает версию snapshot.

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

URL-адрес доступа к BLOB-объекту.

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

str

make_container_url

Создает URL-адрес для доступа к контейнеру.

make_container_url(container_name, protocol=None, sas_token=None)

Параметры

container_name

str

Обязательно

Имя контейнера.

protocol

str

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

Используемый протокол: "http" или "https". Если значение не указано, использует протокол, указанный при инициализации BaseBlobService.

sas_token

str

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

Маркер подписанного URL-адреса, созданный с помощью generate_shared_access_signature.

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

URL-адрес доступа к контейнеру.

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

str

put_block

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

put_block(container_name, blob_name, block, block_id, validate_content=False, lease_id=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

block

IOBase или <xref:<xref:bytes Content> of <xref:the block.>>

Обязательно

Содержимое блока.

block_id

str

Обязательно

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

validate_content

bool

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

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

lease_id

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

put_block_from_url

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

put_block_from_url(container_name, blob_name, copy_source_url, block_id, source_range_start=None, source_range_end=None, source_content_md5=None, lease_id=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

copy_source_url

str

Обязательно

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

source_range_start

int

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

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

source_range_end

int

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

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

block_id

str

Обязательно

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

source_content_md5

str

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

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

lease_id

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

put_block_list

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

Вы можете вызвать команду Put Block List, чтобы обновить большой двоичный объект, отправив только те блоки, которые изменились, а затем зафиксировав новые и существующие блоки вместе. Это можно сделать, указав, следует фиксировать блокировку из списка зафиксированных блокировок или из списка незафиксированных блокировок, либо можно зафиксировать последнюю переданную версию блокировки, к какому бы списку она ни принадлежала.

put_block_list(container_name, blob_name, block_list, content_settings=None, metadata=None, validate_content=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

block_list

list(BlobBlock)

Обязательно

Список , <xref:azure.storeage.blob.models.BlobBlock> содержащий идентификаторы и состояние блока.

content_settings

ContentSettings

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

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

metadata

dict(str, str)

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

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

validate_content

bool

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

standard_blob_tier

StandardBlobTier

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

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

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

ETag и последние измененные свойства для обновленного блочного BLOB-объекта

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

ResourceProperties

release_blob_lease

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

release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

lease_id

str

Обязательно

Идентификатор аренды для активной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

release_container_lease

Освобождает аренду. Аренда может быть освобождена, если указанный lease_id соответствует связанному с контейнером. Освобождение аренды позволяет другому клиенту сразу приобрести аренду для контейнера.

release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

str

Обязательно

Идентификатор аренды для активной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

renew_blob_lease

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

renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

lease_id

str

Обязательно

Идентификатор аренды для активной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

str

renew_container_lease

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

renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

lease_id

str

Обязательно

Идентификатор аренды для активной аренды.

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

str

set_blob_metadata

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

set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

metadata

dict(str, str)

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

ETag и последние измененные свойства для обновленного BLOB-объекта

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

ResourceProperties

set_blob_properties

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

set_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

content_settings

ContentSettings

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

ETag и последние измененные свойства для обновленного BLOB-объекта

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

ResourceProperties

set_blob_service_properties

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

set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)

Параметры

logging

Logging

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

Группирует параметры ведения журнала Azure Analytics.

hour_metrics

Metrics

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

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

minute_metrics

Metrics

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

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

cors

list(CorsRule)

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

В список можно включить до пяти элементов CorsRule. Если указан пустой список, все правила CORS будут удалены, а CORS будет отключен для службы.

target_version

str

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

delete_retention_policy

DeleteRetentionPolicy

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

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

static_website

StaticWebsite

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

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

set_container_acl

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

set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

signed_identifiers

dict(str, AccessPolicy)

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

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

public_access

PublicAccess

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

Возможные значения: контейнер, большой двоичный объект.

lease_id

str

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

ETag и последние измененные свойства для обновленного контейнера

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

ResourceProperties

set_container_metadata

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

set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

metadata

dict(str, str)

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

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

lease_id

str

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

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

if_modified_since

datetime

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

ETag и последние измененные свойства для обновленного контейнера

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

ResourceProperties

set_proxy

Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT.

set_proxy(host, port, user=None, password=None)

Параметры

host

str

Обязательно

Адрес прокси-сервера. Например: '192.168.0.100'

port

int

Обязательно

Порт прокси-сервера. Например: 6000

user

str

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

Пользователь для авторизации прокси-сервера.

password

str

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

Пароль для авторизации прокси-сервера.

set_standard_blob_tier

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

:p aram RehydratePriority rehydrate_priority: указывает приоритет восстановления архивного большого двоичного объекта.

set_standard_blob_tier(container_name, blob_name, standard_blob_tier, timeout=None, rehydrate_priority=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

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

standard_blob_tier

StandardBlobTier

Обязательно

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

timeout

int

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

Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.

rehydrate_priority

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

snapshot_blob

Создает доступный только для чтения моментальный снимок BLOB-объекта.

snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

metadata

dict(str, str)

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

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

if_modified_since

datetime

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

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

if_unmodified_since

datetime

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

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

if_match

str

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

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

if_none_match

str

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

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

lease_id

str

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

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

cpk

CustomerProvidedEncryptionKey

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

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

timeout

int

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

Параметр времени ожидания указывается в секундах.

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

свойства snapshot

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

Blob

undelete_blob

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

undelete_blob(container_name, blob_name, timeout=None)

Параметры

container_name

str

Обязательно

Имя существующего контейнера.

blob_name

str

Обязательно

Имя существующего большого двоичного объекта.

timeout

int

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

Параметр времени ожидания указывается в секундах.

Атрибуты

protocol

request_session

socket_timeout

MAX_BLOCK_SIZE

MAX_BLOCK_SIZE = 4194304

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432

MAX_SINGLE_PUT_SIZE

MAX_SINGLE_PUT_SIZE = 67108864

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD

MIN_LARGE_BLOCK_UPLOAD_THRESHOLD = 4194305