azure.storage.filedatalake.DataLakeFileClient class

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

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

Параметры

lease_duration: int

Обязательно

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

lease_id: str

Обязательно

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

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

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

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

DataLakeLeaseClient

Добавление данных в файл.

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

Параметры

data

Обязательно

Содержимое, добавляемое в файл

offset

Обязательно

начальная позиция данных для добавления.

length

Обязательно

Размер данных в байтах.

flush: bool

Если значение равно true, будет фиксировать данные после их добавления.

validate_content: bool

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

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

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

"приобрести" — получение аренды. "автоматическое продление" — повторное создание существующей аренды. "release" — освобождение аренды после завершения операции. Требуется flush=True. "acquire-release" — получение аренды и освобождение после завершения операций. Требуется flush=True.

lease_duration: int

Допустимо, если lease_action задано значение "acquire" или "acquire-release".

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

lease: DataLakeLeaseClient или str

Требуется, если файл имеет активную аренду или если lease_action задано значение "acquire" или "acquire-release". Если файл имеет существующую аренду, он будет использоваться для доступа к файлу. При получении новой аренды он будет использоваться в качестве нового идентификатора аренды. Значением может быть объект DataLakeLeaseClient или идентификатор аренды в виде строки.

cpk: CustomerProvidedEncryptionKey

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

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

Дикт заголовка ответа

Примеры

Добавление данных в файл.


   file_client.append_data(data=file_content[2048:3072], offset=2048, length=1024)

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

close() -> None

Создайте новый файл.

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

Параметры

content_settings: ContentSettings

Обязательно

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

metadata: Optional[Dict[str, str]]

Обязательно

Пары «имя-значение», связанные с файлом как метаданные.

lease: DataLakeLeaseClient или str

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

umask: str

Необязательный и допустимый только в том случае, если для учетной записи включено иерархическое пространство имен. При создании файла или каталога, а родительская папка не имеет ACL по умолчанию, umask ограничивает разрешения создаваемого файла или каталога. Полученное разрешение предоставляется p & ^u, где p — это разрешение, а вы — umask. Например, если p имеет значение 0777, а вы — 0057, то полученное разрешение — 0720. Разрешение по умолчанию — 0777 для каталога и 0666 для файла. Значение umask по умолчанию — 0027. Umask необходимо указать в восьмеричном нотации из 4 цифр (например, 0766).

owner: str

Владелец файла или каталога.

group: str

Группа владельцев файла или каталога.

acl: str

Задает права управления доступом POSIX к файлам и каталогам. Значение представляет собой разделенный запятыми список записей управления доступом. Каждая запись управления доступом (ACE) состоит из область, типа, идентификатора пользователя или группы и разрешений в формате "[область:][тип]:[id]:[permissions]".

lease_id: str

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

lease_duration: int

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

expires_on: datetime или int

Время для установки срока действия файла. Если тип expires_on — int, время истечения срока действия будет установлено в виде количества миллисекундах, прошедших с момента создания. Если тип expires_on — datetime, то для времени окончания срока действия будет задано абсолютное указанное время. Если сведения о часовом поясе не указаны, это будет интерпретироваться как UTC.

permissions: str

Необязательный и допустимый, только если для учетной записи включено иерархическое пространство имен. Задает разрешения на доступ к POSIX для владельца файла, группы владельцев файлов и т. д. Каждому классу может быть предоставлено разрешение на чтение, запись или выполнение. Также поддерживается залипание бита. Поддерживаются символьная (rwxrw-rw-) и 4-значная восьмеричная нотация (например, 0766).

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

encryption_context: str

Указывает контекст шифрования для файла.

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

дикт ответа (Etag и последнее изменение).

Примеры

Создайте файл.


   file_client = filesystem_client.get_file_client(file_name)
   file_client.create_file()

Помечает указанный файл для удаления.

delete_file(**kwargs) -> None

Параметры

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

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

Нет

Примеры

Удалить файл.


   new_client.delete_file()

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

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Параметры

offset: int

Обязательно

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

length: int

Обязательно

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

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

max_concurrency: int

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

