Experiments - Execution Details

Service:

Chaos Studio

API Version:

2024-01-01

Execution details of an experiment resource.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}/getExecutionDetails?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	experimentExecutionDetails	Get experiment execution details.
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 experiment execution details.

Sample Request

HTTP

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

Java

/**
 * Samples for Experiments ExecutionDetails.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/examples/DetailsExperiment.json
     */
    /**
     * Sample code: Get experiment execution details.
     * 
     * @param manager Entry point to ChaosManager.
     */
    public static void getExperimentExecutionDetails(com.azure.resourcemanager.chaos.ChaosManager manager) {
        manager.experiments().executionDetailsWithResponse("exampleRG", "exampleExperiment",
            "f24500ad-744e-4a26-864b-b76199eac333", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.chaos import ChaosManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-chaos
# USAGE
    python details_experiment.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ChaosManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="6b052e15-03d3-4f17-b2e1-be7f07588291",
    )

    response = client.experiments.execution_details(
        resource_group_name="exampleRG",
        experiment_name="exampleExperiment",
        execution_id="f24500ad-744e-4a26-864b-b76199eac333",
    )
    print(response)


# x-ms-original-file: specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/examples/DetailsExperiment.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armchaos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/chaos/armchaos"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e4009d2f8d3bf0271757e522c7d1c1997e193d44/specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/examples/DetailsExperiment.json
func ExampleExperimentsClient_ExecutionDetails() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armchaos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewExperimentsClient().ExecutionDetails(ctx, "exampleRG", "exampleExperiment", "f24500ad-744e-4a26-864b-b76199eac333", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExperimentExecutionDetails = armchaos.ExperimentExecutionDetails{
	// 	Name: to.Ptr("f24500ad-744e-4a26-864b-b76199eac333"),
	// 	Type: to.Ptr("Microsoft.Chaos/experiments/executions/getExecutionDetails"),
	// 	ID: to.Ptr("/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment/executions/f24500ad-744e-4a26-864b-b76199eac333/getExecutionDetails"),
	// 	Properties: &armchaos.ExperimentExecutionDetailsProperties{
	// 		StartedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-14T21:52:52.255Z"); return t}()),
	// 		Status: to.Ptr("failed"),
	// 		StoppedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-14T21:56:18.928Z"); return t}()),
	// 		FailureReason: to.Ptr("Dependency failure"),
	// 		LastActionAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-14T21:52:52.255Z"); return t}()),
	// 		RunInformation: &armchaos.ExperimentExecutionDetailsPropertiesRunInformation{
	// 			Steps: []*armchaos.StepStatus{
	// 				{
	// 					Branches: []*armchaos.BranchStatus{
	// 						{
	// 							Actions: []*armchaos.ActionStatus{
	// 								{
	// 									ActionID: to.Ptr("59499d33-6751-4b6e-a1f6-58f4d56a040a"),
	// 									ActionName: to.Ptr("urn:provider:agent-v2:Microsoft.Azure.Chaos.Fault.CPUPressureAllProcessors"),
	// 									EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-14T21:56:13.627Z"); return t}()),
	// 									StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-14T21:56:13.627Z"); return t}()),
	// 									Status: to.Ptr("failed"),
	// 									Targets: []*armchaos.ExperimentExecutionActionTargetDetailsProperties{
	// 										{
	// 											Status: to.Ptr("succeeded"),
	// 											Target: to.Ptr("/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/VM1"),
	// 											TargetCompletedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T17:30:55.000Z"); return t}()),
	// 											TargetFailedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T16:30:55.000Z"); return t}()),
	// 										},
	// 										{
	// 											Status: to.Ptr("failed"),
	// 											Target: to.Ptr("/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/VM1"),
	// 											TargetCompletedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T17:30:55.000Z"); return t}()),
	// 											TargetFailedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-02T16:30:55.000Z"); return t}()),
	// 									}},
	// 							}},
	// 							BranchID: to.Ptr("FirstBranch"),
	// 							BranchName: to.Ptr("FirstBranch"),
	// 							Status: to.Ptr("failed"),
	// 					}},
	// 					Status: to.Ptr("failed"),
	// 					StepID: to.Ptr("FirstStep"),
	// 					StepName: to.Ptr("FirstStep"),
	// 			}},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ChaosManagementClient } = require("@azure/arm-chaos");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Execution details of an experiment resource.
 *
 * @summary Execution details of an experiment resource.
 * x-ms-original-file: specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/examples/DetailsExperiment.json
 */
async function getExperimentExecutionDetails() {
  const subscriptionId =
    process.env["CHAOS_SUBSCRIPTION_ID"] || "6b052e15-03d3-4f17-b2e1-be7f07588291";
  const resourceGroupName = process.env["CHAOS_RESOURCE_GROUP"] || "exampleRG";
  const experimentName = "exampleExperiment";
  const executionId = "f24500ad-744e-4a26-864b-b76199eac333";
  const credential = new DefaultAzureCredential();
  const client = new ChaosManagementClient(credential, subscriptionId);
  const result = await client.experiments.executionDetails(
    resourceGroupName,
    experimentName,
    executionId,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Chaos;
using Azure.ResourceManager.Chaos.Models;

// Generated from example definition: specification/chaos/resource-manager/Microsoft.Chaos/stable/2024-01-01/examples/DetailsExperiment.json
// this example is just showing the usage of "Experiments_ExecutionDetails" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ChaosExperimentExecutionResource created on azure
// for more information of creating ChaosExperimentExecutionResource, please refer to the document of ChaosExperimentExecutionResource
string subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
string resourceGroupName = "exampleRG";
string experimentName = "exampleExperiment";
string executionId = "f24500ad-744e-4a26-864b-b76199eac333";
ResourceIdentifier chaosExperimentExecutionResourceId = ChaosExperimentExecutionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, experimentName, executionId);
ChaosExperimentExecutionResource chaosExperimentExecution = client.GetChaosExperimentExecutionResource(chaosExperimentExecutionResourceId);

// invoke the operation
ExperimentExecutionDetails result = await chaosExperimentExecution.ExecutionDetailsAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "type": "Microsoft.Chaos/experiments/executions/getExecutionDetails",
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment/executions/f24500ad-744e-4a26-864b-b76199eac333/getExecutionDetails",
  "name": "f24500ad-744e-4a26-864b-b76199eac333",
  "properties": {
    "lastActionAt": "2020-12-14T21:52:52.2552574Z",
    "startedAt": "2020-12-14T21:52:52.2552574Z",
    "stoppedAt": "2020-12-14T21:56:18.9281956Z",
    "status": "failed",
    "failureReason": "Dependency failure",
    "runInformation": {
      "steps": [
        {
          "stepName": "FirstStep",
          "stepId": "FirstStep",
          "status": "failed",
          "branches": [
            {
              "branchName": "FirstBranch",
              "branchId": "FirstBranch",
              "status": "failed",
              "actions": [
                {
                  "actionName": "urn:provider:agent-v2:Microsoft.Azure.Chaos.Fault.CPUPressureAllProcessors",
                  "actionId": "59499d33-6751-4b6e-a1f6-58f4d56a040a",
                  "status": "failed",
                  "startTime": "2020-12-14T13:56:13.6270153-08:00",
                  "endTime": "2020-12-14T13:56:13.6270153-08:00",
                  "targets": [
                    {
                      "status": "succeeded",
                      "target": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/VM1",
                      "targetFailedTime": "2021-04-02T16:30:55+00:00",
                      "targetCompletedTime": "2021-04-02T17:30:55+00:00"
                    },
                    {
                      "status": "failed",
                      "target": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/VM1",
                      "targetFailedTime": "2021-04-02T16:30:55+00:00",
                      "targetCompletedTime": "2021-04-02T17:30:55+00:00"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Definitions

Name	Description
actionStatus	Model that represents the an action and its status.
branchStatus	Model that represents the a list of actions and action statuses.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
experimentExecutionActionTargetDetailsError	Model that represents the Experiment action target details error model.
experimentExecutionActionTargetDetailsProperties	Model that represents the Experiment action target details properties model.
experimentExecutionDetails	Model that represents the execution details of an Experiment.
RunInformation	The information of the experiment run.
stepStatus	Model that represents the a list of branches and branch statuses.

actionStatus

Model that represents the an action and its status.

Name	Type	Description
actionId	string	The id of the action status.
actionName	string	The name of the action status.
endTime	string	String that represents the end time of the action.
startTime	string	String that represents the start time of the action.
status	string	The status of the action.
targets	experimentExecutionActionTargetDetailsProperties[]	The array of targets.

branchStatus

Model that represents the a list of actions and action statuses.

Name	Type	Description
actions	actionStatus[]	The array of actions.
branchId	string	The id of the branch status.
branchName	string	The name of the branch status.
status	string	The status of the branch.

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.

experimentExecutionActionTargetDetailsError

Model that represents the Experiment action target details error model.

Name	Type	Description
code	string	The error code.
message	string	The error message

experimentExecutionActionTargetDetailsProperties

Model that represents the Experiment action target details properties model.

Name	Type	Description
error	experimentExecutionActionTargetDetailsError	The error of the action.
status	string	The status of the execution.
target	string	The target for the action.
targetCompletedTime	string	String that represents the completed date time.
targetFailedTime	string	String that represents the failed date time.

experimentExecutionDetails

Model that represents the execution details of an Experiment.

Name	Type	Description
id	string	String of the fully qualified resource ID.
name	string	String of the resource name.
properties.failureReason	string	The reason why the execution failed.
properties.lastActionAt	string	String that represents the last action date time.
properties.runInformation	RunInformation	The information of the experiment run.
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.

RunInformation

The information of the experiment run.

Name	Type	Description
steps	stepStatus[]	The steps of the experiment run.

stepStatus

Model that represents the a list of branches and branch statuses.

Name	Type	Description
branches	branchStatus[]	The array of branches.
status	string	The value of the status of the step.
stepId	string	The id of the step.
stepName	string	The name of the step.