DataLakeLeaseClient Класс

Создает новый объект DataLakeLeaseClient.

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

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

builtins.object

DataLakeLeaseClient

Конструктор

DataLakeLeaseClient(client: FileSystemClient | DataLakeDirectoryClient | DataLakeFileClient, lease_id: str | None = None)

Параметры

client

FileSystemClient или DataLakeDirectoryClient или DataLakeFileClient

Обязательно

Клиент файловой системы, каталога или файла для аренды.

lease_id

str

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

Строка, представляющая идентификатор существующей аренды. Это значение не нужно указывать, чтобы получить новую аренду или разорвать ее.

Переменные

id

str

Идентификатор аренды, обслуживаемой в настоящее время. Если аренда еще не приобретена, это будет значение None .

etag

str

ETag аренды, обслуживаемой в настоящее время. Если аренда еще не приобретена или изменена, это будет значение None .

last_modified

datetime

Последнее изменение метки времени аренды, поддерживаемой в настоящее время. Если аренда еще не приобретена или изменена, это будет значение None .

Методы

acquire	Запрашивает новую аренду. Если у файловой или файловой системы нет активной аренды, служба DataLake создает аренду для файловой или файловой системы и возвращает новый идентификатор аренды.
break_lease	Разорвать аренду, если у файловой системы или файла есть активная аренда. После прекращения аренду нельзя продлить. Авторизованный запрос может прекратить аренду. В запросе не обязательно указывать соответствующий идентификатор аренды. При прерывании аренды допускается истечение периода перерыва аренды, в течение которого в файловой системе или файле не может быть выполнена операция аренды, за исключением прерывания и освобождения. После успешного прекращения аренды ответ указывает интервал в секундах, прежде чем можно будет приобрести новую аренду.
change	Изменение идентификатора активной аренды.
release	Освобождает аренду. Аренда может быть освобождена, если указанный идентификатор аренды клиента соответствует идентификатору, связанному с файловой системой или файлом. Освобождение аренды позволяет другому клиенту немедленно получить аренду файловой системы или файла сразу после завершения выпуска.
renew	Продлевает аренду. Аренда может быть продлена, если идентификатор аренды, указанный в клиенте аренды, совпадает с идентификатором, связанным с файловой системой или файлом. Обратите внимание, что аренда может быть продлена, даже если срок ее действия истек до тех пор, пока файловая система или файл не были арендованы повторно после истечения срока действия этой аренды. При продлении аренды срок действия начинается заново.

acquire

Запрашивает новую аренду.

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

acquire(lease_duration: int = -1, **kwargs: int | None) -> None

Параметры

lease_duration

int

Обязательно

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

if_modified_since

datetime

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

if_unmodified_since

datetime

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

etag

str

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

match_condition

MatchConditions

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

timeout

int

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

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

None

break_lease

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

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

break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int

Параметры

lease_break_period

int

Обязательно

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

if_modified_since

datetime

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

if_unmodified_since

datetime

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

timeout

int

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

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

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

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

int

change

Изменение идентификатора активной аренды.

change(proposed_lease_id: str, **kwargs: Any) -> None

Параметры

proposed_lease_id

str

Обязательно

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

if_modified_since

datetime

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

if_unmodified_since

datetime

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

etag

str

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

match_condition

MatchConditions

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

timeout

int

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

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

Нет

release

Освобождает аренду.

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

release(**kwargs: Any) -> None

Параметры

if_modified_since

datetime

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

if_unmodified_since

datetime

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

etag

str

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

match_condition

MatchConditions

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

timeout

int

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

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

Нет

renew

Продлевает аренду.

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

renew(**kwargs: Any) -> None

Параметры

if_modified_since

datetime

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

if_unmodified_since

datetime

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

etag

str

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

match_condition

MatchConditions

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

timeout

int

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

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

Нет