ShareLeaseClient class
コンストラクター
| Share |
ShareLeaseClient のインスタンスを作成します。 |
プロパティ
| lease |
リース ID を取得します。 |
| url | URL を取得します。 |
メソッド
| acquire |
書き込み操作と削除操作のために、ファイル、共有、または共有スナップショットのロックを確立して管理します。 |
| break |
リースを強制的に終了します。 |
| change |
既存のリースの ID を変更する。 |
| release |
別のクライアントがすぐにリースを取得できるように、リースが不要になった場合にリースを解放する。 |
| renew |
リースを更新します。 共有スナップショットまたは共有スナップショットのリースでのみ使用できます。 リースの有効期限が切れてから共有が再びリースされていない限り、リースが期限切れであっても、リースが更新される可能性があることに注意してください。 リースを更新すると、リース期間の時間がリセットされます。 |
コンストラクターの詳細
ShareLeaseClient(ShareFileClient, string)
ShareLeaseClient のインスタンスを作成します。
new ShareLeaseClient(client: ShareFileClient, leaseId?: string)パラメーター
- client
- ShareFileClient
リース操作要求を行うクライアント。
- leaseId
-
string
最初に提案されたリース ID。
プロパティの詳細
leaseId
リース ID を取得します。
string leaseIdプロパティ値
string
url
URL を取得します。
string urlプロパティ値
string
メソッドの詳細
acquireLease(number, LeaseOperationOptions)
書き込み操作と削除操作のために、ファイル、共有、または共有スナップショットのロックを確立して管理します。
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>パラメーター
- duration
-
number
リース期間を秒単位で指定します。 file の場合、有効期限が切れないリースの場合、許容される値は -1 のみです。 共有の場合は、-1 または 15 から 60 の間にする必要があります。
- options
- LeaseOperationOptions
リース管理操作のオプション。
戻り値
Promise<LeaseOperationResponse>
取得リース操作の応答データ。
breakLease(LeaseOperationOptions)
リースを強制的に終了します。
function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>パラメーター
- options
- LeaseOperationOptions
リース管理操作のオプション。
戻り値
Promise<LeaseOperationResponse>
ブレーク リース操作の応答データ。
changeLease(string, LeaseOperationOptions)
既存のリースの ID を変更する。
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>パラメーター
- proposedLeaseId
-
string
提案された新しいリース ID。
- options
- LeaseOperationOptions
リース管理操作のオプション。
戻り値
Promise<LeaseOperationResponse>
変更リース操作の応答データ。
releaseLease(LeaseOperationOptions)
別のクライアントがすぐにリースを取得できるように、リースが不要になった場合にリースを解放する。
function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>パラメーター
- options
- LeaseOperationOptions
リース管理操作のオプション。
戻り値
Promise<LeaseOperationResponse>
リリース リース操作の応答データ。
renewLease(LeaseOperationOptions)
リースを更新します。 共有スナップショットまたは共有スナップショットのリースでのみ使用できます。 リースの有効期限が切れてから共有が再びリースされていない限り、リースが期限切れであっても、リースが更新される可能性があることに注意してください。 リースを更新すると、リース期間の時間がリセットされます。
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>パラメーター
- options
- LeaseOperationOptions
リース管理操作のオプション。
戻り値
Promise<LeaseOperationResponse>
リース操作の更新に関する応答データ。