BlobLeaseClient class

または のリースを <xref:ContainerClient> 管理する <xref:BlobClient>クライアント。

コンストラクター

BlobLeaseClient(ContainerClient | BlobClient, string)

BlobLeaseClient のインスタンスを作成します。

プロパティ

leaseId

リース ID を取得します。

url

URL を取得します。

メソッド

acquireLease(number, LeaseOperationOptions)

削除操作用のコンテナー、または書き込み操作と削除操作用の BLOB のロックを確立して管理します。 ロック期間は、15 ~ 60 秒にすることも、無限にすることもできます。

breakLease(number, LeaseOperationOptions)

リースを終了し、現在のリース期間が切れるまで別のクライアントが新しいリースを取得できないようにするため。

changeLease(string, LeaseOperationOptions)

リースの ID を変更します。

releaseLease(LeaseOperationOptions)

別のクライアントがコンテナーまたは BLOB に対するリースをすぐに取得できるように、リースが不要になった場合にリースを解放する。

renewLease(LeaseOperationOptions)

リースを更新します。

コンストラクターの詳細

BlobLeaseClient(ContainerClient | BlobClient, string)

BlobLeaseClient のインスタンスを作成します。

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

パラメーター

client

ContainerClient | BlobClient

リース操作要求を行うクライアント。

leaseId

string

最初に提案されたリース ID。

プロパティの詳細

leaseId

リース ID を取得します。

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

リース管理操作を構成するオプション。

戻り値

取得リース操作の応答データ。

breakLease(number, LeaseOperationOptions)

リースを終了し、現在のリース期間が切れるまで別のクライアントが新しいリースを取得できないようにするため。

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

パラメーター

breakPeriod

number

中断期間

options
LeaseOperationOptions

リース管理操作を構成するためのオプション。

戻り値

ブレーク リース操作の応答データ。

changeLease(string, LeaseOperationOptions)

リースの ID を変更します。

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

パラメーター

proposedLeaseId

string

提案された新しいリース ID。

options
LeaseOperationOptions

リース管理操作を構成するオプション。

戻り値

変更リース操作の応答データ。

releaseLease(LeaseOperationOptions)

別のクライアントがコンテナーまたは BLOB に対するリースをすぐに取得できるように、リースが不要になった場合にリースを解放する。

function releaseLease(options?: LeaseOperationOptions)

パラメーター

options
LeaseOperationOptions

リース管理操作を構成するオプション。

戻り値

リリース リース操作の応答データ。

renewLease(LeaseOperationOptions)

リースを更新します。

function renewLease(options?: LeaseOperationOptions)

パラメーター

options
LeaseOperationOptions

リース管理操作を構成するためのオプション。

戻り値

Promise<Lease>

リース操作の更新に関する応答データ。