Experiments - Get Execution

Get an execution of an Experiment resource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}?api-version=2024-01-01

URI Parameters

Name In Required Type Description
executionId
path True

string

GUID that represents a Experiment execution detail.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

experimentName
path True

string

String that represents a Experiment resource name.

Regex pattern: ^[^<>%&:?#/\\]+$

resourceGroupName
path True

string

String that represents an Azure resource group.

Regex pattern: ^[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]$

subscriptionId
path True

string

GUID that represents an Azure subscription ID.

Regex pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

api-version
query True

string

String that sets the API version.

Regex pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(|-preview)$

Responses

Name Type Description
200 OK

experimentExecution

Execution returned if request was successful.

Other Status Codes

ErrorResponse

Error response returned if request was unsuccessful.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Impersonate your user account

Examples

Get the execution of a Experiment.

Sample Request

GET https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment/executions/f24500ad-744e-4a26-864b-b76199eac333?api-version=2024-01-01

Sample Response

{
  "type": "Microsoft.Chaos/experiments/executions",
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment/executions/f24500ad-744e-4a26-864b-b76199eac333",
  "name": "f24500ad-744e-4a26-864b-b76199eac333",
  "properties": {
    "startedAt": "2020-12-14T21:52:52.2552574Z",
    "stoppedAt": "2020-12-14T21:56:18.9281956Z",
    "status": "failed"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

experimentExecution

Model that represents the execution of a Experiment.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

experimentExecution

Model that represents the execution of a Experiment.

Name Type Description
id

string

String of the fully qualified resource ID.

name

string

String of the resource name.

properties.startedAt

string

String that represents the start date time.

properties.status

string

The status of the execution.

properties.stoppedAt

string

String that represents the stop date time.

type

string

String of the resource type.