BlobLeaseClient class

Пакет:

@azure/storage-blob

Клиент, который управляет арендой для <xref:ContainerClient> или <xref:BlobClient>.

Конструкторы

BlobLeaseClient(ContainerClient | BlobClient, string)

Создает экземпляр BlobLeaseClient.

Свойства

leaseId	Возвращает идентификатор аренды.
url	Возвращает URL-адрес.

Методы

acquireLease(number, LeaseOperationOptions)	Устанавливает блокировку контейнера для операций удаления или большого двоичного объекта для операций записи и удаления и управляет ими. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.
breakLease(number, LeaseOperationOptions)	Чтобы завершить аренду, но убедитесь, что другой клиент не может получить новую аренду до истечения текущего периода аренды.
changeLease(string, LeaseOperationOptions)	Изменение идентификатора аренды.
releaseLease(LeaseOperationOptions)	Чтобы освободить аренду, если она больше не нужна, чтобы другой клиент мог немедленно получить аренду контейнера или большого двоичного объекта.
renewLease(LeaseOperationOptions)	Продление аренды.

Сведения о конструкторе

BlobLeaseClient(ContainerClient | BlobClient, string)

Создает экземпляр BlobLeaseClient.

new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId?: string)

Параметры

client

ContainerClient | BlobClient

Клиент для выполнения запроса операции аренды.

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>

Данные ответа для операции возобновления аренды.