你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
BlobLeaseClient class
管理 ContainerClient 或 BlobClient 的租约的客户端。
构造函数
| Blob |
创建 BlobLeaseClient 的实例。 |
属性
| lease |
获取租约 ID。 |
| url | 获取 URL。 |
方法
构造函数详细信息
BlobLeaseClient(BlobClient | ContainerClient, string)
创建 BlobLeaseClient 的实例。
new BlobLeaseClient(client: BlobClient | ContainerClient, leaseId?: string)参数
- client
发出租用操作请求的客户端。
- leaseId
-
string
初始建议租约 ID。
属性详细信息
leaseId
获取租约 ID。
string leaseId属性值
string
url
获取 URL。
string url属性值
string
方法详细信息
acquireLease(number, LeaseOperationOptions)
在容器上建立和管理用于删除操作的锁，或在 Blob 上建立和管理用于写入和删除操作的锁。 锁的持续时间可以是 15 到 60 秒，也可以是无限期。
查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container 和查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function acquireLease(duration: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>参数
- duration
-
number
必须介于 15 到 60 秒之间，或无限 (-1)
- options
- LeaseOperationOptions
用于配置租用管理操作的选项。
返回
Promise<LeaseOperationResponse>
获取租用操作的响应数据。
breakLease(number, LeaseOperationOptions)
若要结束租约，但请确保其他客户端在当前租约期到期之前无法获取新租约。
查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container 和查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>参数
- breakPeriod
-
number
中断期
- options
- LeaseOperationOptions
用于配置租用管理操作的可选选项。
返回
Promise<LeaseOperationResponse>
中断租用操作的响应数据。
changeLease(string, LeaseOperationOptions)
更改租约的 ID。
查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container 和查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>参数
- proposedLeaseId
-
string
建议的新租约 ID。
- options
- LeaseOperationOptions
用于配置租用管理操作的选项。
返回
Promise<LeaseOperationResponse>
更改租约操作的响应数据。
releaseLease(LeaseOperationOptions)
如果不再需要租约，则释放租约，以便另一个客户端可以立即获取针对容器或 Blob 的租约。
查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container 和查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>参数
- options
- LeaseOperationOptions
用于配置租用管理操作的选项。
返回
Promise<LeaseOperationResponse>
发布租用操作的响应数据。
renewLease(LeaseOperationOptions)
续订租约。
查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container 和查看 https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
function renewLease(options?: LeaseOperationOptions): Promise<Lease>参数
- options
- LeaseOperationOptions
用于配置租用管理操作的可选选项。
返回
Promise<Lease>
续订租约操作的响应数据。