Scenarios - Get

Szolgáltatás:: Chaos Studio

API-verzió:: 2026-08-01-preview

Készíts egy forgatókönyvet.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
scenarioName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	A forgatókönyv neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
workspaceName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	Olyan string, amely egy Workspace erőforrás nevét képviseli.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	Scenario	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a scenario.

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
  }
}

Definíciók

Name	Description
ActionDependency	Olyan modell, amely egy akciófüggőséget képvisel.
ActionDependencyType	Enum az akciófüggőségi típusra.
ActionLifecycle	Enum az akció életciklus állapotokhoz.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ExternalResource	Olyan modell, amely külső forráshivatkozást képvisel.
KeyValuePair	Egy kulcs-érték pár, amelyet műveletek vagy konfigurációk paramétereinek leírására használnak.
ParameterType	Enum paramétertípusokhoz.
ProvisioningState	Aktuális provisioning állapot egy adott Azure Chaos erőforráshoz.
Recommendation	Olyan modell, amely egy forgatókönyv-ajánlást képvisel.
RecommendationStatus	A forgatókönyv validációs állapotának enumja.
RunAfter	Olyan modell, amely az akciófüggőségeket ábrázolja.
RunAfterBehavior	Meghatározza, hogyan értékelik a több függőséget.
Scenario	Olyan modell, amely a forgatókönyvet képviseli.
ScenarioAction	Olyan modell, amely egy forgatókönyv-akciót képvisel.
ScenarioParameter	Olyan modell, amely egyetlen forgatókönyvparaméter definíciót képvisel.
ScenarioProperties	Olyan modell, amely a forgatókönyv tulajdonságait képviseli.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

ActionDependency

Tárgy

Olyan modell, amely egy akciófüggőséget képvisel.

Name	Típus	Description
name	string	A cselekvés neve ez függ.
onActionLifecycle	ActionLifecycle	A függőségi akció életciklusállapota, amely ezt az akciót indítja el.
type	ActionDependencyType	A függőség típusa.

ActionDependencyType

Felsorolás

Enum az akciófüggőségi típusra.

Érték	Description
Action	Műveletfüggőség típusa.

ActionLifecycle

Felsorolás

Enum az akció életciklus állapotokhoz.

Érték	Description
AnyTerminal	Aktiválja, amikor az akció bármilyen végső állapotba kerül.
Start	Aktiváld, amikor az akció elkezdődik.
Running	Aktiváld, amikor az akció fut.
Success	A siker kiváltó kiváltója.
Failure	Kiváltó hiba esetén.
Skipped	Aktiváld, amikor az akciót kihagyják.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ExternalResource

Tárgy

Olyan modell, amely külső forráshivatkozást képvisel.

Name	Típus	Description
resourceId	string (arm-id)	A külső erőforrás forrásazonosítója.

KeyValuePair

Tárgy

Egy kulcs-érték pár, amelyet műveletek vagy konfigurációk paramétereinek leírására használnak.

Name	Típus	Description
key	string minLength: 1	A művelet beállításának neve.
value	string minLength: 1	A művelet beállításának értéke.

ParameterType

Felsorolás

Enum paramétertípusokhoz.

Érték	Description
string	String paramétertípus.
number	Számparaméter típus.
boolean	Boolean paramétertípus.
object	Objektumparaméter típus.
array	Tömb paramétertípus.

ProvisioningState

Felsorolás

Aktuális provisioning állapot egy adott Azure Chaos erőforráshoz.

Érték	Description
Succeeded	Az erőforrás létrejött.
Failed	Az erőforrás létrehozása sikertelen volt.
Canceled	Az erőforrás létrehozása megszakadt.
Creating	A kezdeti létrehozás folyamatban van.
Updating	Frissítés folyamatban.
Deleting	Törlés folyamatban.
Running	A cselekvés indul.

Recommendation

Tárgy

Olyan modell, amely egy forgatókönyv-ajánlást képvisel.

