BlobLeaseClient class

Paket:

@azure/storage-blob

Klien yang mengelola sewa untuk <xref:ContainerClient> atau <xref:BlobClient>.

Konstruktor

BlobLeaseClient(ContainerClient | BlobClient, string)

Membuat instans BlobLeaseClient.

Properti

leaseId	Mendapatkan ID sewa.
url	Mendapatkan url.

Metode

acquireLease(number, LeaseOperationOptions)	Menetapkan dan mengelola kunci pada kontainer untuk operasi penghapusan, atau pada blob untuk operasi tulis dan hapus. Durasi penguncian bisa 15 hingga 60 detik, atau bisa tak terbatas.
breakLease(number, LeaseOperationOptions)	Untuk mengakhiri sewa tetapi pastikan bahwa klien lain tidak dapat memperoleh sewa baru sampai periode sewa saat ini kedaluwarsa.
changeLease(string, LeaseOperationOptions)	Untuk mengubah ID sewa.
releaseLease(LeaseOperationOptions)	Untuk membebaskan sewa jika tidak lagi diperlukan sehingga klien lain dapat segera memperoleh sewa terhadap kontainer atau blob.
renewLease(LeaseOperationOptions)	Untuk memperbarui sewa.

Detail Konstruktor

BlobLeaseClient(ContainerClient | BlobClient, string)

Membuat instans BlobLeaseClient.

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

Parameter

client

ContainerClient | BlobClient

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 kontainer untuk operasi penghapusan, atau pada blob untuk operasi tulis dan hapus. Durasi penguncian bisa 15 hingga 60 detik, atau bisa tak terbatas.

function acquireLease(duration: number, options?: LeaseOperationOptions)

Parameter

duration

number

Harus antara 15 hingga 60 detik, atau tak terbatas (-1)

options

LeaseOperationOptions

untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk memperoleh operasi sewa.

breakLease(number, LeaseOperationOptions)

Untuk mengakhiri sewa tetapi pastikan bahwa klien lain tidak dapat memperoleh sewa baru sampai periode sewa saat ini kedaluwarsa.

function breakLease(breakPeriod: number, options?: LeaseOperationOptions)

Parameter

breakPeriod

number

Periode jeda

options

LeaseOperationOptions

Opsi opsional untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa pemutusan.

changeLease(string, LeaseOperationOptions)

Untuk mengubah ID sewa.

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)

Parameter

proposedLeaseId

string

id sewa baru yang diusulkan.

options

LeaseOperationOptions

untuk mengonfigurasi 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 terhadap kontainer atau blob.

function releaseLease(options?: LeaseOperationOptions)

Parameter

options

LeaseOperationOptions

untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa rilis.

renewLease(LeaseOperationOptions)

Untuk memperbarui sewa.

function renewLease(options?: LeaseOperationOptions)

Parameter

options

LeaseOperationOptions

Opsi opsional untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<Lease>

Data respons untuk operasi sewa perpanjangan.