Share via

BlobLeaseClient Класс

  • Ссылка

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

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

Наследование
builtins.object
BlobLeaseClient

Конструктор

BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)

Параметры

client
BlobClient или ContainerClient
Обязательно

Клиент большого двоичного объекта или контейнера для аренды.

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

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

Переменные

id
str

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

etag
str

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

last_modified
datetime

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

Методы

acquire

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

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

Разорвать аренду, если контейнер или большой двоичный объект имеет активную аренду.

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

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

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

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

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

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

acquire

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

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

acquire(lease_duration: int = -1, **kwargs: Any) -> 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.

if_tags_match_condition
str

Укажите предложение SQL where для тегов BLOB-объектов, которое будет работать только с большим двоичным объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

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

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. Укажите этот заголовок для выполнения операции только в том случае, если ресурс не был изменен в указанные дату и время.

if_tags_match_condition
str

Укажите предложение SQL where для тегов BLOB-объектов, которое будет работать только с большим двоичным объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

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

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. Служба BLOB-объектов возвращает значение 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.

if_tags_match_condition
str

Укажите предложение SQL where для тегов BLOB-объектов, которое будет работать только с большим двоичным объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

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

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.

if_tags_match_condition
str

Укажите предложение SQL where для тегов BLOB-объектов, которое будет работать только с большим двоичным объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

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

timeout
int

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

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

Нет

renew

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

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

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.

if_tags_match_condition
str

Укажите предложение SQL where для тегов BLOB-объектов, чтобы работать только с BLOB-объектом с соответствующим значением. Например: "\"tagname\"='my tag'"

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

timeout
int

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

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

Нет