aio Пакет
Классы
BlobClient |
Клиент для взаимодействия с определенным BLOB-объектом, хотя этот BLOB-объект может еще не существовать. |
BlobLeaseClient |
Создает объект BlobLeaseClient. Этот клиент предоставляет операции аренды blobClient или ContainerClient. |
BlobPrefix |
Итерируемый объект свойств BLOB-объекта. Возвращается из walk_blobs при использовании разделителя. Можно рассматривать как виртуальный каталог BLOB-объектов. |
BlobServiceClient |
Клиент для взаимодействия со Службой BLOB-объектов на уровне учетной записи. Этот клиент предоставляет операции для получения и настройки свойств учетной записи, а также перечисления, создания и удаления контейнеров в учетной записи. Для операций, связанных с определенным контейнером или большим двоичным объектом, клиенты для этих сущностей также можно получить с помощью функций get_client . |
ContainerClient |
Клиент для взаимодействия с определенным контейнером, хотя этот контейнер может еще не существовать. Для операций, связанных с определенным BLOB-объектом в этом контейнере, клиент BLOB-объекта можно получить с помощью get_blob_client функции . |
ExponentialRetry |
Экспоненциальная повторная попытка. Создает объект экспоненциальной попытки. Для первой попытки используется initial_backoff. Последующие повторные попытки повторяются через initial_backoff + increment_power^retry_count секунд. Например, по умолчанию первая повторная попытка выполняется через 15 секунд, вторая после (15+3^1) = 18 секунд, а третья после (15+3^2) = 24 секунды. |
LinearRetry |
Линейная повторная попытка. Создает объект linear retry. |
StorageStreamDownloader |
Объект потоковой передачи для скачивания из службы хранилища Azure. |
Функции
download_blob_from_url
Скачайте содержимое большого двоичного объекта в локальный файл или поток.
async download_blob_from_url(blob_url: str, output: str, credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> None
Параметры
- blob_url
- str
Полный универсальный код ресурса (URI) большого двоичного объекта. Сюда также может входить маркер SAS.
- output
- str или <xref:<xref:writable stream>>
Куда следует скачать данные. Это может быть либо путь к файлу для записи, либо открытый дескриптор ввода-вывода для записи.
- credential
Учетные данные для проверки подлинности. Это необязательно, если URL-адрес большого двоичного объекта уже содержит маркер SAS или большой двоичный объект является общедоступным. Это может быть строка маркера SAS, экземпляр AzureSasCredential или AzureNamedKeyCredential из azure.core.credentials, общий ключ доступа учетной записи или экземпляр класса TokenCredentials из azure.identity. Если URI ресурса уже содержит маркер SAS, он будет игнорироваться в пользу явных учетных данных.
- за исключением случаев AzureSasCredential, где конфликтующие маркеры SAS вызовут ValueError. При использовании экземпляра AzureNamedKeyCredential "name" должно быть именем учетной записи хранения, а "key" — ключом учетной записи хранения.
- overwrite
- bool
Следует ли перезаписывать локальный файл, если он уже существует. Значение по умолчанию — False . В этом случае будет создано значение ValueError, если файл уже существует. Если задано значение True, будет предпринята попытка записи в существующий файл. Если передается дескриптор потока, это значение игнорируется.
- max_concurrency
- int
Количество параллельных подключений, с помощью которых требуется скачать.
- offset
- int
Начало диапазона байтов, используемого для скачивания раздела большого двоичного объекта. Должен быть задан, если указана длина.
- length
- int
Число байтов, считываемых из потока. Это необязательный параметр, но его необходимо предоставить для оптимальной производительности.
- validate_content
- bool
Если значение равно true, вычисляет хэш MD5 для каждого блока большого двоичного объекта. Служба хранилища проверяет хэш содержимого, которое поступило вместе с отправленным хэшом. Это в первую очередь полезно для обнаружения битовых фрагментов в сети, если использование http вместо https, так как https (по умолчанию) уже проверяется. Учтите, что этот хэш MD5 не сохраняется в большом двоичном объекте. Кроме того, обратите внимание, что если этот параметр включен, алгоритм отправки с эффективным использованием памяти не будет использоваться, так как для вычисления хэша MD5 требуется буферизация целых блоков, и это приведет к поражению цели алгоритма, эффективного в памяти.
Возвращаемый тип
upload_blob_to_url
Отправка данных по заданному URL-адресу
Данные будут переданы в виде блочного BLOB-объекта.
param str blob_url: полный универсальный код ресурса (URI) большого двоичного объекта. Сюда также может входить маркер SAS.
param data: данные для отправки. Это могут быть байты, текст, итерируемый или файловый объект.
тип данных: bytes или str или Iterable
async upload_blob_to_url(blob_url: str, data: Union[Iterable[AnyStr], IO[AnyStr]], credential: Optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long = None, **kwargs) -> dict[str, Any]
Параметры
- credential
Учетные данные для проверки подлинности. Это необязательно, если URL-адрес большого двоичного объекта уже содержит маркер SAS. Это может быть строка маркера SAS, экземпляр AzureSasCredential или AzureNamedKeyCredential из azure.core.credentials, общий ключ доступа учетной записи или экземпляр класса TokenCredentials из azure.identity. Если URI ресурса уже содержит маркер SAS, он будет игнорироваться в пользу явных учетных данных.
- за исключением случаев AzureSasCredential, где конфликтующие маркеры SAS вызовут ValueError. При использовании экземпляра AzureNamedKeyCredential "name" должно быть именем учетной записи хранения, а "key" — ключом учетной записи хранения.
учетные данные paramtype: optional[Union[str, Dict[str, str], AzureNamedKeyCredential, AzureSasCredential, "TokenCredential"]] # pylint: disable=line-too-long
ключевое слово логическое перезапись. Указывает, должен ли отправляемый BLOB-объект перезаписывать текущие данные. Если значение равно True, upload_blob_to_url перезапишет все существующие данные. Если задано значение False, операция завершится ошибкой ResourceExistsError.
ключевое слово int max_concurrency: количество параллельных подключений, с помощью которых требуется скачать.
ключевое слово длина int: количество байтов для чтения из потока. Это необязательный параметр, но его необходимо предоставить для оптимальной производительности.
ключевое слово метаданные dict(str,str): пары "имя-значение", связанные с большим двоичным объектом в качестве метаданных.
ключевое слово логическое validate_content. Если значение равно true, вычисляет хэш MD5 для каждого блока большого двоичного объекта. Служба хранилища проверяет хэш содержимого, которое поступило вместе с отправленным хэшом. Это в первую очередь полезно для обнаружения битовых фрагментов в сети, если использование http вместо https, так как https (по умолчанию) уже проверяется. Учтите, что этот хэш MD5 не сохраняется в большом двоичном объекте. Кроме того, обратите внимание, что если этот параметр включен, алгоритм отправки с эффективным использованием памяти не будет использоваться, так как для вычисления хэша MD5 требуется буферизация целых блоков, и это приведет к поражению цели алгоритма, эффективного в памяти.
кодирование ключевое слово str. Кодирование, используемое, если текст предоставляется в качестве входных данных. По умолчанию — UTF-8.
returns: словарь свойств, обновленных blob-объектов (Etag и последнее изменение)
rtype: dict(str, Any)
- blob_url
- data
Azure SDK for Python