Experiments interface

Package:

@azure/arm-chaos

Interface representing a Experiments.

Methods

beginCancel(string, string, ExperimentsCancelOptionalParams)	Cancel a running Experiment resource.
beginCancelAndWait(string, string, ExperimentsCancelOptionalParams)	Cancel a running Experiment resource.
beginCreateOrUpdate(string, string, Experiment, ExperimentsCreateOrUpdateOptionalParams)	Create or update a Experiment resource.
beginCreateOrUpdateAndWait(string, string, Experiment, ExperimentsCreateOrUpdateOptionalParams)	Create or update a Experiment resource.
beginDelete(string, string, ExperimentsDeleteOptionalParams)	Delete a Experiment resource.
beginDeleteAndWait(string, string, ExperimentsDeleteOptionalParams)	Delete a Experiment resource.
beginStart(string, string, ExperimentsStartOptionalParams)	Start a Experiment resource.
beginStartAndWait(string, string, ExperimentsStartOptionalParams)	Start a Experiment resource.
beginUpdate(string, string, ExperimentUpdate, ExperimentsUpdateOptionalParams)	The operation to update an experiment.
beginUpdateAndWait(string, string, ExperimentUpdate, ExperimentsUpdateOptionalParams)	The operation to update an experiment.
executionDetails(string, string, string, ExperimentsExecutionDetailsOptionalParams)	Execution details of an experiment resource.
get(string, string, ExperimentsGetOptionalParams)	Get a Experiment resource.
getExecution(string, string, string, ExperimentsGetExecutionOptionalParams)	Get an execution of an Experiment resource.
list(string, ExperimentsListOptionalParams)	Get a list of Experiment resources in a resource group.
listAll(ExperimentsListAllOptionalParams)	Get a list of Experiment resources in a subscription.
listAllExecutions(string, string, ExperimentsListAllExecutionsOptionalParams)	Get a list of executions of an Experiment resource.

Method Details

beginCancel(string, string, ExperimentsCancelOptionalParams)

Cancel a running Experiment resource.

function beginCancel(resourceGroupName: string, experimentName: string, options?: ExperimentsCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsCancelOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginCancelAndWait(string, string, ExperimentsCancelOptionalParams)

Cancel a running Experiment resource.

function beginCancelAndWait(resourceGroupName: string, experimentName: string, options?: ExperimentsCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsCancelOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, Experiment, ExperimentsCreateOrUpdateOptionalParams)

Create or update a Experiment resource.

function beginCreateOrUpdate(resourceGroupName: string, experimentName: string, experiment: Experiment, options?: ExperimentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Experiment>, Experiment>>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

experiment

Experiment

Experiment resource to be created or updated.

options

ExperimentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Experiment>, Experiment>>

beginCreateOrUpdateAndWait(string, string, Experiment, ExperimentsCreateOrUpdateOptionalParams)

Create or update a Experiment resource.

function beginCreateOrUpdateAndWait(resourceGroupName: string, experimentName: string, experiment: Experiment, options?: ExperimentsCreateOrUpdateOptionalParams): Promise<Experiment>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

experiment

Experiment

Experiment resource to be created or updated.

options

ExperimentsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Experiment>

beginDelete(string, string, ExperimentsDeleteOptionalParams)

Delete a Experiment resource.

function beginDelete(resourceGroupName: string, experimentName: string, options?: ExperimentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ExperimentsDeleteOptionalParams)

Delete a Experiment resource.

function beginDeleteAndWait(resourceGroupName: string, experimentName: string, options?: ExperimentsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ExperimentsStartOptionalParams)

Start a Experiment resource.

function beginStart(resourceGroupName: string, experimentName: string, options?: ExperimentsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ExperimentsStartOptionalParams)

Start a Experiment resource.

function beginStartAndWait(resourceGroupName: string, experimentName: string, options?: ExperimentsStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsStartOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ExperimentUpdate, ExperimentsUpdateOptionalParams)

The operation to update an experiment.

function beginUpdate(resourceGroupName: string, experimentName: string, experiment: ExperimentUpdate, options?: ExperimentsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Experiment>, Experiment>>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

experiment

ExperimentUpdate

Parameters supplied to the Update experiment operation.

options

ExperimentsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Experiment>, Experiment>>

beginUpdateAndWait(string, string, ExperimentUpdate, ExperimentsUpdateOptionalParams)

The operation to update an experiment.

function beginUpdateAndWait(resourceGroupName: string, experimentName: string, experiment: ExperimentUpdate, options?: ExperimentsUpdateOptionalParams): Promise<Experiment>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

experiment

ExperimentUpdate

Parameters supplied to the Update experiment operation.

options

ExperimentsUpdateOptionalParams

The options parameters.

Returns

Promise<Experiment>

executionDetails(string, string, string, ExperimentsExecutionDetailsOptionalParams)

Execution details of an experiment resource.

function executionDetails(resourceGroupName: string, experimentName: string, executionId: string, options?: ExperimentsExecutionDetailsOptionalParams): Promise<ExperimentExecutionDetails>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

executionId

string

GUID that represents a Experiment execution detail.

options

ExperimentsExecutionDetailsOptionalParams

The options parameters.

Returns

Promise<ExperimentExecutionDetails>

get(string, string, ExperimentsGetOptionalParams)

Get a Experiment resource.

function get(resourceGroupName: string, experimentName: string, options?: ExperimentsGetOptionalParams): Promise<Experiment>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsGetOptionalParams

The options parameters.

Returns

Promise<Experiment>

getExecution(string, string, string, ExperimentsGetExecutionOptionalParams)

Get an execution of an Experiment resource.

function getExecution(resourceGroupName: string, experimentName: string, executionId: string, options?: ExperimentsGetExecutionOptionalParams): Promise<ExperimentExecution>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

executionId

string

GUID that represents a Experiment execution detail.

options

ExperimentsGetExecutionOptionalParams

The options parameters.

Returns

Promise<ExperimentExecution>

list(string, ExperimentsListOptionalParams)

Get a list of Experiment resources in a resource group.

function list(resourceGroupName: string, options?: ExperimentsListOptionalParams): PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

options

ExperimentsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>

listAll(ExperimentsListAllOptionalParams)

Get a list of Experiment resources in a subscription.

function listAll(options?: ExperimentsListAllOptionalParams): PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>

Parameters

options

ExperimentsListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Experiment, Experiment[], PageSettings>

listAllExecutions(string, string, ExperimentsListAllExecutionsOptionalParams)

Get a list of executions of an Experiment resource.

function listAllExecutions(resourceGroupName: string, experimentName: string, options?: ExperimentsListAllExecutionsOptionalParams): PagedAsyncIterableIterator<ExperimentExecution, ExperimentExecution[], PageSettings>

Parameters

resourceGroupName

string

String that represents an Azure resource group.

experimentName

string

String that represents a Experiment resource name.

options

ExperimentsListAllExecutionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ExperimentExecution, ExperimentExecution[], PageSettings>