FabricClient.TestManagementClient.CancelTestCommandAsync メソッド

定義

名前空間:

System.Fabric

アセンブリ:

System.Fabric.dll

パッケージ:

Microsoft.ServiceFabric v9.1.1833

オーバーロード

CancelTestCommandAsync(Guid, Boolean)	テスト コマンドを取り消します。
CancelTestCommandAsync(Guid, Boolean, CancellationToken)	テスト コマンドを取り消します。
CancelTestCommandAsync(Guid, Boolean, TimeSpan)	テスト コマンドを取り消します。
CancelTestCommandAsync(Guid, Boolean, TimeSpan, CancellationToken)	テスト コマンドを取り消します。

CancelTestCommandAsync(Guid, Boolean)

テスト コマンドを取り消します。

public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force);

member this.CancelTestCommandAsync : Guid * bool -> System.Threading.Tasks.Task

Public Function CancelTestCommandAsync (operationId As Guid, force As Boolean) As Task

パラメーター

operationId

Guid

取り消すテスト コマンドの operationId を示します。

force

Boolean

テスト コマンドを実行して変更された内部システム状態を正常にロールバックしてクリーンするかどうかを示します。 「解説」を参照してください。

戻り値

Task

タスク。

注釈

force が false の場合、指定されたテスト コマンドは正常に停止され、クリーンアップされます。 force が true の場合、このコマンドは中止され、一部の内部状態は取り残される可能性があります。 force を true として指定する際は、注意してください。 Force が true に設定された CancelTestCommandAsync() の呼び出しは、最初に force が false に設定された同じテスト コマンドで CancelTestCommandAsync() が呼び出されるまで、またはテスト コマンドに TestCommandProgressState.RollingBack の TestCommandProgressState が既に設定されていない限り、許可されません。 説明: TestCommandProgressState.RollingBack は、コマンドの実行によってシステムが内部システム状態をクリーンアップすることを意味します。 テスト コマンドがデータ損失の原因だった場合、データは復元されません。 たとえば、StartPartitionDataLossAsync() を呼び出し、CancelTestCommandAsync() を呼び出すと、システムはコマンドの実行から内部状態のみをクリーンします。 データ損失を引き起こすほどコマンドが進行した場合、対象パーティションのデータは復元されません。

重要な注意: この API は force==true を指定して呼び出した場合、内部状態は取り残される可能性があります。 残されている可能性のある状態を削除するには、CleanTestStateAsync() を呼び出す必要があります。

この API を使用するには、FaultAnalysisService を有効にする必要があります。

CancelTestCommandAsync(Guid, Boolean, CancellationToken)

テスト コマンドを取り消します。

public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, System.Threading.CancellationToken cancellationToken);

member this.CancelTestCommandAsync : Guid * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CancelTestCommandAsync (operationId As Guid, force As Boolean, cancellationToken As CancellationToken) As Task

パラメーター

operationId

Guid

取り消すテスト コマンドの operationId を示します。

force

Boolean

テスト コマンドを実行して変更された内部システム状態を正常にロールバックしてクリーンするかどうかを示します。 「解説」を参照してください。

cancellationToken

CancellationToken

このトークンは、完了する前にこの操作を中止するように通知できます

戻り値

Task

タスク。

注釈

force が false の場合、指定されたテスト コマンドは正常に停止され、クリーンアップされます。 force が true の場合、このコマンドは中止され、一部の内部状態は取り残される可能性があります。 force を true として指定する際は、注意してください。 Force が true に設定された CancelTestCommandAsync() の呼び出しは、最初に force が false に設定された同じテスト コマンドで CancelTestCommandAsync() が呼び出されるまで、またはテスト コマンドに TestCommandProgressState.RollingBack の TestCommandProgressState が既に設定されていない限り、許可されません。 説明: TestCommandProgressState.RollingBack は、コマンドの実行によってシステムが内部システム状態をクリーンアップすることを意味します。 テスト コマンドがデータ損失の原因だった場合、データは復元されません。 たとえば、StartPartitionDataLossAsync() を呼び出し、CancelTestCommandAsync() を呼び出すと、システムはコマンドの実行から内部状態のみをクリーンします。 データ損失を引き起こすほどコマンドが進行した場合、対象パーティションのデータは復元されません。

