FabricClient.TestManagementClient.StartChaosAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

StartChaosAsync(ChaosParameters)	This API will start Chaos with the supplied parameter values.
StartChaosAsync(ChaosParameters, TimeSpan, CancellationToken)	This API will start Chaos with the supplied parameter values.

StartChaosAsync(ChaosParameters)

This API will start Chaos with the supplied parameter values.

public System.Threading.Tasks.Task StartChaosAsync (System.Fabric.Chaos.DataStructures.ChaosParameters chaosParameters);

member this.StartChaosAsync : System.Fabric.Chaos.DataStructures.ChaosParameters -> System.Threading.Tasks.Task

Public Function StartChaosAsync (chaosParameters As ChaosParameters) As Task

Parameters

chaosParameters

ChaosParameters

ChaosParameters contains various parameters for controlling Chaos; e.g., time to run, maximum number of concurrent fautls, etc.

Returns

Task

A task.

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

FabricChaosAlreadyRunningException

This exception is thrown when StartChaos API is invoked while Chaos is already running in the cluster.

StartChaosAsync(ChaosParameters, TimeSpan, CancellationToken)

This API will start Chaos with the supplied parameter values.

public System.Threading.Tasks.Task StartChaosAsync (System.Fabric.Chaos.DataStructures.ChaosParameters chaosParameters, TimeSpan operationTimeout, System.Threading.CancellationToken cancellationToken);

member this.StartChaosAsync : System.Fabric.Chaos.DataStructures.ChaosParameters * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function StartChaosAsync (chaosParameters As ChaosParameters, operationTimeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

chaosParameters

ChaosParameters

Contains various parameters for controlling Chaos; e.g., time to run, maximum number of concurrent faults, etc.

operationTimeout

TimeSpan

The overall timeout for the operation.

cancellationToken

CancellationToken

Cancellation token.

Returns

Task

A description of the state of Chaos.

Exceptions

TimeoutException

Action took more than its allocated time.

ArgumentNullException

Any of the required arguments are null.

FabricChaosAlreadyRunningException

This exception is thrown when StartChaos API is invoked while Chaos is already running in the cluster.

Remarks

The FaultAnalysisService must be enabled to use this API.