Experiments | @azure/arm-chaos

Interface representing a Experiments.

Hierarchy

Experiments

Implemented by

ExperimentsImpl

Index

Methods

cancel

cancel(resourceGroupName: string, experimentName: string, options?: ExperimentsCancelOptionalParams): Promise<ExperimentsCancelResponse>

- Defined in operationsInterfaces/experiments.ts:115
Cancel a running Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsCancelOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsCancelResponse>

createOrUpdate

createOrUpdate(resourceGroupName: string, experimentName: string, experiment: Experiment, options?: ExperimentsCreateOrUpdateOptionalParams): Promise<ExperimentsCreateOrUpdateResponse>

- Defined in operationsInterfaces/experiments.ts:103
Create or update a Experiment resource.

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.
- Optional options: ExperimentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/experiments.ts:80
Delete a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/experiments.ts:91
Get a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsGetOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsGetResponse>

getExecutionDetails

getExecutionDetails(resourceGroupName: string, experimentName: string, executionDetailsId: string, options?: ExperimentsGetExecutionDetailsOptionalParams): Promise<ExperimentsGetExecutionDetailsResponse>

- Defined in operationsInterfaces/experiments.ts:151
Get an execution detail of a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- executionDetailsId: string
  
  GUID that represents a Experiment execution detail.
- Optional options: ExperimentsGetExecutionDetailsOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsGetExecutionDetailsResponse>

getStatus

getStatus(resourceGroupName: string, experimentName: string, statusId: string, options?: ExperimentsGetStatusOptionalParams): Promise<ExperimentsGetStatusResponse>

- Defined in operationsInterfaces/experiments.ts:138
Get a status of a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- statusId: string
  
  GUID that represents a Experiment status.
- Optional options: ExperimentsGetStatusOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsGetStatusResponse>

list

list(resourceGroupName: string, options?: ExperimentsListOptionalParams): PagedAsyncIterableIterator<Experiment>

- Defined in operationsInterfaces/experiments.ts:48
Get a list of Experiment resources in a resource group.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- Optional options: ExperimentsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Experiment>

listAll

listAll(options?: ExperimentsListAllOptionalParams): PagedAsyncIterableIterator<Experiment>

- Defined in operationsInterfaces/experiments.ts:40
Get a list of Experiment resources in a subscription.

Parameters
- Optional options: ExperimentsListAllOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Experiment>

listAllStatuses

listAllStatuses(resourceGroupName: string, experimentName: string, options?: ExperimentsListAllStatusesOptionalParams): PagedAsyncIterableIterator<ExperimentStatus>

- Defined in operationsInterfaces/experiments.ts:58
Get a list of statuses of a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsListAllStatusesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ExperimentStatus>

listExecutionDetails

listExecutionDetails(resourceGroupName: string, experimentName: string, options?: ExperimentsListExecutionDetailsOptionalParams): PagedAsyncIterableIterator<ExperimentExecutionDetails>

- Defined in operationsInterfaces/experiments.ts:69
Get a list of execution details of a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsListExecutionDetailsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ExperimentExecutionDetails>

start

start(resourceGroupName: string, experimentName: string, options?: ExperimentsStartOptionalParams): Promise<ExperimentsStartResponse>

- Defined in operationsInterfaces/experiments.ts:126
Start a Experiment resource.

Parameters
- resourceGroupName: string
  
  String that represents an Azure resource group.
- experimentName: string
  
  String that represents a Experiment resource name.
- Optional options: ExperimentsStartOptionalParams
  
  The options parameters.
Returns Promise<ExperimentsStartResponse>

Hierarchy

Implemented by

Index

Methods

Methods

cancel

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsCancelOptionalParams

Returns Promise<ExperimentsCancelResponse>

createOrUpdate

Parameters

resourceGroupName: string

experimentName: string

experiment: Experiment

Optional options: ExperimentsCreateOrUpdateOptionalParams

Returns Promise<ExperimentsCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsGetOptionalParams

Returns Promise<ExperimentsGetResponse>

getExecutionDetails

Parameters

resourceGroupName: string

experimentName: string

executionDetailsId: string

Optional options: ExperimentsGetExecutionDetailsOptionalParams

Returns Promise<ExperimentsGetExecutionDetailsResponse>

getStatus

Parameters

resourceGroupName: string

experimentName: string

statusId: string

Optional options: ExperimentsGetStatusOptionalParams

Returns Promise<ExperimentsGetStatusResponse>

list

Parameters

resourceGroupName: string

Optional options: ExperimentsListOptionalParams

Returns PagedAsyncIterableIterator<Experiment>

listAll

Parameters

Optional options: ExperimentsListAllOptionalParams

Returns PagedAsyncIterableIterator<Experiment>

listAllStatuses

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsListAllStatusesOptionalParams

Returns PagedAsyncIterableIterator<ExperimentStatus>

listExecutionDetails

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsListExecutionDetailsOptionalParams

Returns PagedAsyncIterableIterator<ExperimentExecutionDetails>

start

Parameters

resourceGroupName: string

experimentName: string

Optional options: ExperimentsStartOptionalParams

Returns Promise<ExperimentsStartResponse>