Name	Típus	Description
evaluationRunAt	string (date-time)	Az UTC időpont, amikor az ajánlást értékelték.
recommendationStatus	RecommendationStatus	Az ajánlási státusz.

RecommendationStatus

Felsorolás

A forgatókönyv validációs állapotának enumja.

Érték	Description
NotEvaluated	A forgatókönyv-ajánlás státuszát még nem értékelték.
Recommended	A forgatókönyv ajánlási státusza ajánlott.
NotApplicable	A forgatókönyv-ajánlás státusza nem alkalmazható.
Evaluating	A forgatókönyv-ajánlás státuszát jelenleg értékelik.
EvaluationFailed	A forgatókönyv-ajánlás értékelése kudarcot vallott.
EvaluationCancelled	A forgatókönyv-ajánlás értékelését törölték.

RunAfter

Tárgy

Olyan modell, amely az akciófüggőségeket ábrázolja.

Name	Típus	Alapértelmezett érték	Description
behavior	RunAfterBehavior	Any	Meghatározza, hogyan értékelik a több függőséget.
items	ActionDependency[]		Műveletfüggőségek tömbje.

RunAfterBehavior

Felsorolás

Meghatározza, hogyan értékelik a több függőséget.

Érték	Description
Any	Mindig folytatódik minden függőség után (mint egy végső blokk).
All	Minden függőséget meg kell elégíteni a folytatáshoz.
AtLeastOne	Legalább egy függőségnek ki kell elégedettnek lennie a folytatáshoz.

Scenario

Tárgy

Olyan modell, amely a forgatókönyvet képviseli.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljesen minősített azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties	ScenarioProperties	A forgatókönyv tulajdonságai.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Például: "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ScenarioAction

Tárgy

Olyan modell, amely egy forgatókönyv-akciót képvisel.

Name	Típus	Description
actionId	string	Az akció és a verzió azonosítója (pl. "microsoft-compute-shutdown/1.0").
description	string	Emberi olvasható leírás arról, mit tesz ez a cselekmény.
duration	string	ISO 8601 időtartama arra mér, hogy mennyi ideig tart az akció (pl. PT30M 30 percig). Támogatja a sablon makroszintaxist (%%{paramétereket.<név>}%%).
externalResource	ExternalResource	Külső forrás hivatkozás az akcióhoz.
name	string pattern: ^[a-zA-Z0-9-_]+$	Egyedi név az akciónak.
parameters	KeyValuePair[]	Művelet-specifikus paraméterértékek.
runAfter	RunAfter	Olyan műveletfüggőségek, amelyek szabályozzák, mikor kezdődik ez az akció.
timeout	string	ISO 8601 időtartam a maximális műveletvégrehajtási időhöz. Támogatja a sablon makroszintaxist.
waitBefore	string	ISO 8601 időtartam a cselekvés kezdete előtt várni (pl. PT30S 30 másodpercig). Támogatja a sablon makroszintaxist.

ScenarioParameter

Tárgy

Olyan modell, amely egyetlen forgatókönyvparaméter definíciót képvisel.

Name	Típus	Description
default	string	A paraméter alapértelmezett értéke.
description	string	A paraméter leírása.
name	string minLength: 1	A paraméter neve.
required	boolean	Hogy ez a paraméter szükséges-e.
type	ParameterType	Paraméter adattípus.

ScenarioProperties

Tárgy

Olyan modell, amely a forgatókönyv tulajdonságait képviseli.

Name	Típus	Description
actions	ScenarioAction[]	Olyan akciók sorozata, amelyek meghatározzák a forgatókönyv orkterizációját.
createdFrom	string	A sablonverzió erőforrásazonosítója, amelyből ez a forgatókönyv készült (opcionális).
description	string	Leírás arról, mit csinál ez a forgatókönyv (opcionális).
parameters	ScenarioParameter[]	Paraméterdefiníciók a forgatókönyvhez.
provisioningState	ProvisioningState	A megadott forgatókönyv erőforrás legfrissebb provisioning állapota.
recommendation	Recommendation	A javaslati információk erre a helyzetre.
version	string	A forgatókönyv változata.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.