ExperimentsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:experiments> attribute.
- Inheritance
-
builtins.objectExperimentsOperations
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. |
| update |
The operation to update an experiment. |
cancel
Cancel a running Experiment resource.
cancel(resource_group_name: str, experiment_name: str, **kwargs: Any) -> ExperimentCancelOperationResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ExperimentCancelOperationResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update
Create or update a Experiment resource.
create_or_update(resource_group_name: str, experiment_name: str, experiment: _models.Experiment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ExperimentParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
|
experiment
Required
|
Experiment or
IO
Experiment resource to be created or updated. Is either a Experiment type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Experiment or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete a Experiment resource.
delete(resource_group_name: str, experiment_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a Experiment resource.
get(resource_group_name: str, experiment_name: str, **kwargs: Any) -> ExperimentParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Experiment or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ExperimentExecutionDetailsParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
|
execution_details_id
Required
|
GUID that represents a Experiment execution detail. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ExperimentExecutionDetails or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_status
Get a status of a Experiment resource.
get_status(resource_group_name: str, experiment_name: str, status_id: str, **kwargs: Any) -> ExperimentStatusParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
|
status_id
Required
|
GUID that represents a Experiment status. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ExperimentStatus or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[Experiment]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
running
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
Required
|
String that sets the continuation token. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Experiment or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[Experiment]Parameters
| Name | Description |
|---|---|
|
running
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
Required
|
String that sets the continuation token. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Experiment or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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[ExperimentStatus]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ExperimentStatus or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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[ExperimentExecutionDetails]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ExperimentExecutionDetails or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
start
Start a Experiment resource.
start(resource_group_name: str, experiment_name: str, **kwargs: Any) -> ExperimentStartOperationResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ExperimentStartOperationResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
The operation to update an experiment.
update(resource_group_name: str, experiment_name: str, experiment: _models.ExperimentUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ExperimentParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
String that represents an Azure resource group. Required. |
|
experiment_name
Required
|
String that represents a Experiment resource name. Required. |
|
experiment
Required
|
Parameters supplied to the Update experiment operation. Is either a ExperimentUpdate type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Experiment or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.chaos.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\chaos\\models\\__init__.py'>
Azure SDK for Python