timeout: int

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

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

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

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

StorageStreamDownloader

Примеры

Возврат загруженных данных.


   download = file_client.download_file()
   downloaded_bytes = download.readall()

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

exists(**kwargs: Any) -> bool

Параметры

timeout: int

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

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

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

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

bool

Зафиксируйте предыдущие добавленные данные.

flush_data(offset: int, retain_uncommitted_data: bool | None = False, **kwargs) -> Dict[str, str | datetime]

Параметры

offset

Обязательно

Offset равно длине файла после фиксации предыдущих добавленных данных.

retain_uncommitted_data: bool

Обязательно

Допустимо только для операций очистки. Если задано значение true, незафиксированные данные сохраняются после завершения операции очистки; В противном случае незафиксированные данные удаляются после операции очистки. Значение по умолчанию — false. Данные со смещениями меньше указанной позиции записываются в файл при успешной очистке, но этот необязательный параметр позволяет сохранять данные после позиции сброса для будущей операции очистки.

content_settings: ContentSettings

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

close: bool

События службы хранилища Azure позволяют приложениям получать уведомления при изменении файлов. При включении событий службы хранилища Azure возникает событие изменения файла. Это событие имеет свойство, указывающее, является ли это окончательным изменением, чтобы различать разницу между промежуточной очисткой в файловом потоке и окончательным закрытием файлового потока. Параметр запроса закрытия действителен только в том случае, если действие "очистка" и включены уведомления об изменениях. Если значение close равно true и операция очистки завершается успешно, служба создает уведомление об изменении файла со свойством, указывающим, что это окончательное обновление (файловый поток закрыт). Если значение false, возникает уведомление об изменении, указывающее на изменение файла. Значение по умолчанию — false. Драйвер Hadoop ABFS задает этому параметру запроса значение true, чтобы указать, что файловый поток закрыт.

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

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

"приобрести" — получение аренды. "автоматическое продление" — повторное обновление существующей аренды. "release" — освобождение аренды после завершения операции. "acquire-release" — получение аренды и освобождение после завершения операций.

lease_duration: int

Допустимо, если для lease_action задано значение "acquire" или "acquire-release".

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

lease: DataLakeLeaseClient или str

Требуется, если файл имеет активную аренду или если для lease_action задано значение "acquire" или "acquire-release". Если файл имеет существующую аренду, он будет использоваться для доступа к файлу. При получении новой аренды он будет использоваться в качестве нового идентификатора аренды. Значением может быть объект DataLakeLeaseClient или идентификатор аренды в виде строки.

cpk: CustomerProvidedEncryptionKey

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

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

Заголовок ответа в дикте

Примеры

Зафиксируйте предыдущие добавленные данные.


   with open(SOURCE_FILE, "rb") as data:
       file_client = file_system_client.get_file_client("myfile")
       file_client.create_file()
       file_client.append_data(data, 0)
       file_client.flush_data(data.tell())

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

:return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient

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

Параметры

conn_str: str

Обязательно

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

file_system_name: str

Обязательно

Имя файловой системы для взаимодействия.

file_path: str

Обязательно

Весь путь к файлу, чтобы взаимодействовать с определенным файлом. Например: "{directory}/{subdirectory}/{file}"

credential

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

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

get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Параметры

upn: bool

Обязательно

Необязательный элемент. Допустимо только в том случае, если для учетной записи включено иерархическое пространство имен. Если задано значение true, значения удостоверений пользователя, возвращаемые в заголовках ответа x-ms-owner, x-ms-group и x-ms-acl, будут преобразованы из идентификаторов объектов Azure Active Directory в имена субъектов-пользователей. Если задано значение false, значения будут возвращены в виде идентификаторов объектов Azure Active Directory. Значением по умолчанию является false. Обратите внимание, что идентификаторы объектов групп и приложений не переводятся, так как они не имеют уникальных понятных имен.

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

response dict

ответный дикт.

Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для файла. Операция не возвращает содержимое файла.

get_file_properties(**kwargs: Any) -> FileProperties

Параметры

lease

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

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

