Bagikan melalui

BlobLeaseClient class

  • Referensi
Paket:
@azure/storage-blob

Klien yang mengelola sewa untuk ContainerClient atau BlobClient.

Konstruktor

BlobLeaseClient(BlobClient | ContainerClient, 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.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
breakLease(number, LeaseOperationOptions)

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

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
changeLease(string, LeaseOperationOptions)

Untuk mengubah ID sewa.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
releaseLease(LeaseOperationOptions)

Untuk membebaskan sewa jika tidak lagi diperlukan sehingga klien lain dapat segera memperoleh sewa terhadap kontainer atau blob.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
renewLease(LeaseOperationOptions)

Untuk memperpanjang sewa.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

Detail Konstruktor

BlobLeaseClient(BlobClient | ContainerClient, string)

Membuat instans BlobLeaseClient.

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

Parameter

client

BlobClient | ContainerClient

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.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

duration

number

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

options
LeaseOperationOptions

opsi 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.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

breakPeriod

number

Periode istirahat

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.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

proposedLeaseId

string

id sewa baru yang diusulkan.

options
LeaseOperationOptions

opsi 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.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

options
LeaseOperationOptions

opsi untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<LeaseOperationResponse>

Data respons untuk operasi sewa rilis.

renewLease(LeaseOperationOptions)

Untuk memperpanjang sewa.

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container dan Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

options
LeaseOperationOptions

Opsi opsional untuk mengonfigurasi operasi manajemen sewa.

Mengembalikan

Promise<Lease>

Data respons untuk memperpanjang operasi sewa.