你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Scenarios - Get

服务:: Chaos Studio

API 版本:: 2026-08-01-preview

找个情景。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
scenarioName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	场景名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
workspaceName	path	True	string minLength: 1 pattern: ^[^<>%&:?#/\\]+$	表示工作区资源名称的字符串。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	Scenario	Azure作已成功完成。
Other Status Codes	ErrorResponse	未预期的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	冒充您的用户账户

示例

Get a scenario.

示例请求

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

示例响应

状态代码:: 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"
  }
}

定义

名称	说明
ActionDependency	表示动作依赖的模型。
ActionDependencyType	用于动作依赖类型的枚举。
ActionLifecycle	行动生命周期的枚举状态。
createdByType	创建该资源的身份类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详情
ErrorResponse	错误响应
ExternalResource	表示外部资源引用的模型。
KeyValuePair	用于描述动作或配置参数的键值对。
ParameterType	参数类型枚举。
ProvisioningState	给定 Azure 混沌资源的当前预配状态。
Recommendation	代表情景推荐的模型。
RecommendationStatus	场景验证状态的枚举。
RunAfter	表示动作依赖的模型。
RunAfterBehavior	定义了如何评估多个依赖关系。
Scenario	代表该情景的模型。
ScenarioAction	代表情景动作的模型。
ScenarioParameter	表示单一场景参数定义的模型。
ScenarioProperties	表示情景属性的模型。
systemData	与创建和上次修改资源相关的元数据。

ActionDependency

对象

表示动作依赖的模型。

名称	类型	说明
name	string	这取决于具体的动作名称。
onActionLifecycle	ActionLifecycle	触发该动作启动的依赖动作的生命周期状态。
type	ActionDependencyType	依赖类型。

ActionDependencyType

枚举

用于动作依赖类型的枚举。

值	说明
Action	行动依赖类型。

ActionLifecycle

枚举

行动生命周期的枚举状态。

值	说明
AnyTerminal	当动作达到任何终端状态时触发。
Start	动作开始时触发。
Running	动作运行时触发。
Success	成功时触发。
Failure	失败时触发。
Skipped	跳过动作时触发。

createdByType

枚举

创建该资源的身份类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详情

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExternalResource

对象

表示外部资源引用的模型。

名称	类型	说明
resourceId	string (arm-id)	外部资源的资源ID。

KeyValuePair

对象

用于描述动作或配置参数的键值对。

名称	类型	说明
key	string minLength: 1	作的设置的名称。
value	string minLength: 1	作设置的值。

ParameterType

枚举

参数类型枚举。

值	说明
string	字符串参数类型。
number	数字参数类型。
boolean	布尔参数类型。
object	对象参数类型。
array	数组参数类型。

ProvisioningState

枚举

给定 Azure 混沌资源的当前预配状态。

值	说明
Succeeded	已创建资源。
Failed	资源创建失败。
Canceled	资源创建已取消。
Creating	初始创建正在进行中。
Updating	正在进行更新。
Deleting	正在删除。
Running	行动正在进行。

Recommendation

对象

代表情景推荐的模型。

名称	类型	说明
evaluationRunAt	string (date-time)	即推荐被评估的UTC时间。
recommendationStatus	RecommendationStatus	推荐状态。

RecommendationStatus

枚举

场景验证状态的枚举。

值	说明
NotEvaluated	情景推荐状态尚未评估。
Recommended	建议处于情景推荐状态。
NotApplicable	情景推荐状态不适用。
Evaluating	情景推荐状态目前正在评估中。
EvaluationFailed	情景推荐评估失败。
EvaluationCancelled	情景推荐评估被取消。

RunAfter

对象

表示动作依赖的模型。

名称	类型	默认值	说明
behavior	RunAfterBehavior	Any	定义了如何评估多个依赖关系。
items	ActionDependency[]		动作依赖的数列。

RunAfterBehavior

枚举

定义了如何评估多个依赖关系。

值	说明
Any	所有依赖之后（比如最终块）总是继续。
All	所有依赖关系必须满足才能继续。
AtLeastOne	至少必须满足一个依赖关系才能继续。

Scenario

对象

代表该情景的模型。

名称	类型	说明
id	string (arm-id)	该资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	ScenarioProperties	情景的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ScenarioAction

对象

代表情景动作的模型。

名称	类型	说明
actionId	string	动作标识符和版本（例如，“microsoft-compute-shutdown/1.0”）。
description	string	用人类易读的方式描述这个动作的作用。
duration	string	ISO 8601持续时间表示动作持续时间（例如，PT30M连续30分钟）。支持模板宏语法（%%{parameters.<姓名>}%%）。
externalResource	ExternalResource	动作的外部资源参考。
name	string pattern: ^[a-zA-Z0-9-_]+$	动作的独特名称。
parameters	KeyValuePair[]	动作特定的参数值。
runAfter	RunAfter	控制该动作何时开始的动作依赖关系。
timeout	string	ISO 8601 持续时间以实现最大动作执行时间。支持模板宏语法。
waitBefore	string	ISO 8601 等待时间为动作开始前的持续时间（例如 PT30S 30 秒）。支持模板宏语法。

ScenarioParameter

对象

表示单一场景参数定义的模型。

名称	类型	说明
default	string	参数的默认值。
description	string	参数的说明。
name	string minLength: 1	参数的名称。
required	boolean	是否需要该参数。
type	ParameterType	参数数据类型。

ScenarioProperties

对象

表示情景属性的模型。

名称	类型	说明
actions	ScenarioAction[]	一系列定义场景编排的动作。
createdFrom	string	本场景创建模板版本的资源ID（可选）。
description	string	描述该场景的作用（可选）。
parameters	ScenarioParameter[]	场景参数定义。
provisioningState	ProvisioningState	给定场景资源的最新配置状态。
recommendation	Recommendation	本情景的推荐信息。
version	string	情景的版本。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建该资源的身份。
createdByType	createdByType	创建该资源的身份类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。