DataLakeLeaseClient.BreakAsync メソッド

定義

名前空間:

Azure.Storage.Files.DataLake

アセンブリ:

Azure.Storage.Files.DataLake.dll

パッケージ:

Azure.Storage.Files.DataLake v12.18.0

ソース:

DataLakeLeaseClient.cs

この操作は BreakAsync(Nullable<TimeSpan>, RequestConditions, CancellationToken) 、パスまたはファイル システムの以前に取得したリース (存在する場合) を中断します。

いったん中断したリースは更新できません。 承認済みの要求によってリースを中断できます。要求で一致するリース ID を指定する必要はありません。 リースが切断されると、リースの中断breakPeriodが許可され、その間、パスまたはファイル システムで と を除いてBreakAsync(Nullable<TimeSpan>, RequestConditions, CancellationToken)ReleaseAsync(RequestConditions, CancellationToken)リース操作を実行することはできません。 リースが正常に中断されると、応答で新しいリースを取得できるようになるまでの時間 (秒単位) が示されます。

中断されたリースを解放することもできます。 クライアントは、リリースされたパスまたはファイル システム リースをすぐに取得できます。

詳細については、「 リース コンテナー。

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>> BreakAsync (TimeSpan? breakPeriod = default, Azure.RequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BreakAsync : Nullable<TimeSpan> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>>
override this.BreakAsync : Nullable<TimeSpan> * Azure.RequestConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.DataLakeLease>>

Public Overridable Function BreakAsync (Optional breakPeriod As Nullable(Of TimeSpan) = Nothing, Optional conditions As RequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DataLakeLease))

パラメーター

breakPeriod

Nullable<TimeSpan>

0 から 60 の間でリースが中断されるまでの期間を指定します (秒)。 この中断期間は、リースの残り時間よりも短い場合にのみ使用されます。 長い場合は、リースの残り時間が使用されます。 中断期間が終了するまで新しいリースは使用できなくなりますが、中断期間よりも長い期間リースが保持される場合があります。 この値が指定されていない場合、残存リース期間が経過すると固定期間のリースが中断され、無限リースが直ちに中断されます。

conditions

RequestConditions

リースの取得に関する条件を追加する場合は省略可能 RequestConditions です。

cancellationToken

CancellationToken

操作を取り消す必要があることを示す通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Task<Response<DataLakeLease>>

Response<T>壊れたリースを記述する 。

注釈

RequestFailedExceptionエラーが発生すると、 がスローされます。