ExperimentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ChaosManagementClient's

<xref:experiments> attribute.

Inheritance

builtins.object

ExperimentsOperations

Constructor

ExperimentsOperations(*args, **kwargs)

Methods

cancel	Cancel a running Experiment resource.
create_or_update	Create or update a Experiment resource.
delete	Delete a Experiment resource.
get	Get a Experiment resource.
get_execution_details	Get an execution detail of a Experiment resource.
get_status	Get a status of a 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_statuses	Get a list of statuses of a Experiment resource.
list_execution_details	Get a list of execution details of a Experiment resource.
start	Start a Experiment resource.

cancel

Cancel a running Experiment resource.

cancel(resource_group_name: str, experiment_name: str, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.ExperimentCancelOperationResult

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

ExperimentCancelOperationResult, or the result of cls(response)

Return type

ExperimentCancelOperationResult

Exceptions

HttpResponseError

create_or_update

Create or update a Experiment resource.

create_or_update(resource_group_name: str, experiment_name: str, experiment: azure.mgmt.chaos.models._models_py3.Experiment, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.Experiment

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

experiment

Experiment

Required

Experiment resource to be created or updated.

cls

callable

A custom type or function that will be passed the direct response

Returns

Experiment, or the result of cls(response)

Return type

Experiment

Exceptions

HttpResponseError

delete

Delete a Experiment resource.

delete(resource_group_name: str, experiment_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get a Experiment resource.

get(resource_group_name: str, experiment_name: str, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.Experiment

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

Experiment, or the result of cls(response)

Return type

Experiment

Exceptions

HttpResponseError

get_execution_details

Get an execution detail of a Experiment resource.

get_execution_details(resource_group_name: str, experiment_name: str, execution_details_id: str, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.ExperimentExecutionDetails

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

execution_details_id

str

Required

GUID that represents a Experiment execution detail.

cls

callable

A custom type or function that will be passed the direct response

Returns

ExperimentExecutionDetails, or the result of cls(response)

Return type

ExperimentExecutionDetails

Exceptions

HttpResponseError

get_status

Get a status of a Experiment resource.

get_status(resource_group_name: str, experiment_name: str, status_id: str, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.ExperimentStatus

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

status_id

str

Required

GUID that represents a Experiment status.

cls

callable

A custom type or function that will be passed the direct response

Returns

ExperimentStatus, or the result of cls(response)

Return type

ExperimentStatus

Exceptions

HttpResponseError

list

Get a list of Experiment resources in a resource group.

list(resource_group_name: str, running: Optional[bool] = None, continuation_token_parameter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.chaos.models._models_py3.ExperimentListResult]

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

running

bool

Required

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.

continuation_token_parameter

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ExperimentListResult]

Exceptions

HttpResponseError

list_all

Get a list of Experiment resources in a subscription.

list_all(running: Optional[bool] = None, continuation_token_parameter: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.chaos.models._models_py3.ExperimentListResult]

Parameters

running

bool

Required

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.

continuation_token_parameter

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ExperimentListResult]

Exceptions

HttpResponseError

list_all_statuses

Get a list of statuses of a Experiment resource.

list_all_statuses(resource_group_name: str, experiment_name: str, **kwargs: Any) -> Iterable[azure.mgmt.chaos.models._models_py3.ExperimentStatusListResult]

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ExperimentStatusListResult]

Exceptions

HttpResponseError

list_execution_details

Get a list of execution details of a Experiment resource.

list_execution_details(resource_group_name: str, experiment_name: str, **kwargs: Any) -> Iterable[azure.mgmt.chaos.models._models_py3.ExperimentExecutionDetailsListResult]

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ExperimentExecutionDetailsListResult]

Exceptions

HttpResponseError

start

Start a Experiment resource.

start(resource_group_name: str, experiment_name: str, **kwargs: Any) -> azure.mgmt.chaos.models._models_py3.ExperimentStartOperationResult

Parameters

resource_group_name

str

Required

String that represents an Azure resource group.

experiment_name

str

Required

String that represents a Experiment resource name.

cls

callable

A custom type or function that will be passed the direct response

Returns

ExperimentStartOperationResult, or the result of cls(response)

Return type

ExperimentStartOperationResult

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.chaos.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\chaos\\models\\__init__.py'>