BlobLeaseClient class

  • Ссылка
Пакет:
@azure/storage-blob

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

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

BlobLeaseClient(BlobClient | ContainerClient, string)

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

Свойства

leaseId

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

Возвращает URL-адрес.

Методы

acquireLease(number, LeaseOperationOptions)

Устанавливает блокировку контейнера для операций удаления или большого двоичного объекта для операций записи и удаления и управляет ею. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
breakLease(number, LeaseOperationOptions)

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

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
changeLease(string, LeaseOperationOptions)

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

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
releaseLease(LeaseOperationOptions)

Чтобы освободить аренду, если она больше не нужна, чтобы другой клиент мог немедленно получить аренду контейнера или большого двоичного объекта.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
renewLease(LeaseOperationOptions)

Продление аренды.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

BlobLeaseClient(BlobClient | ContainerClient, string)

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

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

Параметры

client

BlobClient | ContainerClient

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

leaseId

string

Первоначальный предлагаемый идентификатор аренды.

Сведения о свойстве

leaseId

Возвращает идентификатор аренды.

string leaseId

Значение свойства

string

url

Возвращает URL-адрес.

string url

Значение свойства

string

Сведения о методе

acquireLease(number, LeaseOperationOptions)

Устанавливает блокировку контейнера для операций удаления или большого двоичного объекта для операций записи и удаления и управляет ею. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

function acquireLease(duration: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Параметры

duration

number

Значение должно быть от 15 до 60 секунд или бесконечным (–1)

options
LeaseOperationOptions

параметр для настройки операций управления арендой.

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

Promise<LeaseOperationResponse>

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

breakLease(number, LeaseOperationOptions)

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

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

function breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Параметры

breakPeriod

number

Период перерыва

options
LeaseOperationOptions

Необязательные параметры для настройки операций управления арендой.

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

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

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

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Параметры

proposedLeaseId

string

предлагаемый новый идентификатор аренды.

options
LeaseOperationOptions

параметр для настройки операций управления арендой.

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

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

Чтобы освободить аренду, если она больше не нужна, чтобы другой клиент мог немедленно получить аренду контейнера или большого двоичного объекта.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Параметры

options
LeaseOperationOptions

параметр для настройки операций управления арендой.

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

Promise<LeaseOperationResponse>

Данные ответа для операции аренды выпуска.

renewLease(LeaseOperationOptions)

Продление аренды.

Просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container и просмотр https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

function renewLease(options?: LeaseOperationOptions): Promise<Lease>

Параметры

options
LeaseOperationOptions

Необязательный параметр для настройки операций управления арендой.

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

Promise<Lease>

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