BlobLeaseClient class
管理 或 租用 <xref:ContainerClient> 的 <xref:BlobClient> 用戶端。
建構函式
| Blob |
建立 BlobLeaseClient 的實例。 |
屬性
| lease |
取得租用識別碼。 |
| url | 取得 URL。 |
方法
| acquire |
建立和管理容器的鎖定以進行刪除作業，或在 Blob 上建立和管理寫入和刪除作業的鎖定。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。 |
| break |
若要結束租用，但請確定另一個用戶端在目前的租用期間到期之前，無法取得新的租用。 |
| change |
若要變更租用的識別碼。 |
| release |
如果不再需要租用，則釋放租用，讓另一個用戶端可以立即取得容器或 Blob 的租用。 |
| renew |
若要更新租用。 |
建構函式詳細資料
BlobLeaseClient(ContainerClient | BlobClient, string)
建立 BlobLeaseClient 的實例。
new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId?: string)參數
- client
要發出租用作業要求的用戶端。
- leaseId
-
string
初始建議的租用識別碼。
屬性詳細資料
leaseId
取得租用識別碼。
string leaseId屬性值
string
url
取得 URL。
string url屬性值
string
方法詳細資料
acquireLease(number, LeaseOperationOptions)
建立和管理容器的鎖定以進行刪除作業，或在 Blob 上建立和管理寫入和刪除作業的鎖定。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。
function acquireLease(duration: number, options?: LeaseOperationOptions)參數
- duration
-
number
必須介於 15 到 60 秒之間，或無限 (-1)
- options
- LeaseOperationOptions
設定租用管理作業的選項。
傳回
Promise<LeaseOperationResponse>
取得租用作業的回應資料。
breakLease(number, LeaseOperationOptions)
若要結束租用，但請確定另一個用戶端在目前的租用期間到期之前，無法取得新的租用。
function breakLease(breakPeriod: number, options?: LeaseOperationOptions)參數
- breakPeriod
-
number
中斷期間
- options
- LeaseOperationOptions
設定租用管理作業的選擇性選項。
傳回
Promise<LeaseOperationResponse>
中斷租用作業的回應資料。
changeLease(string, LeaseOperationOptions)
若要變更租用的識別碼。
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)參數
- proposedLeaseId
-
string
建議的新租用識別碼。
- options
- LeaseOperationOptions
設定租用管理作業的選項。
傳回
Promise<LeaseOperationResponse>
變更租用作業的回應資料。
releaseLease(LeaseOperationOptions)
如果不再需要租用，則釋放租用，讓另一個用戶端可以立即取得容器或 Blob 的租用。
function releaseLease(options?: LeaseOperationOptions)參數
- options
- LeaseOperationOptions
設定租用管理作業的選項。
傳回
Promise<LeaseOperationResponse>
發行租用作業的回應資料。
renewLease(LeaseOperationOptions)
若要更新租用。
function renewLease(options?: LeaseOperationOptions)參數
- options
- LeaseOperationOptions
設定租用管理作業的選擇性選項。
傳回
Promise<Lease>
更新租用作業的回應資料。
