Scenarios - Get

Serviço:
Chaos Studio
Versão da API:
2026-08-01-preview

Veja um cenário.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scenarioName
 path True

string

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

Nome do cenário.
subscriptionId
 path True

string (uuid)

O ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName
 path True

string

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

String que representa o nome de um recurso do Workspace.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

Scenario

A operação do Azure foi concluída com êxito.
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation se passar pela sua conta de usuário

Exemplos

Get a scenario.

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
  }
}

Definições

Nome Description
ActionDependency

Modelo que representa uma dependência de ação.
ActionDependencyType

Enum para tipo de dependência de ação.
ActionLifecycle

Enum para estados do ciclo de vida da ação.
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
ExternalResource

Modelo que representa uma referência externa de recursos.
KeyValuePair

Um par-chave-valor usado para descrever parâmetros de ações ou configurações.
ParameterType

Enum para tipos de parâmetros.
ProvisioningState

Estado atual de provisionamento para um dado recurso Azure Chaos.
Recommendation

Modelo que representa uma recomendação de cenário.
RecommendationStatus

Enum do estado de validação do cenário.
RunAfter

Modelo que representa dependências de ações.
RunAfterBehavior

Define como múltiplas dependências são avaliadas.
Scenario

Modelo que representa o cenário.
ScenarioAction

Modelo que representa uma ação de cenário.
ScenarioParameter

Modelo que representa a definição de um único cenário de parâmetro.
ScenarioProperties

Modelo que representa as propriedades do cenário.
systemData

Metadados relativos à criação e última modificação do recurso.

ActionDependency

Objeto

Modelo que representa uma dependência de ação.

Nome Tipo Description
name

string

O nome da ação depende disso.
onActionLifecycle

ActionLifecycle

O estado do ciclo de vida da ação de dependência que desencadeia essa ação para começar.
type

ActionDependencyType

O tipo de dependência.

ActionDependencyType

Enumeração

Enum para tipo de dependência de ação.

Valor Description
Action

Tipo de dependência de ação.

ActionLifecycle

Enumeração

Enum para estados do ciclo de vida da ação.

Valor Description
AnyTerminal

Dispare quando a ação atinge qualquer estado terminal.
Start

Acione quando a ação começa.
Running

Acione quando a ação estiver em andamento.
Success

Desencadeio ao ter sucesso.
Failure

Acione na falha.
Skipped

Dispare quando a ação for pulada.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O alvo do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ExternalResource

Objeto

Modelo que representa uma referência externa de recursos.

Nome Tipo Description
resourceId

string (arm-id)

O ID do recurso externo.

KeyValuePair

Objeto

Um par-chave-valor usado para descrever parâmetros de ações ou configurações.

Nome Tipo Description
key

string

minLength: 1

O nome da configuração da ação.
value

string

minLength: 1

O valor da configuração da ação.

ParameterType

Enumeração

Enum para tipos de parâmetros.

Valor Description
string

Tipo de parâmetro de string.
number

Tipo de parâmetro numérico.
boolean

Tipo de parâmetro booleano.
object

Tipo de parâmetro do objeto.
array

Tipo de parâmetro do array.

ProvisioningState

Enumeração

Estado atual de provisionamento para um dado recurso Azure Chaos.

Valor Description
Succeeded

O recurso foi criado.
Failed

Falha na criação de recursos.
Canceled

A criação de recursos foi cancelada.
Creating

Criação inicial em andamento.
Updating

Atualização em andamento.
Deleting

Exclusão em andamento.
Running

A ação está correndo.

Recommendation

Objeto

Modelo que representa uma recomendação de cenário.

Nome Tipo Description
evaluationRunAt

string (date-time)

O horário UTC em que a recomendação foi avaliada.
recommendationStatus

RecommendationStatus

O status da recomendação.

RecommendationStatus

Enumeração

Enum do estado de validação do cenário.

Valor Description
NotEvaluated

O status de recomendação do cenário não foi avaliado.
Recommended

O status de recomendação de cenário é recomendado.
NotApplicable

O status de recomendação de cenário não se aplica.
Evaluating

O status de recomendação de cenário está sendo avaliado atualmente.
EvaluationFailed

A avaliação de recomendação de cenários falhou.
EvaluationCancelled

A avaliação de recomendação de cenário foi cancelada.

RunAfter

Objeto

Modelo que representa dependências de ações.

Nome Tipo Valor padrão Description
behavior

RunAfterBehavior

Any

Define como múltiplas dependências são avaliadas.
items

ActionDependency[]

Conjunto de dependências de ações.

RunAfterBehavior

Enumeração

Define como múltiplas dependências são avaliadas.

Valor Description
Any

Sempre continua após todas as dependências (como um bloqueio final).
All

Todas as dependências devem ser satisfeitas para continuar.
AtLeastOne

Pelo menos uma dependência deve ser satisfeita para continuar.

Scenario

Objeto

Modelo que representa o cenário.

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

O nome do recurso
properties

ScenarioProperties

As propriedades do cenário.
systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScenarioAction

Objeto

Modelo que representa uma ação de cenário.

Nome Tipo Description
actionId

string

Identificador da ação e da versão (por exemplo, "microsoft-compute-shutdown/1.0").
description

string

Descrição legível para humanos do que essa ação faz.
duration

string

ISO 8601 duração para quanto tempo a ação dura (por exemplo, PT30M por 30 minutos). Suporta sintaxe de macros template (%%{parâmetros.<nome>}%%).
externalResource

ExternalResource

Referência externa de recurso para a ação.
name

string

pattern: ^[a-zA-Z0-9-_]+$

Nome único para a ação.
parameters

KeyValuePair[]

Valores de parâmetros específicos de ação.
runAfter

RunAfter

Dependências de ações que controlam quando essa ação começa.
timeout

string

ISO 8601 para o tempo máximo de execução da ação. Suporta sintaxe de macros de template.
waitBefore

string

ISO 8601 para esperar antes do início da ação (por exemplo, PT30S por 30 segundos). Suporta sintaxe de macros de template.

ScenarioParameter

Objeto

Modelo que representa a definição de um único cenário de parâmetro.

Nome Tipo Description
default

string

Valor padrão para o parâmetro.
description

string

Descrição do parâmetro.
name

string

minLength: 1

O nome do parâmetro.
required

boolean

Se esse parâmetro é necessário.
type

ParameterType

Tipo de dado de parâmetro.

ScenarioProperties

Objeto

Modelo que representa as propriedades do cenário.

Nome Tipo Description
actions

ScenarioAction[]

Conjunto de ações que definem a orquestração do cenário.
createdFrom

string

ID de recurso da versão modelo a partir da qual este cenário foi criado (opcional).
description

string

Descrição do que esse cenário faz (opcional).
parameters

ScenarioParameter[]

Definições de parâmetros para o cenário.
provisioningState

ProvisioningState

Estado de provisionamento mais recente para o recurso do cenário em questão.
recommendation

Recommendation

As informações de recomendação para esse cenário.
version

string

Versão do cenário.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O registro de data e hora da criação do recurso (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.