Share via

ExperimentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ChaosManagementClient's

<xref:experiments> attribute.

Constructor

ExperimentsOperations(*args, **kwargs)

Methods

begin_cancel

Cancel a running Experiment resource.
begin_create_or_update

Create or update a Experiment resource.
begin_delete

Delete a Experiment resource.
begin_start

Start a Experiment resource.
begin_update

The operation to update an experiment.
execution_details

Execution details of an experiment resource.
get

Get a Experiment resource.
get_execution

Get an execution of an Experiment resource.
list

Get a list of Experiment resources in a resource group.
list_all

Get a list of Experiment resources in a subscription.
list_all_executions

Get a list of executions of an Experiment resource.

begin_cancel

Cancel a running Experiment resource.

begin_cancel(resource_group_name: str, experiment_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update

Create or update a Experiment resource.

begin_create_or_update(resource_group_name: str, experiment_name: str, resource: _models.Experiment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Experiment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.
resource
Required
Experiment or IO[bytes]

Experiment resource to be created or updated. Is either a Experiment type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Experiment]

An instance of LROPoller that returns either Experiment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a Experiment resource.

begin_delete(resource_group_name: str, experiment_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_start

Start a Experiment resource.

begin_start(resource_group_name: str, experiment_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

The operation to update an experiment.

begin_update(resource_group_name: str, experiment_name: str, properties: _models.ExperimentUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Experiment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.
properties
Required
ExperimentUpdate or IO[bytes]

Parameters supplied to the Update experiment operation. Is either a ExperimentUpdate type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Experiment]

An instance of LROPoller that returns either Experiment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

execution_details

Execution details of an experiment resource.

execution_details(resource_group_name: str, experiment_name: str, execution_id: str, **kwargs: Any) -> ExperimentExecutionDetails

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.
execution_id
Required
str

GUID that represents a Experiment execution detail. Required.

Returns

Type Description
ExperimentExecutionDetails

ExperimentExecutionDetails or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a Experiment resource.

get(resource_group_name: str, experiment_name: str, **kwargs: Any) -> Experiment

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.

Returns

Type Description
Experiment

Experiment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_execution

Get an execution of an Experiment resource.

get_execution(resource_group_name: str, experiment_name: str, execution_id: str, **kwargs: Any) -> ExperimentExecution

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.
execution_id
Required
str

GUID that represents a Experiment execution detail. Required.

Returns

Type Description
ExperimentExecution

ExperimentExecution or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Get a list of Experiment resources in a resource group.

list(resource_group_name: str, running: bool | None = None, continuation_token_parameter: str | None = None, **kwargs: Any) -> ItemPaged[Experiment]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
running
bool

Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. Default value is None.

Default value: None
continuation_token_parameter
str

String that sets the continuation token. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[Experiment]

An iterator like instance of either Experiment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_all

Get a list of Experiment resources in a subscription.

list_all(running: bool | None = None, continuation_token_parameter: str | None = None, **kwargs: Any) -> ItemPaged[Experiment]

Parameters

Name Description
running
bool

Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered. Default value is None.

Default value: None
continuation_token_parameter
str

String that sets the continuation token. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[Experiment]

An iterator like instance of either Experiment or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_all_executions

Get a list of executions of an Experiment resource.

list_all_executions(resource_group_name: str, experiment_name: str, **kwargs: Any) -> ItemPaged[ExperimentExecution]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
experiment_name
Required
str

String that represents a Experiment resource name. Required.

Returns

Type Description
ItemPaged[ExperimentExecution]

An iterator like instance of either ExperimentExecution or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.chaos.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv85\\Lib\\site-packages\\azure\\mgmt\\chaos\\models\\__init__.py'>