Все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для файла.

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

FileProperties

Примеры

Получение свойств файла.


   properties = file_client.get_file_properties()

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

query_file(query_expression: str, **kwargs: Any) -> DataLakeFileQueryReader

Параметры

query_expression: str

Обязательно

Обязательный. оператор запроса. Например: Выберите * из DataLakeStorage.

on_error: Callable[DataLakeFileQueryError]

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

file_format: DelimitedTextDialect или DelimitedJsonDialect или QuickQueryDialect или str

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

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

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

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

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

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

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

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Примеры

Выберите или проецируете данные файла datalake путем предоставления простых выражений запроса.


   errors = []
   def on_error(error):
       errors.append(error)

   # upload the csv file
   file_client = datalake_service_client.get_file_client(filesystem_name, "csvfile")
   file_client.upload_data(CSV_DATA, overwrite=True)

   # select the second column of the csv file
   query_expression = "SELECT _2 from DataLakeStorage"
   input_format = DelimitedTextDialect(delimiter=',', quotechar='"', lineterminator='\n', escapechar="", has_header=False)
   output_format = DelimitedJsonDialect(delimiter='\n')
   reader = file_client.query_file(query_expression, on_error=on_error, file_format=input_format, output_format=output_format)
   content = reader.readall()

Удаляет контроль доступа пути и вложенных путей.

remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Параметры

acl: str

Обязательно

Удаляет права управления доступом POSIX к файлам и каталогам. Значение представляет собой разделенный запятыми список записей управления доступом. Каждая запись управления доступом (ACE) состоит из область, типа и идентификатора пользователя или группы в формате "[область:][тип]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

Если задано значение False, операция быстро завершится при возникновении ошибок пользователя (4XX). Если задано значение True, операция проигнорирует ошибки пользователя и продолжит операцию с другими вложенными сущностями каталога. Маркер продолжения будет возвращен, только если continue_on_failure имеет значение True в случае ошибок пользователя. Если значение не задано, значение по умолчанию — False.

timeout: int

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

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

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

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

AccessControlChangeResult

Исключения

AzureError

Пользователь может перезапустить операцию, используя continuation_token поле AzureError, если маркер доступен.

Переименуйте исходный файл.

rename_file(new_name: str, **kwargs: Any) -> DataLakeFileClient

Параметры

new_name: str

Обязательно

новое имя файла, в которое пользователь хочет переименовать. Значение должно иметь следующий формат: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

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

source_lease: DataLakeLeaseClient или str

Идентификатор аренды для исходного пути. Если он указан, исходный путь должен иметь активную аренду, а идентификатор аренды должен совпадать.

lease

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

source_if_modified_since: datetime

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

source_if_unmodified_since: datetime

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

source_etag: str

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

source_match_condition: MatchConditions

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

timeout: int

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

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

переименованный файловый клиент

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

DataLakeFileClient

Примеры

Переименуйте исходный файл.


   new_client = file_client.rename_file(file_client.file_system_name + '/' + 'newname')

Задайте владельца, группу, разрешения или список управления доступом для пути.

set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Параметры

owner: str

Обязательно

Необязательный элемент. Владелец файла или каталога.

group: str

Обязательно

Необязательный элемент. Группа владельцев файла или каталога.

permissions: str

Обязательно

Необязательный и допустимый, только если для учетной записи включено иерархическое пространство имен. Задает разрешения на доступ к POSIX для владельца файла, группы владельцев файлов и т. д. Каждому классу может быть предоставлено разрешение на чтение, запись или выполнение. Также поддерживается залипание бита. Поддерживаются символьная (rwxrw-rw-) и 4-значная восьмеричная нотация (например, 0766). разрешения и список управления доступом являются взаимоисключающими.

acl: str

Обязательно

Задает права управления доступом POSIX к файлам и каталогам. Значение представляет собой разделенный запятыми список записей управления доступом. Каждая запись управления доступом (ACE) состоит из область, типа, идентификатора пользователя или группы и разрешений в формате "[область:][тип]:[id]:[permissions]". разрешения и список управления доступом являются взаимоисключающими.

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

