FileService Класс
Протокол Server Message Block (SMB) — предпочитаемый протокол общего доступа к файлам, используемый локально в настоящее время. Служба файлов Microsoft Azure позволяет клиентам использовать доступность и масштабируемость SMB "Облачная инфраструктура как услуга" (IaaS) Azure без необходимости переписывать клиентские приложения SMB.
Файловая служба Azure также предлагает привлекательную альтернативу традиционным решениям непосредственно присоединенного хранилища (DAS) и сети хранения данных (SAN), которые часто оказываются слишком сложными и затратными в установке, настройке и работе.
- Наследование
-
FileService
Конструктор
FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)Параметры
- account_name
- str
имя учетной записи хранения. Используется для проверки подлинности запросов, подписанных с помощью ключа учетной записи, и для создания конечной точки хранилища. Он требуется, если не предоставлено строка подключения.
- account_key
- str
Ключ учетной записи хранения. Используется для проверки подлинности с общим ключом.
- sas_token
- str
Маркер подписанного URL-адреса, используемый для проверки подлинности запросов вместо ключа учетной записи. Если указаны ключ учетной записи и маркер SAS, для подписывания будет использоваться ключ учетной записи.
- protocol
- str
Протокол, используемый для запросов. Значение по умолчанию — https.
- endpoint_suffix
- str
Базовый компонент узла URL-адреса за вычетом имени учетной записи. По умолчанию используется Azure (core.windows.net). Переопределите его, чтобы использовать облако Для Китая (core.chinacloudapi.cn).
- request_session
- <xref:requests.Session>
Объект сеанса, который используется для HTTP-запросов.
- connection_string
- str
Если этот параметр указан, будут переопределяться все остальные параметры, кроме сеанса запроса. См. http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ формат строка подключения.
- socket_timeout
- int
Если этот параметр указан, это переопределит время ожидания сокета по умолчанию. Указанное время ожидания — в секундах. Значение по умолчанию см. в разделе DEFAULT_SOCKET_TIMEOUT в _constants.py.
Переменные
- MAX_SINGLE_GET_SIZE
- int
Размер первого диапазона выполняется методами get_file_to_*, если max_connections больше 1. Если размер файла меньше этого, будет возвращено меньше данных.
- MAX_CHUNK_GET_SIZE
- int
Размер последующего диапазона выполняется методами get_file_to_*, если max_connections больше 1, а размер файла превышает MAX_SINGLE_GET_SIZE. Если оставшаяся часть файла меньше, чем это, будет возвращено меньше данных. Если для параметра задано значение больше 4 МБ, content_validation вызовет ошибку, если он включен. Однако, если content_validation не требуется, оптимальным может быть размер, превышающий 4 МБ. Не рекомендуется устанавливать значение ниже 4 МБ.
- MAX_RANGE_SIZE
- int
Размер диапазонов, помещаемых методами create_file_from_*. При меньшем значении данных можно указать меньшие диапазоны. Максимальный размер диапазона, поддерживаемый службой, составляет 4 МБ.
Методы
| abort_copy_file |
Прерывает ожидающие операции copy_file и оставляет целевой файл с нулевой длиной и полными метаданными. |
| clear_range |
Очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона. |
| close_handles |
Возвращает генератор для закрытия открытых дескрипторов в каталоге или файле в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться после закрытия всех дескрипторов. Возвращаемые значения представляют количество дескрипторов, закрытых в каждой транзакции. |
| copy_file |
Асинхронно копирует файл. Эта операция возвращает объект свойств операции копирования, включая идентификатор копирования, который можно использовать для проверка или прерывания операции копирования. Файловая служба копирует файлы на основе наилучших усилий. Если целевой файл существует, он будет перезаписан. Не удается изменить целевой файл во время выполнения операции копирования. |
| create_directory |
Создает новый каталог в указанном общем или родительском каталоге. Если каталог с таким именем уже существует, операция в службе завершается ошибкой. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_on_exists. |
| create_file |
Создает новый файл. В разделе create_file_from_* описаны высокоуровневые функции, которые обрабатывают создание и отправку больших файлов с автоматическим фрагментированием и уведомлениями о ходе выполнения. |
| create_file_from_bytes |
Создает новый файл из массива байтов или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения. |
| create_file_from_path |
Создает новый файл Azure из локального пути к файлу или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения. |
| create_file_from_stream |
Создает новый файл из файла или потока или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения. |
| create_file_from_text |
Создает новый файл на основе str/Юникод или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения. |
| create_permission_for_share |
Создайте разрешение (дескриптор безопасности) на уровне общего ресурса. Это разрешение можно использовать для файлов и каталогов в общей папке. Если "разрешение" уже существует, оно возвращает его ключ, в противном случае создает новое разрешение на уровне общей папки и возвращает его ключ. :возвращает ключ разрешения файла :rtype str |
| create_share |
Создает новую общую папку в указанной учетной записи. Если общая папка с таким именем уже существует, операция в службе завершается ошибкой. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_on_exists. |
| delete_directory |
Удаляет указанный пустой каталог. Обратите внимание, что каталог должен быть пустым, перед тем как его можно будет удалить. Попытка удалить каталоги, которые не являются пустыми, завершится ошибкой. Если каталог не существует, операция в службе завершается сбоем. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_not_exist. |
| delete_file |
Помечает указанный файл для удаления. Позже файл удаляется во время сборки мусора. |
| delete_share |
Помечает указанный общий ресурс для удаления. Если общая папка не существует, операция в службе завершается сбоем. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_not_exist. |
| exists |
Возвращает логическое значение, указывающее, существует ли общая папка, если задано только имя общей папки. Если directory_name задано, возвращается логическое значение, указывающее, существует ли каталог. Если также указан file_name, возвращается логическое значение, указывающее, существует ли файл. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Создает подписанный URL-адрес для файловой службы. Используйте возвращенную подпись с параметром sas_token FileService. |
| generate_file_shared_access_signature |
Создает подписанный URL-адрес для файла. Используйте возвращенную сигнатуру с параметром sas_token FileService. |
| generate_share_shared_access_signature |
Создает подписанный URL-адрес для общей папки. Используйте возвращаемую сигнатуру с параметром sas_token FileService. |
| get_directory_metadata |
Возвращает все пользовательские метаданные для указанного каталога. |
| get_directory_properties |
Возвращает все определяемые пользователем метаданные и системные свойства для указанного каталога. Возвращаемые данные не включают список файлов каталога. |
| get_file_metadata |
Возвращает все пользовательские метаданные для указанного файла. |
| get_file_properties |
Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для файла. Возвращает экземпляр с FileFileProperties и диктом метаданных. |
| get_file_service_properties |
Возвращает свойства файловой службы учетной записи хранения, включая Аналитика Службы хранилища Azure. |
| get_file_to_bytes |
Загружает файл в виде массива байтов с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами, метаданными и содержимым. |
| get_file_to_path |
Скачивает файл по пути к файлу с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр файла со свойствами и метаданными. |
| get_file_to_stream |
Скачивает файл в поток с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами и метаданными. |
| get_file_to_text |
Скачивает файл в виде текста Юникода с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами, метаданными и содержимым. |
| get_permission_for_share |
Создайте разрешение (дескриптор безопасности) на уровне общей папки. Это разрешение можно использовать для файлов и каталогов в общей папке. Если "разрешение" уже существует, оно должно вернуть его ключ, в противном случае создает новое разрешение на уровне общей папки и возвращает свой ключ. :возвращает разрешение на файл (переносимый SDDL) :rtype str |
| get_share_acl |
Возвращает разрешения для указанной общей папки. |
| get_share_metadata |
Возвращает все пользовательские метаданные для указанной общей папки. |
| get_share_properties |
Возвращает все пользовательские метаданные и системные свойства для указанной общей папки. Возвращаемые данные не включают список файлов или каталогов общих папок. |
| get_share_stats |
Возвращает приблизительный размер данных, хранящихся в общей папке, округленный до ближайшего гигабайта. Обратите внимание, что это значение может включать не все недавно созданные или недавно измененные файлы. |
| get_share_stats_in_bytes |
Возвращает приблизительный размер данных, хранящихся в общей папке, в байтах. Обратите внимание, что это значение может включать не все недавно созданные или недавно измененные файлы. |
| list_directories_and_files |
Возвращает генератор для вывода списка каталогов и файлов в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возврате всех каталогов и файлов или достижении num_results. Если указан num_results, а общая папка содержит большее количество файлов и каталогов, то после завершения генератор будет иметь заполненное поле next_marker. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты. |
| list_handles |
Возвращает генератор для вывода списка открытых дескрипторов в каталоге или файле в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возврате всех дескрипторов или достижении num_results. Если указан num_results, а общая папка содержит большее количество файлов и каталогов, то после завершения генератор будет иметь заполненное поле next_marker. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты. |
| list_ranges |
Извлекает допустимые диапазоны для файла. |
| list_shares |
Возвращает генератор для перечисления общих папок в указанной учетной записи. Генератор будет лениво следовать маркерам продолжения, возвращенным службой, и останавливаться, когда будут возвращены все общие папки или достигнут num_results. Если указано num_results и у учетной записи больше, чем это количество общих папок, генератор будет заполнен полем next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты. |
| make_file_url |
Создает URL-адрес для доступа к файлу. |
| resize_file |
Изменяет размер файла на указанный. Если указанное байтовое значение меньше текущего размера файла, то все диапазоны свыше указанного байтового значения очищаются. |
| set_directory_metadata |
Задает одну или несколько определяемых пользователем пар "имя-значение" для указанного каталога. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к каталогу. Чтобы удалить все метаданные из каталога, вызовите эту операцию без дикта метаданных. |
| set_directory_properties | |
| set_file_metadata |
Задает определяемые пользователем метаданные для указанного файла в виде одной или нескольких пар "имя-значение". |
| set_file_properties |
Задает системные свойства файла. Если для content_settings задано одно свойство, все свойства будут переопределены. |
| set_file_service_properties |
Задает свойства файловой службы учетной записи хранения, включая Аналитика Службы хранилища Azure. Если элемент (например, HourMetrics) остается как None, существующие параметры службы для этой функции сохраняются. |
| set_proxy |
Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT. |
| set_share_acl |
Задает разрешения для указанной общей папки или хранимых политик доступа, которые могут использоваться с подписанными URL-адресами. |
| set_share_metadata |
Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной общей папки. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к общему ресурсу. Чтобы удалить все метаданные из общей папки, вызовите эту операцию без диктовки метаданных. |
| set_share_properties |
Задает определяемые службой свойства для указанной общей папки. |
| snapshot_share |
Создает snapshot существующей общей папки в указанной учетной записи. |
| update_range |
Записывает байты, указанные текстом запроса, в указанный диапазон. |
| update_range_from_file_url |
Записывает байты из одной конечной точки файла Azure в указанный диапазон другой конечной точки файла Azure. |
abort_copy_file
Прерывает ожидающие операции copy_file и оставляет целевой файл с нулевой длиной и полными метаданными.
abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)Параметры
clear_range
Очищает указанный диапазон и освобождает пространство, используемое в хранилище для этого диапазона.
clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)Параметры
- start_range
- int
Начало диапазона байтов, используемого для очистки раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для очистки раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
close_handles
Возвращает генератор для закрытия открытых дескрипторов в каталоге или файле в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться после закрытия всех дескрипторов. Возвращаемые значения представляют количество дескрипторов, закрытых в каждой транзакции.
close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)Параметры
- recursive
- bool
Логическое значение, указывающее, должна ли операция применяться к каталогу, указанному в URI, его файлам, подкаталогам и файлам.
- handle_id
- str
Обязательный. Указывает идентификатор дескриптора, открытого в закрываемом файле или каталоге. Astrix ('*') — это подстановочный знак, указывающий все дескрипторы.
- marker
- str
Непрозрачный маркер продолжения. Это значение можно получить из поля next_marker предыдущего объекта генератора, если он не завершил закрывающие дескрипторы. Если он указан, этот генератор начнет закрывать дескриптор с точки, где остановлен предыдущий генератор.
copy_file
Асинхронно копирует файл. Эта операция возвращает объект свойств операции копирования, включая идентификатор копирования, который можно использовать для проверка или прерывания операции копирования. Файловая служба копирует файлы на основе наилучших усилий.
Если целевой файл существует, он будет перезаписан. Не удается изменить целевой файл во время выполнения операции копирования.
copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)Параметры
- file_name
- str
Имя целевого файла. Если целевой файл существует, он будет перезаписан. В противном случае он будет создан.
- copy_source
- str
URL-адрес длиной до 2 КБ, указывающий файл или большой двоичный объект Azure. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
Пары «имя-значение», связанные с файлом как метаданные. Если пары "имя-значение" не указаны, операция копирует метаданные из исходного большого двоичного объекта или файла в целевой файл. Если указана одна или несколько пар "имя-значение", целевой файл создается с указанными метаданными, а метаданные не копируются из исходного BLOB-объекта или файла.
Возвращаемое значение
Свойства операции копирования, такие как состояние, источник и идентификатор.
Возвращаемый тип
create_directory
Создает новый каталог в указанном общем или родительском каталоге. Если каталог с таким именем уже существует, операция в службе завершается ошибкой. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_on_exists.
create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
Диктовка с name_value парами для связывания с общей папкой в качестве метаданных. Пример:{'Category':'test'}
- fail_on_exist
- bool
укажите, следует ли создавать исключение при наличии каталога. Значение по умолчанию: false.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
Возвращаемое значение
Значение true, если каталог создан, false, если каталог уже существует.
Возвращаемый тип
create_file
Создает новый файл.
В разделе create_file_from_* описаны высокоуровневые функции, которые обрабатывают создание и отправку больших файлов с автоматическим фрагментированием и уведомлениями о ходе выполнения.
create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
Пары «имя-значение», связанные с файлом как метаданные.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
create_file_from_bytes
Создает новый файл из массива байтов или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
- count
- int
Количество байтов для отправки. Задайте значение Нет или отрицательное значение, чтобы передать все байты, начиная с индекса.
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
Пары «имя-значение», связанные с файлом как метаданные.
- validate_content
- bool
Если значение равно true, вычисляет хэш MD5 для каждого диапазона файла. Служба хранилища проверяет хэш отправленного содержимого. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что этот хэш MD5 не хранится вместе с файлом.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — количество переданных байтов, а total — размер файла, или None, если общий размер неизвестен.
- max_connections
- int
Максимальное число параллельных подключений для использования.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.
create_file_from_path
Создает новый файл Azure из локального пути к файлу или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)Параметры
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
Пары «имя-значение», связанные с файлом как метаданные.
- validate_content
- bool
Если значение равно true, вычисляет хэш MD5 для каждого диапазона файла. Служба хранилища проверяет хэш отправленного содержимого. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что этот хэш MD5 не хранится вместе с файлом.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — количество переданных байтов, а total — размер файла, или None, если общий размер неизвестен.
- max_connections
- int
Максимальное число параллельных подключений для использования.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.
create_file_from_stream
Создает новый файл из файла или потока или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
- count
- int
Число байтов для чтения из потока. Это обязательно. Файл не может быть создан, если счетчик неизвестен.
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
Пары «имя-значение», связанные с файлом как метаданные.
- validate_content
- bool
Если значение равно true, вычисляет хэш MD5 для каждого диапазона файла. Служба хранилища проверяет хэш отправленного содержимого. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что этот хэш MD5 не хранится вместе с файлом.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — количество переданных байтов, а total — размер файла, или None, если общий размер неизвестен.
- max_connections
- int
Максимальное число параллельных подключений для использования. Обратите внимание, что для параллельной отправки требуется, чтобы поток можно было искать.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.
create_file_from_text
Создает новый файл на основе str/Юникод или обновляет содержимое существующего файла с помощью автоматического фрагментирования и уведомлений о ходе выполнения.
create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
Пары «имя-значение», связанные с файлом как метаданные.
- validate_content
- bool
Если значение равно true, вычисляет хэш MD5 для каждого диапазона файла. Служба хранилища проверяет хэш отправленного содержимого. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что этот хэш MD5 не хранится вместе с файлом.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.
create_permission_for_share
Создайте разрешение (дескриптор безопасности) на уровне общего ресурса. Это разрешение можно использовать для файлов и каталогов в общей папке. Если "разрешение" уже существует, оно возвращает его ключ, в противном случае создает новое разрешение на уровне общей папки и возвращает его ключ.
:возвращает ключ разрешения файла :rtype str
create_permission_for_share(share_name, file_permission, timeout=None)Параметры
- share_name
Имя общей папки.
- file_permission
Разрешение файла, переносимое SDDL
- timeout
Параметр времени ожидания указывается в секундах.
create_share
Создает новую общую папку в указанной учетной записи. Если общая папка с таким именем уже существует, операция в службе завершается ошибкой. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_on_exists.
create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)Параметры
Диктовка с name_value парами для связывания с общей папкой в качестве метаданных. Пример:{'Category':'test'}
- quota
- int
Задает максимальный размер общего ресурса в ГБ. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120).
- fail_on_exist
- bool
Укажите, следует ли создавать исключение при наличии общей папки. Значение по умолчанию: false.
Возвращаемое значение
Значение True, если общий ресурс создан, false, если общий ресурс уже существует.
Возвращаемый тип
delete_directory
Удаляет указанный пустой каталог. Обратите внимание, что каталог должен быть пустым, перед тем как его можно будет удалить. Попытка удалить каталоги, которые не являются пустыми, завершится ошибкой.
Если каталог не существует, операция в службе завершается сбоем. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_not_exist.
delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)Параметры
- fail_not_exist
- bool
Укажите, следует ли создавать исключение, если каталог не существует.
Возвращаемое значение
Значение true, если каталог удален, в противном случае — false.
Возвращаемый тип
delete_file
Помечает указанный файл для удаления. Позже файл удаляется во время сборки мусора.
delete_file(share_name, directory_name, file_name, timeout=None)Параметры
delete_share
Помечает указанный общий ресурс для удаления. Если общая папка не существует, операция в службе завершается сбоем. По умолчанию исключение поглощается клиентом. Чтобы предоставить исключение, укажите значение True для fail_not_exist.
delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)Параметры
- fail_not_exist
- bool
Укажите, следует ли создавать исключение, если общая папка не существует. Значение по умолчанию: false.
- snapshot
- str
Строка, представляющая версию snapshot, если применимо. Укажите этот аргумент, чтобы удалить только определенный snapshot. delete_snapshots должно иметь значение None, если он указан.
- delete_snapshots
- DeleteSnapshot
Чтобы удалить общую папку с моментальными снимками, ее необходимо указать как DeleteSnapshot.Include.
Возвращаемое значение
Значение true, если общий ресурс удален, общая папка false не существует.
Возвращаемый тип
exists
Возвращает логическое значение, указывающее, существует ли общая папка, если задано только имя общей папки. Если directory_name задано, возвращается логическое значение, указывающее, существует ли каталог. Если также указан file_name, возвращается логическое значение, указывающее, существует ли файл.
exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)Параметры
Возвращаемое значение
Логическое значение, указывающее, существует ли ресурс.
Возвращаемый тип
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Параметры
- retry_context
generate_account_shared_access_signature
Создает подписанный URL-адрес для файловой службы. Используйте возвращенную подпись с параметром sas_token FileService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Параметры
- resource_types
- <xref:ResourceTypes>
Указывает типы ресурсов, доступные с помощью SAS учетной записи.
- permission
- <xref:AccountPermissions>
Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Требуется, если не предоставлен идентификатор, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.
Время, когда подписанный URL-адрес становится недействительным. Требуется, если не предоставлен идентификатор, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа. Azure всегда будет преобразовывать значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC.
Время, когда подписанный URL-адрес становится действительным. Если не указано, то время начала для данного вызова считается временем, когда служба хранилища получает запрос. Azure всегда будет преобразовывать значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC.
- ip
- str
Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.
- protocol
- str
Указывает протокол, разрешенный для выполненного запроса. Возможные значения: HTTPS и HTTP (https,http) или ТОЛЬКО HTTPS (https). Значение по умолчанию — https,http. Обратите внимание, что использовать только протокол HTTP нельзя.
Возвращаемое значение
Маркер подписанного URL-адреса (SAS).
Возвращаемый тип
generate_file_shared_access_signature
Создает подписанный URL-адрес для файла. Используйте возвращенную сигнатуру с параметром sas_token FileService.
generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)Параметры
- directory_name
- str
Имя каталога. Маркеры SAS невозможно создать для каталогов, поэтому этот параметр должен присутствовать только в том случае, если указан file_name.
- permission
- FilePermissions
Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Разрешения должны быть упорядочены для чтения, создания, записи, удаления, списка. Требуется, если не предоставлен идентификатор, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.
Время, когда подписанный URL-адрес становится недействительным. Требуется, если не предоставлен идентификатор, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа. Azure всегда будет преобразовывать значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC.
Время, когда подписанный URL-адрес становится действительным. Если не указано, то время начала для данного вызова считается временем, когда служба хранилища получает запрос. Azure всегда будет преобразовывать значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она имеет значение UTC.
- id
- str
Уникальное значение длиной до 64 символов, которое соответствует хранимой политике доступа. Чтобы создать хранимую политику доступа, используйте set_file_service_properties.
- ip
- str
Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.
- protocol
- str
Указывает протокол, разрешенный для выполненного запроса. Возможные значения: HTTPS и HTTP (https,http) или ТОЛЬКО HTTPS (https). Значение по умолчанию — https,http. Обратите внимание, что использовать только протокол HTTP нельзя.
- 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-адреса.
Возвращаемое значение
Маркер подписанного URL-адреса (SAS).
Возвращаемый тип
generate_share_shared_access_signature
Создает подписанный URL-адрес для общей папки. Используйте возвращаемую сигнатуру с параметром sas_token FileService.
generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)Параметры
- permission
- SharePermissions
Разрешения, связанные с подписанным URL-адресом. Пользователь может выполнять только операции, допускаемые этими разрешениями. Разрешения должны быть упорядочены для чтения, создания, записи, удаления, списка. Требуется, если идентификатор не указан, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа.
Время, когда подписанный URL-адрес становится недействительным. Требуется, если идентификатор не указан, ссылающийся на хранимую политику доступа, содержащую это поле. Это поле необходимо пропустить, если оно указано в связанной хранимой политике доступа. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.
Время, когда подписанный URL-адрес становится действительным. Если не указано, то время начала для данного вызова считается временем, когда служба хранилища получает запрос. Azure всегда преобразует значения в формат UTC. Если дата передается без сведений о часовом поясе, предполагается, что она будет в формате UTC.
- id
- str
Уникальное значение длиной до 64 символов, коррелирует с хранимой политикой доступа. Чтобы создать хранимую политику доступа, используйте .set_share_acl
- ip
- str
Указывает IP-адрес или диапазон IP-адресов, с которых будут приниматься запросы. Если IP-адрес, с которого исходит запрос, не соответствует IP-адресу или диапазону адресов, указанным в маркере SAS, запрос не проходит проверку подлинности. Например, указание sip=168.1.5.65 или sip=168.1.5.60-168.1.5.70 в SAS ограничивает запрос этими IP-адресами.
- protocol
- str
Указывает протокол, разрешенный для выполненного запроса. Возможные значения: HTTPS и HTTP (https,http) или ТОЛЬКО HTTPS (https). Значение по умолчанию — https,http. Обратите внимание, что использовать только протокол HTTP нельзя.
- 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-адреса.
Возвращаемое значение
Маркер подписанного URL-адреса (SAS).
Возвращаемый тип
get_directory_metadata
Возвращает все пользовательские метаданные для указанного каталога.
get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
Словарь, представляющий имя метаданных каталога, пары значений.
Возвращаемый тип
get_directory_properties
Возвращает все определяемые пользователем метаданные и системные свойства для указанного каталога. Возвращаемые данные не включают список файлов каталога.
get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
свойства для указанного каталога в объекте каталога.
Возвращаемый тип
get_file_metadata
Возвращает все пользовательские метаданные для указанного файла.
get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
Словарь, представляющий имя метаданных файла, пары значений.
Возвращаемый тип
get_file_properties
Возвращает все определяемые пользователем метаданные, стандартные свойства HTTP и системные свойства для файла. Возвращает экземпляр с FileFileProperties и диктом метаданных.
get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
объект файла, включающий свойства и метаданные.
Возвращаемый тип
get_file_service_properties
Возвращает свойства файловой службы учетной записи хранения, включая Аналитика Службы хранилища Azure.
get_file_service_properties(timeout=None)Параметры
Возвращаемое значение
Свойства файловой службы.
Возвращаемый тип
get_file_to_bytes
Загружает файл в виде массива байтов с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами, метаданными и содержимым.
get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)Параметры
- start_range
- int
Начало диапазона байтов, используемого для скачивания раздела файла. Если end_range не задано, скачиваются все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для скачивания раздела файла. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- validate_content
- bool
Если задано значение true, проверяет хэш MD5 для каждой извлеченной части файла. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные MD5 только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если самостоятельно. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, возникает ошибка. Поскольку вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может увеличиться.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер файла, если он известен.
- max_connections
- int
Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов файла. Если это весь файл, метод возвращает на этом этапе. Если это не так, он будет скачивать оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый кусок будет иметь размер самостоятельно. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если следует использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если файл одновременно изменяется для обеспечения атомарности или если ожидается, что многие файлы будут пустыми, так как для пустых файлов требуется дополнительный запрос, если max_connections больше 1.
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов службы Azure, и время ожидания будет применяться к каждому вызову по отдельности.
Возвращаемое значение
Файл со свойствами, содержимым и метаданными.
Возвращаемый тип
get_file_to_path
Скачивает файл по пути к файлу с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр файла со свойствами и метаданными.
get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)Параметры
- open_mode
- str
Режим, используемый при открытии файла. Обратите внимание, что указание только добавления open_mode предотвращает параллельную загрузку. Таким образом, max_connections необходимо задать значение 1, если используется эта open_mode.
- start_range
- int
Начало диапазона байтов, используемого для скачивания раздела файла. Если end_range не задано, будут загружены все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для скачивания раздела файла. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- validate_content
- bool
Если задано значение true, проверяет хэш MD5 для каждой извлеченной части файла. Это в первую очередь полезно для обнаружения битовых фрагментов в сети, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные md5s только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь собственный размер. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если self. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, будет выдана ошибка. Так как вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может быть увеличена.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер файла, если он известен.
- max_connections
- int
Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов файла. Если это весь файл, метод возвращает на этом этапе. Если это не так, он скачивает оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый блок будет иметь размер self. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если необходимо использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если файл одновременно изменяется для обеспечения атомарности или если ожидается, что многие файлы будут пустыми, так как для пустых файлов требуется дополнительный запрос, если max_connections больше 1.
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.
Возвращаемое значение
Файл со свойствами и метаданными.
Возвращаемый тип
get_file_to_stream
Скачивает файл в поток с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами и метаданными.
get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)Параметры
- start_range
- int
Начало диапазона байтов, используемого для скачивания раздела файла. Если end_range не задано, будут загружены все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для скачивания раздела файла. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- validate_content
- bool
Если задано значение true, проверяет хэш MD5 для каждой извлеченной части файла. Это в первую очередь полезно для обнаружения битовых фрагментов в сети, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные md5s только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь собственный размер. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если self. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, будет выдана ошибка. Так как вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может быть увеличена.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер файла, если он известен.
- max_connections
- int
Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов файла. Если это весь файл, метод возвращает на этом этапе. Если это не так, он скачивает оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый блок будет иметь размер self. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если необходимо использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если файл одновременно изменяется для обеспечения атомарности или если ожидается, что многие файлы будут пустыми, так как для пустых файлов требуется дополнительный запрос, если max_connections больше 1.
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.
Возвращаемое значение
Файл со свойствами и метаданными.
Возвращаемый тип
get_file_to_text
Скачивает файл в виде текста Юникода с автоматическим фрагментированием и уведомлениями о ходе выполнения. Возвращает экземпляр со File свойствами, метаданными и содержимым.
get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)Параметры
- encoding
- str
Кодировка Python, используемая при декодировании данных файла.
- start_range
- int
Начало диапазона байтов, используемого для скачивания раздела файла. Если end_range не задано, будут загружены все байты после start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для скачивания раздела файла. Если задано end_range, необходимо указать start_range. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- validate_content
- bool
Если задано значение true, проверяет хэш MD5 для каждой извлеченной части файла. Это в первую очередь полезно для обнаружения битовых фрагментов в сети, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что служба будет возвращать транзакционные md5s только для блоков размером 4 МБ или меньше, поэтому первый запрос на получение будет иметь собственный размер. MAX_CHUNK_GET_SIZE вместо себя. MAX_SINGLE_GET_SIZE. Если self. MAX_CHUNK_GET_SIZE задано значение больше 4 МБ, будет выдана ошибка. Так как вычисление MD5 занимает время обработки и потребуется выполнить больше запросов из-за уменьшения размера блока, задержка может быть увеличена.
- progress_callback
- <xref:func>(<xref:current>, <xref:total>)
Обратный вызов для выполнения с функцией сигнатуры (current, total), где current — это количество переданных байтов, а total — это размер файла, если он известен.
- max_connections
- int
Если задано значение 2 или больше, для первого экземпляра будет выполнено начальное получение. MAX_SINGLE_GET_SIZE байтов файла. Если это весь файл, метод возвращает на этом этапе. Если это не так, он скачивает оставшиеся данные параллельно, используя количество потоков, равное max_connections. Каждый блок будет иметь размер self. MAX_CHUNK_GET_SIZE. Если задано значение 1, будет выполнен один большой запрос на получение. Как правило, это не рекомендуется, но доступно, если необходимо использовать очень мало потоков, сетевые запросы являются очень дорогими или поток без поиска предотвращает параллельную загрузку. Это также может быть полезно, если файл одновременно изменяется для обеспечения атомарности или если ожидается, что многие файлы будут пустыми, так как для пустых файлов требуется дополнительный запрос, если max_connections больше 1.
- timeout
- int
Параметр времени ожидания указывается в секундах. Этот метод может выполнять несколько вызовов к службе Azure, и время ожидания будет применяться к каждому вызову по отдельности.
Возвращаемое значение
Файл со свойствами, содержимым и метаданными.
Возвращаемый тип
get_permission_for_share
Создайте разрешение (дескриптор безопасности) на уровне общей папки. Это разрешение можно использовать для файлов и каталогов в общей папке. Если "разрешение" уже существует, оно должно вернуть его ключ, в противном случае создает новое разрешение на уровне общей папки и возвращает свой ключ.
:возвращает разрешение на файл (переносимый SDDL) :rtype str
get_permission_for_share(share_name, file_permission_key, timeout=None)Параметры
- share_name
Имя общей папки.
- file_permission_key
Ключ разрешения на получение файла
- timeout
Параметр времени ожидания указывается в секундах.
get_share_acl
Возвращает разрешения для указанной общей папки.
get_share_acl(share_name, timeout=None)Параметры
Возвращаемое значение
Словарь политик доступа, связанных с общей папкой.
Возвращаемый тип
get_share_metadata
Возвращает все пользовательские метаданные для указанной общей папки.
get_share_metadata(share_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
Словарь, представляющий имя метаданных общей папки, пары значений.
Возвращаемый тип
get_share_properties
Возвращает все пользовательские метаданные и системные свойства для указанной общей папки. Возвращаемые данные не включают список файлов или каталогов общих папок.
get_share_properties(share_name, timeout=None, snapshot=None)Параметры
Возвращаемое значение
Общий ресурс, предоставляющий свойства и метаданные.
Возвращаемый тип
get_share_stats
Возвращает приблизительный размер данных, хранящихся в общей папке, округленный до ближайшего гигабайта.
Обратите внимание, что это значение может включать не все недавно созданные или недавно измененные файлы.
get_share_stats(share_name, timeout=None)Параметры
Возвращаемое значение
приблизительный размер данных, хранящихся в общей папке.
Возвращаемый тип
get_share_stats_in_bytes
Возвращает приблизительный размер данных, хранящихся в общей папке, в байтах.
Обратите внимание, что это значение может включать не все недавно созданные или недавно измененные файлы.
get_share_stats_in_bytes(share_name, timeout=None)Параметры
Возвращаемое значение
приблизительный размер данных, хранящихся в общей папке.
Возвращаемый тип
list_directories_and_files
Возвращает генератор для вывода списка каталогов и файлов в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возврате всех каталогов и файлов или достижении num_results.
Если указан num_results, а общая папка содержит большее количество файлов и каталогов, то после завершения генератор будет иметь заполненное поле next_marker. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)Параметры
- num_results
- int
Задает максимальное количество возвращаемых файлов, включая все элементы каталога. Если в запросе не указано num_results или указано значение больше 5000, сервер вернет до 5000 элементов. Установка num_results значения меньше или равного нулю приводит к возникновению кода ответа об ошибке 400 (недопустимый запрос).
- marker
- str
Непрозрачный маркер продолжения. Это значение можно получить из поля next_marker предыдущего объекта генератора, если num_results был указан и этот генератор завершил перечисление результатов. Если этот генератор указан, он начнет возвращать результаты с точки, где остановлен предыдущий генератор.
- prefix
- str
Вывод списка только файлов и (или) каталогов с заданным префиксом.
list_handles
Возвращает генератор для вывода списка открытых дескрипторов в каталоге или файле в указанной общей папке. Генератор будет отложенно следовать маркерам продолжения, возвращенным службой, и останавливаться при возврате всех дескрипторов или достижении num_results.
Если указан num_results, а общая папка содержит большее количество файлов и каталогов, то после завершения генератор будет иметь заполненное поле next_marker. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)Параметры
- recursive
- bool
Логическое значение, указывающее, должна ли операция применяться к каталогу, указанному в URI, его файлам, подкаталогам и файлам.
- max_results
- int
Указывает максимальное количество дескрипторов, принятых для возвращаемых файлов и (или) каталогов. Если в запросе не указано max_results или указано значение больше 5000, сервер вернет до 5000 элементов. Установка max_results значения меньше или равного нулю приводит к коду ответа об ошибке 400 (недопустимый запрос).
- marker
- str
Непрозрачный маркер продолжения. Это значение можно получить из поля next_marker предыдущего объекта генератора, если был указан max_results и этот генератор завершил перечисление результатов. Если этот генератор указан, он начнет возвращать результаты с точки, где остановлен предыдущий генератор.
list_ranges
Извлекает допустимые диапазоны для файла.
list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)Параметры
- start_range
- int
Задает начальную смещение байтов, по которым перечисляются диапазоны. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Указывает конечное смещение байтов, по которым перечисляются диапазоны. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
Возвращаемое значение
список допустимых диапазонов;
Возвращаемый тип
list_shares
Возвращает генератор для перечисления общих папок в указанной учетной записи. Генератор будет лениво следовать маркерам продолжения, возвращенным службой, и останавливаться, когда будут возвращены все общие папки или достигнут num_results.
Если указано num_results и у учетной записи больше, чем это количество общих папок, генератор будет заполнен полем next_marker после завершения. Этот маркер можно использовать для создания нового генератора, если нужны дополнительные результаты.
list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)Параметры
- prefix
- str
Фильтрует результаты для возврата только общих папок, имена которых начинаются с указанного префикса.
- num_results
- int
Указывает максимальное количество возвращаемых общих ресурсов.
- include_metadata
- bool
Указывает, что в ответе возвращаются метаданные общего ресурса.
- marker
- str
Непрозрачный маркер продолжения. Это значение можно получить из поля next_marker предыдущего объекта генератора, если num_results был указан и этот генератор завершил перечисление результатов. Если этот генератор указан, он начнет возвращать результаты с точки, где остановлен предыдущий генератор.
- include_snapshots
- bool
Указывает, что моментальные снимки общих ресурсов возвращаются в ответе.
make_file_url
Создает URL-адрес для доступа к файлу.
make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)Параметры
- protocol
- str
Используемый протокол: "http" или "https". Если не указано, использует протокол, указанный при инициализации FileService.
- sas_token
- str
Маркер подписанного URL-адреса, созданный с помощью generate_shared_access_signature.
Возвращаемое значение
URL-адрес доступа к файлу.
Возвращаемый тип
resize_file
Изменяет размер файла на указанный. Если указанное байтовое значение меньше текущего размера файла, то все диапазоны свыше указанного байтового значения очищаются.
resize_file(share_name, directory_name, file_name, content_length, timeout=None)Параметры
set_directory_metadata
Задает одну или несколько определяемых пользователем пар "имя-значение" для указанного каталога. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к каталогу. Чтобы удалить все метаданные из каталога, вызовите эту операцию без дикта метаданных.
set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)Параметры
Дикт, содержащий пары "имя-значение", которые необходимо связать с каталогом в качестве метаданных. Пример: {'category':'test'}
set_directory_properties
set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)Параметры
- share_name
Имя общей папки
- directory_name
Имя каталога
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
set_file_metadata
Задает определяемые пользователем метаданные для указанного файла в виде одной или нескольких пар "имя-значение".
set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)Параметры
Дикт, содержащий пары имен и значений. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к файлу. Чтобы удалить все метаданные из файла, вызовите эту операцию без заголовков метаданных.
set_file_properties
Задает системные свойства файла. Если для content_settings задано одно свойство, все свойства будут переопределены.
set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)Параметры
- content_settings
- ContentSettings
Объект ContentSettings, используемый для задания свойств файла.
- smb_properties
- SMBProperties
Задает свойства файла, связанного с SMB
set_file_service_properties
Задает свойства файловой службы учетной записи хранения, включая Аналитика Службы хранилища Azure. Если элемент (например, HourMetrics) остается как None, существующие параметры службы для этой функции сохраняются.
set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)Параметры
- hour_metrics
- <xref:Metrics>
Параметры часовых метрик предоставляют сводку статистики запросов, сгруппированных по API, в почасовых статистических выражениях для файлов.
- minute_metrics
- <xref:Metrics>
Параметры метрик минут предоставляют статистику запросов за каждую минуту для файлов.
- cors
- list(CorsRule)
В список можно включить до пяти элементов CorsRule. Если указан пустой список, все правила CORS будут удалены, а CORS будет отключен для службы.
set_proxy
Задает узел прокси-сервера и порт для туннелирования HTTP CONNECT.
set_proxy(host, port, user=None, password=None)Параметры
set_share_acl
Задает разрешения для указанной общей папки или хранимых политик доступа, которые могут использоваться с подписанными URL-адресами.
set_share_acl(share_name, signed_identifiers=None, timeout=None)Параметры
- signed_identifiers
- dict(str, AccessPolicy)
Словарь политик доступа, которые необходимо связать с общей папкой. Словарь может содержать до 5 элементов. Пустой словарь очистит политики доступа, заданные в службе.
set_share_metadata
Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной общей папки. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к общему ресурсу. Чтобы удалить все метаданные из общей папки, вызовите эту операцию без диктовки метаданных.
set_share_metadata(share_name, metadata=None, timeout=None)Параметры
Дикт, содержащий пары "имя-значение", которые необходимо связать с общей папкой в качестве метаданных. Пример: {'category':'test'}
set_share_properties
Задает определяемые службой свойства для указанной общей папки.
set_share_properties(share_name, quota, timeout=None)Параметры
- quota
- int
Задает максимальный размер общего ресурса в ГБ. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120 ГБ).
snapshot_share
Создает snapshot существующей общей папки в указанной учетной записи.
snapshot_share(share_name, metadata=None, quota=None, timeout=None)Параметры
- metadata
- <xref:<xref:a dict> of <xref:str to str:>>
Диктовка с name_value парами для связывания с общей папкой в качестве метаданных. Пример:{'Category':'test'}
- quota
- int
Задает максимальный размер общего ресурса в ГБ. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120).
Возвращаемое значение
свойства snapshot
Возвращаемый тип
update_range
Записывает байты, указанные текстом запроса, в указанный диапазон.
update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)Параметры
- start_range
- int
Начало диапазона байтов, используемого для обновления раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для обновления раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- validate_content
- bool
Если значение равно true, вычисляет md5-хэш содержимого страницы. Служба хранилища проверяет хэш отправленного содержимого. Это в первую очередь полезно для обнаружения битовых слипов в проводе, если использование http вместо https, так как https (по умолчанию) уже проверяется. Обратите внимание, что этот хэш MD5 не хранится вместе с файлом.
update_range_from_file_url
Записывает байты из одной конечной точки файла Azure в указанный диапазон другой конечной точки файла Azure.
update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)Параметры
- start_range
- int
Начало диапазона байтов, используемого для обновления раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- end_range
- int
Конец диапазона байтов, используемый для обновления раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
- source
- str
URL-адрес длиной до 2 КБ, указывающий файл или большой двоичный объект Azure. Значение должно быть закодировано в URL-адресе в том виде, в каком оно указано в запросе URI. Если источник находится в другой учетной записи, источник должен быть общедоступным или пройти проверку подлинности с помощью подписанного URL-адреса. Если источник является общедоступным, проверка подлинности не требуется. Примеры: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
- source_start_range
- int
Начало диапазона байтов, используемого для обновления раздела файла. Размер диапазона может составлять до 4 МБ. Параметры start_range и end_range являются инклюзивными. Например, start_range=0, end_range=511 скачает первые 512 байт файла.
Атрибуты
protocol
request_session
socket_timeout
MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 8388608MAX_RANGE_SIZE
MAX_RANGE_SIZE = 4194304MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432
Azure SDK for Python
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по