重要な注意: この API は force==true を指定して呼び出した場合、内部状態は取り残される可能性があります。 残されている可能性のある状態を削除するには、CleanTestStateAsync() を呼び出す必要があります。

この API を使用するには、FaultAnalysisService を有効にする必要があります。

CancelTestCommandAsync(Guid, Boolean, TimeSpan)

テスト コマンドを取り消します。

public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, TimeSpan timeout);

member this.CancelTestCommandAsync : Guid * bool * TimeSpan -> System.Threading.Tasks.Task

Public Function CancelTestCommandAsync (operationId As Guid, force As Boolean, timeout As TimeSpan) As Task

パラメーター

operationId

Guid

取り消すテスト コマンドの operationId を示します。

force

Boolean

テスト コマンドを実行して変更された内部システム状態を正常にロールバックしてクリーンするかどうかを示します。 「解説」を参照してください。

timeout

TimeSpan

API 呼び出しに使用するタイムアウト。

戻り値

Task

タスク。

注釈

force が false の場合、指定されたテスト コマンドは正常に停止され、クリーンアップされます。 force が true の場合、このコマンドは中止され、一部の内部状態は取り残される可能性があります。 force を true として指定する際は、注意してください。 Force が true に設定された CancelTestCommandAsync() の呼び出しは、最初に force が false に設定された同じテスト コマンドで CancelTestCommandAsync() が呼び出されるまで、またはテスト コマンドに TestCommandProgressState.RollingBack の TestCommandProgressState が既に設定されていない限り、許可されません。 説明: TestCommandProgressState.RollingBack は、コマンドの実行によってシステムが内部システム状態をクリーンアップすることを意味します。 テスト コマンドがデータ損失の原因だった場合、データは復元されません。 たとえば、StartPartitionDataLossAsync() を呼び出し、CancelTestCommandAsync() を呼び出すと、システムはコマンドの実行から内部状態のみをクリーンします。 データ損失を引き起こすほどコマンドが進行した場合、対象パーティションのデータは復元されません。

重要な注意: この API は force==true を指定して呼び出した場合、内部状態は取り残される可能性があります。 残されている可能性のある状態を削除するには、CleanTestStateAsync() を呼び出す必要があります。

この API を使用するには、FaultAnalysisService を有効にする必要があります。

CancelTestCommandAsync(Guid, Boolean, TimeSpan, CancellationToken)

テスト コマンドを取り消します。

public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.CancelTestCommandAsync : Guid * bool * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CancelTestCommandAsync (operationId As Guid, force As Boolean, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

パラメーター

operationId

Guid

取り消すテスト コマンドの operationId を示します。

force

Boolean

テスト コマンドを実行して変更された内部システム状態を正常にロールバックしてクリーンするかどうかを示します。 「解説」を参照してください。

timeout

TimeSpan

API 呼び出しに使用するタイムアウト。

cancellationToken

CancellationToken

このトークンは、完了する前にこの操作を中止するように通知できます

戻り値

Task

タスク。

注釈

force が false の場合、指定されたテスト コマンドは正常に停止され、クリーンアップされます。 force が true の場合、このコマンドは中止され、一部の内部状態は取り残される可能性があります。 force を true として指定する際は、注意してください。 Force が true に設定された CancelTestCommandAsync() の呼び出しは、最初に force が false に設定された同じテスト コマンドで CancelTestCommandAsync() が呼び出されるまで、またはテスト コマンドに TestCommandProgressState.RollingBack の TestCommandProgressState が既に設定されていない限り、許可されません。 説明: TestCommandProgressState.RollingBack は、コマンドの実行によってシステムが内部システム状態をクリーンアップすることを意味します。 テスト コマンドがデータ損失の原因だった場合、データは復元されません。 たとえば、StartPartitionDataLossAsync() を呼び出し、CancelTestCommandAsync() を呼び出すと、システムはコマンドの実行から内部状態のみをクリーンします。 データ損失を引き起こすほどコマンドが進行した場合、対象パーティションのデータは復元されません。

重要な注意: この API は force==true を指定して呼び出した場合、内部状態は取り残される可能性があります。 残されている可能性のある状態を削除するには、CleanTestStateAsync() を呼び出す必要があります。

この API を使用するには、FaultAnalysisService を有効にする必要があります。