response dict

дикт ответа (Etag и последнее изменение).

Задает контроль доступа пути и вложенных путей.

set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Параметры

acl: str

Обязательно

Задает права управления доступом POSIX к файлам и каталогам. Значение представляет собой разделенный запятыми список записей управления доступом. Каждая запись управления доступом (ACE) состоит из область, типа, идентификатора пользователя или группы и разрешений в формате "[область:][тип]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

Если задано значение False, операция быстро завершится при возникновении ошибок пользователя (4XX). Если задано значение True, операция проигнорирует ошибки пользователя и продолжит операцию с другими вложенными сущностями каталога. Маркер продолжения будет возвращен, только если continue_on_failure имеет значение True в случае ошибок пользователя. Если значение не задано, значение по умолчанию — False.

timeout: int

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

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

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

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

AccessControlChangeResult

Исключения

AzureError

Пользователь может перезапустить операцию, используя continuation_token поле AzureError, если маркер доступен.

Задает время истечения срока действия файла и его удаления.

set_file_expiry(expiry_options: str, expires_on: datetime | int | None = None, **kwargs) -> None

Параметры

expiry_options: str

Обязательно

Обязательный. Указывает режим времени истечения срока действия. Возможные значения: NeverExpire, RelativeToCreation, RelativeToNow, Absolute

expires_on: datetime или int

Обязательно

Время для установки срока действия файла. Если expiry_options имеет значение RelativeTo*, expires_on должно иметь значение int в миллисекундах. Если тип expires_on — datetime, оно должно быть в формате UTC.

timeout: int

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

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

None

Задает системные свойства файла или каталога.

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

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

Параметры

content_settings: ContentSettings

Обязательно

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

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

timeout: int

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

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

Свойство file/directory-updated dict (Etag и последнее изменение)

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

Dict[str, Any]

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

set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Параметры

metadata: Dict[str, str]

Обязательно

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

lease: DataLakeLeaseClient или str

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

if_modified_since: datetime

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

if_unmodified_since: datetime

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

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

свойство, обновленное в файловой системе (Etag и последнее изменение).

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

update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Параметры

acl: str

Обязательно

Изменяет права управления доступом POSIX к файлам и каталогам. Значение представляет собой разделенный запятыми список записей управления доступом. Каждая запись управления доступом (ACE) состоит из область, типа, идентификатора пользователя или группы и разрешений в формате "[область:][тип]:[id]:[permissions]".

progress_hook: <xref:func>(AccessControlChanges)

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

continuation_token: str

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

batch_size: int

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

max_batches: int

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

continue_on_failure: bool

Если задано значение False, операция быстро завершится при возникновении ошибок пользователя (4XX). Если задано значение True, операция проигнорирует ошибки пользователя и продолжит операцию с другими вложенными сущностями каталога. Маркер продолжения будет возвращен, только если continue_on_failure имеет значение True в случае ошибок пользователя. Если значение не задано, значение по умолчанию — False.

timeout: int

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

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

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

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

AccessControlChangeResult

Исключения

AzureError

Пользователь может перезапустить операцию, используя continuation_token поле AzureError, если маркер доступен.

Отправка данных в файл.

upload_data(data: bytes | str | Iterable | IO, length: int | None = None, overwrite: bool | None = False, **kwargs) -> Dict[str, Any]

Параметры

data

Обязательно

Содержимое для отправки в файл

length: int

Обязательно

Размер данных в байтах.

overwrite: bool

Обязательно

значение , чтобы перезаписать существующий файл или нет.

content_settings: ContentSettings

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

metadata: Optional[Dict[str, str]]

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

lease: DataLakeLeaseClient или str

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

umask: str

Необязательный и допустимый, только если для учетной записи включено иерархическое пространство имен. При создании файла или каталога, а родительская папка не имеет ACL по умолчанию, umask ограничивает разрешения создаваемого файла или каталога. Полученное разрешение предоставляется p & ^u, где p — это разрешение, а вы — umask. Например, если p — 0777, а вы — 0057, то полученное разрешение — 0720. Разрешение по умолчанию — 0777 для каталога и 0666 для файла. Значение umask по умолчанию — 0027. Umask необходимо указать в восьмеричном нотации из 4 цифр (например, 0766).

