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

filedatalake Пакет

  • Ссылка

Пакеты

aio

Классы

AccessControlChangeCounters

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

Представляет запись, которая не смогла обновить список контроль доступа.
AccessControlChangeResult

AccessControlChangeResult содержит результаты операций, которые рекурсивно изменяют контроль доступа Списки.
AccessControlChanges

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

Класс Access Policy, используемый методом set, и get политики доступа в каждой службе.

Хранимая политика доступа может задавать время начала, время окончания и разрешения для подписей коллективного доступа, с которыми она сопоставлена. В зависимости от того, как вы хотите управлять доступом к ресурсу, можно указать все эти параметры в хранимой политике доступа и опустить их в URL-адресе подписанного URL-адреса. Это позволяет изменить поведение связанной подписи в любое время, а также отменить ее. Или же вы можете указать один или несколько параметров в политике доступа, а остальные указать в URL-адресе. И наконец, вы можете указать все параметры в URL-адресе. В этом случае хранимую политику доступа можно использовать для отмены подписи, но не для изменения поведения подписи.

Подпись общего доступа и хранимая политика доступа должны включать все поля, необходимые для проверки подлинности подписи. Если какие-либо обязательные поля отсутствуют, то запрос завершится ошибкой. Аналогично, если поле указано и в подписанном URL-адресе, и в хранимой политике доступа, запрос завершится ошибкой с кодом состояния 400 (неправильный запрос).
AccountSasPermissions
AnalyticsLogging

Параметры ведения журнала Azure Analytics.
ArrowDialect

поле схемы со стрелками.

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

Параметры содержимого файла или каталога.
CorsRule

CORS является функцией HTTP, которая позволяет веб-приложению, работающему в одном домене, обращаться к ресурсам из другого домена. Веб-браузеры имеют ограничение безопасности под названием политика одного источника, которое не позволяет веб-странице вызывать API из других доменов. CORS обеспечивают безопасный способ, с помощью которого один домен (исходный домен) может вызывать API из другого домена.
CustomerProvidedEncryptionKey

Все данные в службе хранилища Azure шифруются при хранении с помощью ключа шифрования на уровне учетной записи. В версиях 2021-06-08 и более поздних можно управлять ключом, используемым для шифрования содержимого файла и метаданных приложения для каждого файла, предоставляя ключ шифрования AES-256 в запросах к службе хранилища.

При использовании ключа, предоставленного клиентом, служба хранилища Azure не управляет ключом и не сохраняет его. При записи данных в файл указанный ключ используется для шифрования данных перед их записью на диск. Хэш SHA-256 ключа шифрования записывается вместе с содержимым файла и используется для проверки того, что все последующие операции с файлом используют один и тот же ключ шифрования. Этот хэш нельзя использовать для извлечения ключа шифрования или расшифровки содержимого файла. При чтении файла указанный ключ используется для расшифровки данных после чтения с диска. В обоих случаях указанный ключ шифрования безопасно отбрасывается сразу после завершения процесса шифрования или расшифровки.
DataLakeDirectoryClient

Клиент для взаимодействия с каталогом DataLake, даже если каталог может еще не существовать.

Для операций, связанных с определенным подкаталогом или файлом в каталоге, клиент каталога или файловый клиент можно получить с помощью get_sub_directory_client функций или get_file_client .
DataLakeFileClient

Клиент для взаимодействия с файлом DataLake, даже если файл еще не существует.
DataLakeFileQueryError

Ошибка произошла во время операции быстрого запроса.
DataLakeLeaseClient

Создает объект DataLakeLeaseClient.

Этот клиент предоставляет операции аренды для FileSystemClient, DataLakeDirectoryClient или DataLakeFileClient.
DataLakeServiceClient

Клиент для взаимодействия со службой DataLake на уровне учетной записи.

Этот клиент предоставляет операции для получения и настройки свойств учетной записи, а также перечисления, создания и удаления файловой системы в учетной записи. Для операций, связанных с определенной файловой системой, каталогом или файлом, клиенты для этих сущностей также можно получить с помощью функций get_client .
DeletedPathProperties

Свойства, заполненные для удаленного пути.
DelimitedJsonDialect

Определяет сериализацию входных или выходных данных JSON для запроса datalake.

ключевое слово разделитель str: символ разделителя строк, значение по умолчанию — '

'
DelimitedTextDialect

Определяет сериализацию входных или выходных данных с разделителями (CSV) для запроса datalake.

ключевое слово разделитель str: разделитель столбцов, по умолчанию — ",".

ключевое слово кавычек str: кавычка поля, по умолчанию — "".

ключевое слово str lineterminator: разделитель записей, по умолчанию — '

'. escapechar ключевое слово str: escape-символ, по умолчанию — пустой.

ключевое слово bool has_header: содержит ли данные BLOB-объекта заголовки в первой строке. Значение по умолчанию — False, что означает, что данные будут возвращены включительно из первой строки. Если задано значение True, данные будут возвращены исключительно из первой строки.
DirectoryProperties
DirectorySasPermissions

Класс DirectorySasPermissions, используемый с функцией generate_directory_sas .
EncryptionScopeOptions

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

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

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

Экспоненциальная повторная попытка.

