ShareLeaseClient class

Paket:

@azure/storage-file-share

ShareFileClient veya ShareClientiçin kiraları yöneten bir istemci.

bkz. https://learn.microsoft.com/rest/api/storageservices/lease-file ve Bkz. https://learn.microsoft.com/rest/api/storageservices/lease-share

Oluşturucular

ShareLeaseClient(ShareClient | ShareFileClient, string)

ShareLeaseClient örneği oluşturur.

Özellikler

leaseId	Kira kimliğini alır.
url	URL'yi alır.

Yöntemler

acquireLease(number, LeaseOperationOptions)	Yazma ve silme işlemleri için dosya, paylaşım veya paylaşım anlık görüntüsü üzerinde kilit oluşturur ve yönetir.
breakLease(LeaseOperationOptions)	Kirayı sonlandırmaya zorlamak için.
changeLease(string, LeaseOperationOptions)	Var olan bir kiranın kimliğini değiştirmek için.
releaseLease(LeaseOperationOptions)	Başka bir istemcinin hemen kira alması için artık gerekli değilse kirayı serbest bırakır.
renewLease(LeaseOperationOptions)	Kirayı yenilemek için. Yalnızca paylaşım veya paylaşım anlık görüntüsünde kiralama için kullanılabilir. Kiralamanın süresi dolsa bile, bu kiralamanın süresi dolduğundan bu yana paylaşımın yeniden kiralanmadığı sürece kiranın yenilenebileceğini unutmayın. Kiralamayı yenilediğinizde, kiralama süresi saati sıfırlanır.

Oluşturucu Ayrıntıları

ShareLeaseClient(ShareClient | ShareFileClient, string)

ShareLeaseClient örneği oluşturur.

new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)

Parametreler

client

ShareClient | ShareFileClient

Kiralama işlemi isteklerinde bulunmak için istemci.

leaseId

string

İlk önerilen kira kimliği.

Özellik Ayrıntıları

leaseId

Kira kimliğini alır.

string leaseId

Özellik Değeri

string

url

URL'yi alır.

string url

Özellik Değeri

string

Yöntem Ayrıntıları

acquireLease(number, LeaseOperationOptions)

Yazma ve silme işlemleri için dosya, paylaşım veya paylaşım anlık görüntüsü üzerinde kilit oluşturur ve yönetir.

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

Parametreler

duration

number

Kira süresini saniye cinsinden belirtir. Dosya için izin verilen tek değer, süresi hiç dolmamış bir kiralama için -1. Paylaşım için -1 veya 15 ila 60 arasında olmalıdır.

options

LeaseOperationOptions

Kiralama yönetimi işlemi için seçenekler.

Döndürülenler

Promise<LeaseOperationResponse>

Kiralama alma işlemi için yanıt verileri.

breakLease(LeaseOperationOptions)

Kirayı sonlandırmaya zorlamak için.

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

Parametreler

options

LeaseOperationOptions

Kiralama yönetimi işlemi için seçenekler.

Döndürülenler

Promise<LeaseOperationResponse>

Kirayı kesme işlemi için yanıt verileri.

changeLease(string, LeaseOperationOptions)

Var olan bir kiranın kimliğini değiştirmek için.

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

Parametreler

proposedLeaseId

string

önerilen yeni kira kimliği.

options

LeaseOperationOptions

Kiralama yönetimi işlemi için seçenekler.

Döndürülenler

Promise<LeaseOperationResponse>

Değişiklik kiralama işlemi için yanıt verileri.

releaseLease(LeaseOperationOptions)

Başka bir istemcinin hemen kira alması için artık gerekli değilse kirayı serbest bırakır.

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

Parametreler

options

LeaseOperationOptions

Kiralama yönetimi işlemi için seçenekler.

Döndürülenler

Promise<LeaseOperationResponse>

Serbest bırakma kiralama işlemi için yanıt verileri.

renewLease(LeaseOperationOptions)

Kirayı yenilemek için. Yalnızca paylaşım veya paylaşım anlık görüntüsünde kiralama için kullanılabilir. Kiralamanın süresi dolsa bile, bu kiralamanın süresi dolduğundan bu yana paylaşımın yeniden kiralanmadığı sürece kiranın yenilenebileceğini unutmayın. Kiralamayı yenilediğinizde, kiralama süresi saati sıfırlanır.

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

Parametreler

options

LeaseOperationOptions

Kiralama yönetimi işlemi için seçenekler.

Döndürülenler

Promise<LeaseOperationResponse>

Kiralamayı yenileme işlemi için yanıt verileri.