Scenarios - Get

Tjänst:: Chaos Studio

API-version:: 2026-08-01-preview

Skaffa ett scenario.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}?api-version=2026-08-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
scenarioName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	Namnet på scenariot.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	Sträng som representerar ett Workspace-resursnamn.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	Scenario	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a scenario.

Exempelbegäran

GET https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/workspaces/exampleWorkspace/scenarios/zoneDownScenario?api-version=2026-08-01-preview


/**
 * Samples for Scenarios Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2026-08-01-preview/Scenarios_Get.json
     */
    /**
     * Sample code: Get a scenario.
     * 
     * @param manager Entry point to ChaosManager.
     */
    public static void getAScenario(com.azure.resourcemanager.chaos.ChaosManager manager) {
        manager.scenarios().getWithResponse("exampleRG", "exampleWorkspace", "zoneDownScenario",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.chaos import ChaosManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-chaos
# USAGE
    python scenarios_get.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="SUBSCRIPTION_ID",
    )

    response = client.scenarios.get(
        resource_group_name="exampleRG",
        workspace_name="exampleWorkspace",
        scenario_name="zoneDownScenario",
    )
    print(response)


# x-ms-original-file: 2026-08-01-preview/Scenarios_Get.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

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/v3"
)

// Generated from example definition: 2026-08-01-preview/Scenarios_Get.json
func ExampleScenariosClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armchaos.NewClientFactory("6b052e15-03d3-4f17-b2e1-be7f07588291", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewScenariosClient().Get(ctx, "exampleRG", "exampleWorkspace", "zoneDownScenario", 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 = armchaos.ScenariosClientGetResponse{
	// 	Scenario: armchaos.Scenario{
	// 		ID: to.Ptr("/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/workspaces/exampleWorkspace/scenarios/zoneDownScenario"),
	// 		Name: to.Ptr("zoneDownScenario"),
	// 		Type: to.Ptr("Microsoft.Chaos/workspaces/scenarios"),
	// 		Properties: &armchaos.ScenarioProperties{
	// 			ProvisioningState: to.Ptr(armchaos.ProvisioningStateSucceeded),
	// 			Version: to.Ptr("1.0"),
	// 			Description: to.Ptr("Induces an outage of all discovered VM and VMSS instances in the target zone with an option to invoke custom scripted actions using Automation Runbooks. Additionally, it forces failover of discovered Redis instances to simulate backend zonal outage."),
	// 			Parameters: []*armchaos.ScenarioParameter{
	// 				{
	// 					Name: to.Ptr("duration"),
	// 					Type: to.Ptr(armchaos.ParameterTypeString),
	// 					Default: to.Ptr("PT15M"),
	// 					Required: to.Ptr(false),
	// 					Description: to.Ptr("The duration of the outage scenario."),
	// 				},
	// 				{
	// 					Name: to.Ptr("customRunbook1ResourceId"),
	// 					Type: to.Ptr(armchaos.ParameterTypeString),
	// 					Required: to.Ptr(false),
	// 					Description: to.Ptr("Optional custom runbook 1 resource ID. If not provided, this action will be skipped."),
	// 				},
	// 				{
	// 					Name: to.Ptr("customRunbook1ParametersJson"),
	// 					Type: to.Ptr(armchaos.ParameterTypeString),
	// 					Required: to.Ptr(false),
	// 					Default: to.Ptr("{}"),
	// 					Description: to.Ptr("Optional custom runbook 1 parameters in JSON format."),
	// 				},
	// 			},
	// 			Actions: []*armchaos.ScenarioAction{
	// 				{
	// 					Name: to.Ptr("vmssZoneDown"),
	// 					ActionID: to.Ptr("urn:csci:microsoft:compute:shutdown/1.0.0"),
	// 					Description: to.Ptr("Force shutdown VMSS instances in target zone"),
	// 					Duration: to.Ptr("%%{parameters.duration}%%"),
	// 					Parameters: []*armchaos.KeyValuePair{
	// 						{
	// 							Key: to.Ptr("zones"),
	// 							Value: to.Ptr("%%{filters.zones}%%"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("vmZoneDown"),
	// 					ActionID: to.Ptr("urn:csci:microsoft:compute:shutdown/1.0.0"),
	// 					Description: to.Ptr("Force shutdown VM instances in target zone"),
	// 					Duration: to.Ptr("%%{parameters.duration}%%"),
	// 					Parameters: []*armchaos.KeyValuePair{
	// 						{
	// 							Key: to.Ptr("zones"),
	// 							Value: to.Ptr("%%{filters.zones}%%"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("redisFailover"),
	// 					ActionID: to.Ptr("urn:csci:microsoft:azureClusteredCacheForRedis:Reboot/1.0.0"),
	// 					Description: to.Ptr("Force failover of Redis instances to simulate backend zonal outage"),
	// 					Duration: to.Ptr("PT5M"),
	// 					Parameters: []*armchaos.KeyValuePair{
	// 						{
	// 							Key: to.Ptr("RebootType"),
	// 							Value: to.Ptr("PrimaryNode"),
	// 						},
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("custom-runbook-1"),
	// 					ActionID: to.Ptr("urn:csci:microsoft:Automation:StartRunbook/1.0.0"),
	// 					Description: to.Ptr("Custom Runbook 1"),
	// 					Duration: to.Ptr("PT30M"),
	// 					Parameters: []*armchaos.KeyValuePair{
	// 						{
	// 							Key: to.Ptr("RunbookParameters"),
	// 							Value: to.Ptr("%%{parameters.customRunbook1ParametersJson}%%"),
	// 						},
	// 					},
	// 					ExternalResource: &armchaos.ExternalResource{
	// 						ResourceID: to.Ptr("/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Automation/automationAccounts/exampleAutomationAccount/runbooks/exampleRunbook"),
	// 					},
	// 				},
	// 			},
	// 			Recommendation: &armchaos.Recommendation{
	// 				RecommendationStatus: to.Ptr(armchaos.RecommendationStatusRecommended),
	// 				EvaluationRunAt: to.Ptr(time.Date(2025, time.January, 15, 10, 30, 0, 0, time.UTC)),
	// 			},
	// 		},
	// 		SystemData: &armchaos.SystemData{
	// 			CreatedAt: to.Ptr(time.Date(2025, time.January, 1, 0, 0, 0, 0, time.UTC)),
	// 			CreatedBy: to.Ptr("admin@contoso.com"),
	// 			CreatedByType: to.Ptr(armchaos.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(time.Date(2025, time.January, 15, 10, 30, 0, 0, time.UTC)),
	// 			LastModifiedBy: to.Ptr("admin@contoso.com"),
	// 			LastModifiedByType: to.Ptr(armchaos.CreatedByTypeUser),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to get a scenario.
 *
 * @summary get a scenario.
 * x-ms-original-file: 2026-08-01-preview/Scenarios_Get.json
 */
async function getAScenario() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "6b052e15-03d3-4f17-b2e1-be7f07588291";
  const client = new ChaosManagementClient(credential, subscriptionId);
  const result = await client.scenarios.get("exampleRG", "exampleWorkspace", "zoneDownScenario");
  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

Exempelsvar

Statuskod:: 200

{
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/workspaces/exampleWorkspace/scenarios/zoneDownScenario",
  "name": "zoneDownScenario",
  "type": "Microsoft.Chaos/workspaces/scenarios",
  "properties": {
    "provisioningState": "Succeeded",
    "version": "1.0",
    "description": "Induces an outage of all discovered VM and VMSS instances in the target zone with an option to invoke custom scripted actions using Automation Runbooks. Additionally, it forces failover of discovered Redis instances to simulate backend zonal outage.",
    "parameters": [
      {
        "name": "duration",
        "type": "string",
        "default": "PT15M",
        "required": false,
        "description": "The duration of the outage scenario."
      },
      {
        "name": "customRunbook1ResourceId",
        "type": "string",
        "required": false,
        "description": "Optional custom runbook 1 resource ID. If not provided, this action will be skipped."
      },
      {
        "name": "customRunbook1ParametersJson",
        "type": "string",
        "required": false,
        "default": "{}",
        "description": "Optional custom runbook 1 parameters in JSON format."
      }
    ],
    "actions": [
      {
        "name": "vmssZoneDown",
        "actionId": "urn:csci:microsoft:compute:shutdown/1.0.0",
        "description": "Force shutdown VMSS instances in target zone",
        "duration": "%%{parameters.duration}%%",
        "parameters": [
          {
            "key": "zones",
            "value": "%%{filters.zones}%%"
          }
        ]
      },
      {
        "name": "vmZoneDown",
        "actionId": "urn:csci:microsoft:compute:shutdown/1.0.0",
        "description": "Force shutdown VM instances in target zone",
        "duration": "%%{parameters.duration}%%",
        "parameters": [
          {
            "key": "zones",
            "value": "%%{filters.zones}%%"
          }
        ]
      },
      {
        "name": "redisFailover",
        "actionId": "urn:csci:microsoft:azureClusteredCacheForRedis:Reboot/1.0.0",
        "description": "Force failover of Redis instances to simulate backend zonal outage",
        "duration": "PT5M",
        "parameters": [
          {
            "key": "RebootType",
            "value": "PrimaryNode"
          }
        ]
      },
      {
        "name": "custom-runbook-1",
        "actionId": "urn:csci:microsoft:Automation:StartRunbook/1.0.0",
        "description": "Custom Runbook 1",
        "duration": "PT30M",
        "parameters": [
          {
            "key": "RunbookParameters",
            "value": "%%{parameters.customRunbook1ParametersJson}%%"
          }
        ],
        "externalResource": {
          "resourceId": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Automation/automationAccounts/exampleAutomationAccount/runbooks/exampleRunbook"
        }
      }
    ],
    "recommendation": {
      "recommendationStatus": "Recommended",
      "evaluationRunAt": "2025-01-15T10:30:00.000Z"
    }
  },
  "systemData": {
    "createdAt": "2025-01-01T00:00:00.000Z",
    "createdBy": "admin@contoso.com",
    "createdByType": "User",
    "lastModifiedAt": "2025-01-15T10:30:00.000Z",
    "lastModifiedBy": "admin@contoso.com",
    "lastModifiedByType": "User"
  }
}

Definitioner

Name	Description
ActionDependency	Modell som representerar ett handlingsberoende.
ActionDependencyType	Enum för handlingsberoendetyp.
ActionLifecycle	Enum för handlingslivscykeltillstånd.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ExternalResource	Modell som representerar en extern resursreferens.
KeyValuePair	Ett nyckel-värde-par som används för att beskriva parametrar för åtgärder eller konfigurationer.
ParameterType	Enum för parametertyper.
ProvisioningState	Aktuellt etableringstillstånd för en viss Azure Chaos-resurs.
Recommendation	Modell som representerar en scenariorekommendation.
RecommendationStatus	Enum av scenariovalideringstillståndet.
RunAfter	Modell som representerar handlingsberoenden.
RunAfterBehavior	Definierar hur flera beroenden utvärderas.
Scenario	Modell som representerar scenariot.
ScenarioAction	Modellera som representerar en scenariohandling.
ScenarioParameter	Modell som representerar en enda scenarioparameterdefinition.
ScenarioProperties	Modell som representerar egenskaperna i scenariot.
systemData	Metadata som rör skapande och senaste ändring av resursen.

ActionDependency

Objekt

Modell som representerar ett handlingsberoende.

Name	Typ	Description
name	string	Namnet på åtgärden detta beror på.
onActionLifecycle	ActionLifecycle	Livscykeltillståndet för beroendehandlingen som utlöser denna handling.
type	ActionDependencyType	Typen av beroende.

ActionDependencyType

Uppräkning

Enum för handlingsberoendetyp.

Värde	Description
Action	Typ av handlingsberoende.

ActionLifecycle

Uppräkning

Enum för handlingslivscykeltillstånd.

Värde	Description
AnyTerminal	Utlös när handlingen når något terminalt tillstånd.
Start	Utlös när handlingen börjar.
Running	Utlös när action pågår.
Success	Utlös vid framgång.
Failure	Utlöser vid misslyckande.
Skipped	Trigga när handlingen hoppas över.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ExternalResource

Objekt

Modell som representerar en extern resursreferens.

Name	Typ	Description
resourceId	string (arm-id)	Resurs-ID:t för den externa resursen.

KeyValuePair

Objekt

Ett nyckel-värde-par som används för att beskriva parametrar för åtgärder eller konfigurationer.

Name	Typ	Description
key	string minLength: 1	Namnet på inställningen för åtgärden.
value	string minLength: 1	Värdet för inställningen för åtgärden.

ParameterType

Uppräkning

Enum för parametertyper.

Värde	Description
string	Typ av strängparameter.
number	Typ av nummerparameter.
boolean	Boolesk parametertyp.
object	Objektparametertyp.
array	Arrayparametertyp.

ProvisioningState

Uppräkning

Aktuellt etableringstillstånd för en viss Azure Chaos-resurs.

Värde	Description
Succeeded	Resursen har skapats.
Failed	Det gick inte att skapa resurser.
Canceled	Resursskapandet avbröts.
Creating	Inledande skapande pågår.
Updating	Uppdatering pågår.
Deleting	Borttagning pågår.
Running	Action är att springa.

Recommendation

Objekt

Modell som representerar en scenariorekommendation.

Name	Typ	Description
evaluationRunAt	string (date-time)	UTC-tiden när rekommendationen utvärderades.
recommendationStatus	RecommendationStatus	Rekommendationsstatusen.

RecommendationStatus

Uppräkning

Enum av scenariovalideringstillståndet.

Värde	Description
NotEvaluated	Statusen för scenariorekommendationen har inte utvärderats.
Recommended	Statusen för scenariorekommendation rekommenderas.
NotApplicable	Statusen för scenariorekommendation är inte tillämplig.
Evaluating	Statusen för scenariorekommendationen utvärderas för närvarande.
EvaluationFailed	Utvärderingen av scenariorekommendationen har misslyckats.
EvaluationCancelled	Utvärderingen av scenariorekommendationen avbröts.

RunAfter

Objekt

Modell som representerar handlingsberoenden.

Name	Typ	Standardvärde	Description
behavior	RunAfterBehavior	Any	Definierar hur flera beroenden utvärderas.
items	ActionDependency[]		Array av handlingsberoenden.

RunAfterBehavior

Uppräkning

Definierar hur flera beroenden utvärderas.

Värde	Description
Any	Fortsätter alltid trots alla beroenden (som en slutlig blockering).
All	Alla beroenden måste vara tillfredsställda för att fortsätta.
AtLeastOne	Minst ett beroende måste vara uppfyllt för att fortsätta.

Scenario

Objekt

Modell som representerar scenariot.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties	ScenarioProperties	Egenskaperna hos scenariot.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ScenarioAction

Objekt

Modellera som representerar en scenariohandling.

Name	Typ	Description
actionId	string	Identifierare för åtgärden och versionen (t.ex. "microsoft-compute-shutdown/1.0").
description	string	Mänskligt läsbar beskrivning av vad denna handling gör.
duration	string	ISO 8601-duration för hur länge verkstaden pågår (t.ex. PT30M i 30 minuter). Stöder mallmakrosyntax (%%{parameters.<name>}%%).
externalResource	ExternalResource	Extern resursreferens för åtgärden.
name	string pattern: ^[a-zA-Z0-9-_]+$	Unikt namn på mekanismen.
parameters	KeyValuePair[]	Åtgärdsspecifika parametervärden.
runAfter	RunAfter	Handlingsberoenden som styr när denna handling startar.
timeout	string	ISO 8601-varaktighet för maximal utföringstid för handling. Stöder mallmakrosyntax.
waitBefore	string	ISO 8601 väntetid innan åtgärden startar (t.ex. PT30S i 30 sekunder). Stöder mallmakrosyntax.

ScenarioParameter

Objekt

Modell som representerar en enda scenarioparameterdefinition.

Name	Typ	Description
default	string	Standardvärde för parametern.
description	string	Beskrivning av parametern.
name	string minLength: 1	Namnet på parametern.
required	boolean	Om denna parameter är krävd.
type	ParameterType	Parameterdatatyp.

ScenarioProperties

Objekt

Modell som representerar egenskaperna i scenariot.

Name	Typ	Description
actions	ScenarioAction[]	En rad handlingar som definierar scenariets orkestrering.
createdFrom	string	Resurs-ID för mallversionen som detta scenario skapades från (valfritt).
description	string	Beskrivning av vad detta scenario gör (valfritt).
parameters	ScenarioParameter[]	Parameterdefinitioner för scenariot.
provisioningState	ProvisioningState	Senaste provisioneringsläget för den givna scenarioresursen.
recommendation	Recommendation	Rekommendationsinformationen för detta scenario.
version	string	Version av scenariot.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.