permissions: str

Необязательный и допустимый, только если для учетной записи включено иерархическое пространство имен. Задает разрешения на доступ к POSIX для владельца файла, группы владельцев файлов и т. д. Каждому классу может быть предоставлено разрешение на чтение, запись или выполнение. Также поддерживается залипание бита. Поддерживаются символьная (rwxrw-rw-) и 4-значная восьмеричная нотация (например, 0766).

if_modified_since: datetime

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

if_unmodified_since: datetime

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

validate_content: bool

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

etag: str

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

match_condition: MatchConditions

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

cpk: CustomerProvidedEncryptionKey

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

timeout: int

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

chunk_size: int

Максимальный размер блока для отправки файла блоками. По умолчанию — 100*1024*1024 или 100 МБ.

encryption_context: str

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

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

дикт ответа (Etag и последнее изменение).

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

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

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

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

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

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

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

Исключения

ValueError

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

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

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

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

acquire_lease	Запрашивает новую аренду. Если у файла или каталога нет активной аренды, служба DataLake создает аренду для файла или каталога и возвращает новый идентификатор аренды.
append_data	Добавление данных в файл.
close	Этот метод заключается в закрытии сокетов, открытых клиентом. Его не нужно использовать при использовании с диспетчером контекста.
create_file	Создайте новый файл.
delete_file	Помечает указанный файл для удаления.
download_file	Скачивает файл в StorageStreamDownloader. Метод readall() должен использоваться для чтения всего содержимого, или для скачивания файла в поток должен использоваться метод readall(). При использовании chunks() возвращается итератор, который позволяет пользователю выполнять итерацию по содержимому фрагментами.
exists	Возвращает значение True, если файл существует, и false в противном случае.
flush_data	Зафиксируйте предыдущие добавленные данные.
from_connection_string	Создайте DataLakeFileClient из строки подключения. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для файла. Операция не возвращает содержимое файла.
query_file	Позволяет пользователям выбирать или проектировать данные файла datalake, предоставляя простые выражения запроса. Эта операция возвращает DataLakeFileQueryReader. Пользователям необходимо использовать readall() или readinto() для получения данных запроса.
remove_access_control_recursive	Удаляет контроль доступа пути и вложенных путей.
rename_file	Переименуйте исходный файл.
set_access_control	Задайте владельца, группу, разрешения или список управления доступом для пути.
set_access_control_recursive	Задает контроль доступа пути и вложенных путей.
set_file_expiry	Задает время истечения срока действия файла и его удаления.
set_http_headers	Задает системные свойства файла или каталога. Если для content_settings задано одно свойство, все свойства будут переопределены.
set_metadata	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной файловой системы. Каждый вызов этой операции заменяет все существующие метаданные, присоединенные к файловой системе. Чтобы удалить все метаданные из файловой системы, вызовите эту операцию без диктовки метаданных.
update_access_control_recursive	Изменяет контроль доступа пути и вложенных путей.
upload_data	Отправка данных в файл.

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

DataLakeFileClient Класс

Конструктор

Параметры

Примеры

Переменные

Методы

acquire_lease

Параметры

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

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

append_data

Параметры

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

Примеры

close

create_file

Параметры

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

Примеры

delete_file

Параметры

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

Примеры

download_file

Параметры

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

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

Примеры

exists

Параметры

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

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

flush_data

Параметры

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

Примеры

from_connection_string

Параметры

get_access_control

Параметры

get_file_properties

Параметры

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

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

Примеры

query_file

Параметры

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

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

Примеры

remove_access_control_recursive

Параметры

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

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

Исключения

rename_file

Параметры

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

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

Примеры

set_access_control

Параметры

set_access_control_recursive

Параметры

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

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

Исключения

set_file_expiry

Параметры

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

set_http_headers

Параметры

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

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

set_metadata

Параметры

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

update_access_control_recursive

Параметры