Создает объект экспоненциальной попытки. Для первой попытки используется initial_backoff. Последующие повторные попытки повторяются через initial_backoff + increment_power^retry_count секунд.
FileProperties
FileSasPermissions

Класс FileSasPermissions, используемый с функцией generate_file_sas .
FileSystemClient

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

Для операций, связанных с определенным каталогом или файлом в этой файловой системе, клиент каталога или файловый клиент можно получить с помощью get_directory_client функций или get_file_client .
FileSystemProperties

Класс свойств файловой системы.

Возвращаемые FileSystemProperties экземпляры предоставляют эти значения через интерфейс словаря, например file_system_props["last_modified"]: . Кроме того, имя файловой системы доступно как file_system_props["name"].
FileSystemPropertiesPaged

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

Класс FileSystemSasPermissions, используемый с функцией generate_file_system_sas .
LeaseProperties

Свойства аренды DataLake.
LinearRetry

Линейная повторная попытка.

Создает объект linear retry.
LocationMode

Указывает расположение, в которое должен быть отправлен запрос. Этот режим применяется только к учетным записям RA-GRS, которые разрешают вторичный доступ на чтение. Все остальные типы учетных записей должны использовать PRIMARY.
Metrics

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

Свойства пути, перечисленные в api get_paths.
ResourceTypes

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

Политика хранения, которая определяет, как долго должны храниться связанные данные.
StaticWebsite

Свойства, позволяющие учетной записи размещать статический веб-сайт.
StorageStreamDownloader

Объект потоковой передачи для скачивания из службы хранилища Azure.
UserDelegationKey

Представляет ключ делегирования пользователя, предоставленный пользователю службой хранилища Azure на основе маркера доступа Azure Active Directory.

Поля сохраняются в виде простых строк, так как пользователю не нужно взаимодействовать с этим объектом; Чтобы создать SAS для идентификации, пользователь может просто передать его в нужный API.

Перечисления

ArrowType
PublicAccess

Указывает, могут ли данные в файловой системе быть общедоступными и уровень доступа.
QuickQueryDialect

Указывает диалект быстрого запроса для ввода-вывода.
StorageErrorCode

Функции

generate_account_sas

Создает подписанный URL-адрес для службы DataLake.

Используйте возвращенную сигнатуру в качестве параметра учетных данных любого объекта DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient или DataLakeFileClient.

generate_account_sas(account_name: str, account_key: str, resource_types: ResourceTypes | str, permission: AccountSasPermissions | str, expiry: datetime | str | None, **kwargs: Any) -> str

Параметры

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

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

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

Ключ доступа для создания подписанного URL-адреса.

resource_types
str или ResourceTypes
Обязательно

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

permission
str или AccountSasPermissions
Обязательно

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

expiry
datetime или str
Обязательно

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

start
datetime или str

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

ip
str

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

protocol
str

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

encryption_scope
str

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

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

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

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

str

generate_directory_sas

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

Используйте возвращенную сигнатуру с параметром учетных данных любого объекта DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient или DataLakeFileClient.

generate_directory_sas(account_name: str, file_system_name: str, directory_name: str, credential: str | UserDelegationKey, permission: DirectorySasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Параметры

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

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

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

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

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

Имя каталога.

credential
str или UserDelegationKey
Обязательно

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

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

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

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

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

start
datetime или str

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

ip
str

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

protocol
str

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

cache_control
str

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

content_disposition
str

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

content_encoding
str

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

content_language
str

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

content_type
str

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

preauthorized_agent_object_id
str

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

agent_object_id
str

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

correlation_id
str

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

encryption_scope
str

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

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

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

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

str

generate_file_sas

Создает подписанный URL-адрес для файла.

Используйте возвращенную подпись с параметром учетных данных любого BDataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient или DataLakeFileClient.

generate_file_sas(account_name: str, file_system_name: str, directory_name: str, file_name: str, credential: str | UserDelegationKey, permission: FileSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Параметры

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

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

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

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

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

Имя каталога.

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

Имя файла.

credential
str или UserDelegationKey
Обязательно

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

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

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

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

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

start
datetime или str

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

ip
str

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

protocol
str

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

cache_control
str

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

content_disposition
str

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

content_encoding
str

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

content_language
str

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

content_type
str

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

preauthorized_agent_object_id
str

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

agent_object_id
str

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

correlation_id
str

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

encryption_scope
str

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

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

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

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

str

generate_file_system_sas

Создает подписанный URL-адрес для файловой системы.

Используйте возвращенную сигнатуру с параметром учетных данных любого объекта DataLakeServiceClient, FileSystemClient, DataLakeDirectoryClient или DataLakeFileClient.

generate_file_system_sas(account_name: str, file_system_name: str, credential: str | UserDelegationKey, permission: FileSystemSasPermissions | str | None = None, expiry: datetime | str | None = None, **kwargs: Any) -> str

Параметры

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

Имя учетной записи хранения, используемое для создания подписанного URL-адреса.

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

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

credential
str или UserDelegationKey
Обязательно

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

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

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

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

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

start
datetime или str

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

ip
str

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

protocol
str

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

cache_control
str

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

content_disposition
str

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

content_encoding
str

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

content_language
str

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

content_type
str

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

preauthorized_agent_object_id
str

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

agent_object_id
str

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

correlation_id
str

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

encryption_scope
str

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

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

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

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

str