BlobLeaseClient class
Клиент, который управляет арендой для <xref:ContainerClient> или <xref:BlobClient>.
Конструкторы
| Blob |
Создает экземпляр BlobLeaseClient. |
Методы
| acquire |
Устанавливает блокировку контейнера для операций удаления или большого двоичного объекта для операций записи и удаления. Длительность блокировки может составлять от 15 до 60 секунд или может быть бесконечной. |
| break |
Чтобы завершить аренду, но убедиться, что другой клиент не может получить новую аренду до истечения текущего периода аренды. |
| change |
Изменение идентификатора аренды. |
| release |
Чтобы освободить аренду, если он больше не нужен, чтобы другой клиент мог немедленно получить аренду для контейнера или большого двоичного объекта. |
| renew |
Продление аренды. |
Сведения о конструкторе
BlobLeaseClient(ContainerClient | BlobClient, string)
Создает экземпляр BlobLeaseClient.
new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId?: string)Параметры
- client
Клиент, выполняя запросы на аренду.
- leaseId
-
string
Первоначальный предлагаемый идентификатор аренды.
Сведения о свойстве
leaseId
Возвращает идентификатор аренды.
string leaseIdЗначение свойства
string
url
Возвращает URL-адрес.
string urlЗначение свойства
string
Сведения о методе
acquireLease(number, LeaseOperationOptions)
Устанавливает блокировку контейнера для операций удаления или большого двоичного объекта для операций записи и удаления. Длительность блокировки может составлять от 15 до 60 секунд или может быть бесконечной.
function acquireLease(duration: number, options?: LeaseOperationOptions)Параметры
- duration
-
number
Должно быть от 15 до 60 секунд или бесконечно (-1)
- options
- LeaseOperationOptions
параметр настройки операций управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для получения операции аренды.
breakLease(number, LeaseOperationOptions)
Чтобы завершить аренду, но убедиться, что другой клиент не может получить новую аренду до истечения текущего периода аренды.
function breakLease(breakPeriod: number, options?: LeaseOperationOptions)Параметры
- breakPeriod
-
number
Период перерыва
- options
- LeaseOperationOptions
Необязательные параметры для настройки операций управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды перерыва.
changeLease(string, LeaseOperationOptions)
Изменение идентификатора аренды.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)Параметры
- proposedLeaseId
-
string
предлагаемый новый идентификатор аренды.
- options
- LeaseOperationOptions
параметр настройки операций управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды изменений.
releaseLease(LeaseOperationOptions)
Чтобы освободить аренду, если он больше не нужен, чтобы другой клиент мог немедленно получить аренду для контейнера или большого двоичного объекта.
function releaseLease(options?: LeaseOperationOptions)Параметры
- options
- LeaseOperationOptions
параметр настройки операций управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды выпуска.
renewLease(LeaseOperationOptions)
Продление аренды.
function renewLease(options?: LeaseOperationOptions)Параметры
- options
- LeaseOperationOptions
Необязательный параметр для настройки операций управления арендой.
Возвращаемое значение
Promise<Lease>
Ответные данные для возобновления аренды.
