ShareLeaseClient class
Клиент, который управляет арендой для ShareFileClient или ShareClient.
См. https://learn.microsoft.com/rest/api/storageservices/lease-file и см. https://learn.microsoft.com/rest/api/storageservices/lease-share
Конструкторы
| Share |
Создает экземпляр ShareLeaseClient. |
Методы
| acquire |
Устанавливает и управляет блокировкой файлов, общего доступа или моментального снимка общего ресурса для операций записи и удаления. |
| break |
Чтобы принудительно завершить аренду. |
| change |
Изменение идентификатора существующей аренды. |
| release |
Чтобы освободить аренду, если он больше не нужен, чтобы другой клиент мог немедленно получить аренду. |
| renew |
Продление аренды. Доступно только для аренды моментального снимка общего ресурса или общего ресурса. Обратите внимание, что аренда может быть продлена даже в том случае, если срок его действия истек, пока общая доля еще не была арендована после истечения срока действия этой аренды. При продлении аренды время аренды сбрасывается. |
Сведения о конструкторе
ShareLeaseClient(ShareClient | ShareFileClient, string)
Создает экземпляр ShareLeaseClient.
new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)Параметры
- client
Клиент, выполняя запросы на аренду.
- leaseId
-
string
Первоначальный предлагаемый идентификатор аренды.
Сведения о свойстве
leaseId
Возвращает идентификатор аренды.
string leaseIdЗначение свойства
string
url
Возвращает URL-адрес.
string urlЗначение свойства
string
Сведения о методе
acquireLease(number, LeaseOperationOptions)
Устанавливает и управляет блокировкой файлов, общего доступа или моментального снимка общего ресурса для операций записи и удаления.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Параметры
- duration
-
number
Указывает длительность аренды в секундах. Для файла единственным допустимым значением является -1 для аренды, которая никогда не истекает. Для общего доступа необходимо -1 или от 15 до 60.
- options
- LeaseOperationOptions
Параметры операции управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для получения операции аренды.
breakLease(LeaseOperationOptions)
Чтобы принудительно завершить аренду.
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Параметры
- options
- LeaseOperationOptions
Параметры операции управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды перерыва.
changeLease(string, LeaseOperationOptions)
Изменение идентификатора существующей аренды.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Параметры
- proposedLeaseId
-
string
предлагаемый новый идентификатор аренды.
- options
- LeaseOperationOptions
Параметры операции управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды изменений.
releaseLease(LeaseOperationOptions)
Чтобы освободить аренду, если он больше не нужен, чтобы другой клиент мог немедленно получить аренду.
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Параметры
- options
- LeaseOperationOptions
Параметры операции управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для операции аренды выпуска.
renewLease(LeaseOperationOptions)
Продление аренды. Доступно только для аренды моментального снимка общего ресурса или общего ресурса. Обратите внимание, что аренда может быть продлена даже в том случае, если срок его действия истек, пока общая доля еще не была арендована после истечения срока действия этой аренды. При продлении аренды время аренды сбрасывается.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Параметры
- options
- LeaseOperationOptions
Параметры операции управления арендой.
Возвращаемое значение
Promise<LeaseOperationResponse>
Ответные данные для возобновления аренды.