ShareLeaseClient class

Paket:

@azure/storage-file-share

Klien yang mengelola sewa untuk ShareFileClient atau ShareClient.

Lihat https://learn.microsoft.com/rest/api/storageservices/lease-file dan Lihat https://learn.microsoft.com/rest/api/storageservices/lease-share

Konstruktor

ShareLeaseClient(ShareClient | ShareFileClient, string)

Membuat instans ShareLeaseClient.

Properti

leaseId	Mendapatkan ID sewa.
url	Mendapatkan url.

Metode

acquireLease(number, LeaseOperationOptions)	Menetapkan dan mengelola kunci pada file, berbagi, atau berbagi rekam jepret untuk operasi tulis dan hapus.
breakLease(LeaseOperationOptions)	Untuk mengakhiri sewa.
changeLease(string, LeaseOperationOptions)	Untuk mengubah ID sewa yang ada.
releaseLease(LeaseOperationOptions)	Untuk membebaskan sewa jika tidak lagi diperlukan sehingga klien lain dapat segera memperoleh sewa.
renewLease(LeaseOperationOptions)	Untuk memperbarui sewa. Hanya tersedia untuk sewa berbagi atau berbagi rekam jepret. Perhatikan bahwa sewa dapat diperpanjang bahkan jika telah kedaluwarsa selama berbagi belum disewakan lagi sejak kedaluwarsa sewa tersebut. Saat Anda memperbarui sewa, jam durasi sewa diatur ulang.

Detail Konstruktor

ShareLeaseClient(ShareClient | ShareFileClient, string)

Membuat instans ShareLeaseClient.

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

Parameter

client

ShareClient | ShareFileClient

Klien untuk membuat permintaan operasi sewa.

leaseId

string

Id sewa awal yang diusulkan.

Detail Properti

leaseId

Mendapatkan ID sewa.

string leaseId

Nilai Properti

string

url

Mendapatkan url.

string url

Nilai Properti

string

Detail Metode

acquireLease(number, LeaseOperationOptions)

Menetapkan dan mengelola kunci pada file, berbagi, atau berbagi rekam jepret untuk operasi tulis dan hapus.

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

Parameter

duration

number

Menentukan durasi sewa dalam hitungan detik. Untuk file, satu-satunya nilai yang diizinkan adalah -1 untuk sewa yang tidak pernah kedaluwarsa. Untuk berbagi, harus -1 atau antara 15 hingga 60.

options

LeaseOperationOptions

Opsi untuk operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk memperoleh operasi sewa.

breakLease(LeaseOperationOptions)

Untuk mengakhiri sewa.

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

Parameter

options

LeaseOperationOptions

Opsi untuk operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa pemutusan.

changeLease(string, LeaseOperationOptions)

Untuk mengubah ID sewa yang ada.

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

Parameter

proposedLeaseId

string

id sewa baru yang diusulkan.

options

LeaseOperationOptions

Opsi untuk operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa perubahan.

releaseLease(LeaseOperationOptions)

Untuk membebaskan sewa jika tidak lagi diperlukan sehingga klien lain dapat segera memperoleh sewa.

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

Parameter

options

LeaseOperationOptions

Opsi untuk operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa rilis.

renewLease(LeaseOperationOptions)

Untuk memperbarui sewa. Hanya tersedia untuk sewa berbagi atau berbagi rekam jepret. Perhatikan bahwa sewa dapat diperpanjang bahkan jika telah kedaluwarsa selama berbagi belum disewakan lagi sejak kedaluwarsa sewa tersebut. Saat Anda memperbarui sewa, jam durasi sewa diatur ulang.

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

Parameter

options

LeaseOperationOptions

Opsi untuk operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa perpanjangan.