az chaos scenario config

Note

This reference is part of the chaos extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az chaos scenario config command. Learn more about extensions.

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage scenario configurations for a Chaos Studio scenario.

Scenario configurations define the steps, branches, and fault parameters for a chaos experiment run. Use 'validate' to check a configuration before execution and 'fix-permissions' to grant the required RBAC roles.

Commands

Name	Description	Type	Status
az chaos scenario config create	Create a scenario definition.	Extension	Preview
az chaos scenario config delete	Delete a scenario definition.	Extension	Preview
az chaos scenario config execute	Execute the scenario execution with the given scenario configuration.	Extension	Preview
az chaos scenario config fix-permissions	Fix RBAC permissions for a scenario configuration.	Extension	Preview
az chaos scenario config list	List a list of scenario definitions.	Extension	Preview
az chaos scenario config show	Get a scenario definition.	Extension	Preview
az chaos scenario config show-permission-fix	Get the latest permission-fix result for a scenario configuration.	Extension	Preview
az chaos scenario config show-validation	Get the latest validation result for a scenario configuration.	Extension	Preview
az chaos scenario config update	Update a scenario definition.	Extension	Preview
az chaos scenario config validate	Validate a scenario configuration.	Extension	Preview
az chaos scenario config wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az chaos scenario config create

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a scenario definition.

az chaos scenario config create --name --scenario-configuration-name
                                --resource-group
                                --scenario-name
                                --workspace-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--exclusions]
                                [--filters]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--parameters]
                                [--scenario-id]

Examples

Create or update a scenario configuration with physical zone targeting.

az chaos scenario config create --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config --exclusions "{resources:[/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/protectedVM]}" --parameters "[{key:duration,value:PT10M}]" --filters "{locations:[westus2],physical-zones:[westus2-az1]}"

Create or update a scenario configuration with availability zone targeting.

az chaos scenario config create --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config --filters "{locations:[eastus],zones:[1]}" --parameters "[{key:duration,value:PT10M}]"

Required Parameters

--name --scenario-configuration-name -n

Name of the scenario definition.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the scenario.

--workspace-name

String that represents a Workspace resource name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--exclusions

Exclusion criteria for protecting resources from fault injection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--filters

Filter criteria used to constrain which discovered resources participate in fault injection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--parameters

Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--scenario-id

Resource ID of the scenario this configuration applies to.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config delete

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a scenario definition.

az chaos scenario config delete [--acquire-policy-token]
                                [--change-reference]
                                [--ids]
                                [--name --scenario-configuration-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--scenario-name]
                                [--subscription]
                                [--workspace-name]
                                [--yes]

Examples

Delete a scenario configuration.

az chaos scenario config delete --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --scenario-configuration-name -n

Name of the scenario definition.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scenario-name

Name of the scenario.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

String that represents a Workspace resource name.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config execute

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Execute the scenario execution with the given scenario configuration.

az chaos scenario config execute [--acquire-policy-token]
                                 [--change-reference]
                                 [--ids]
                                 [--name --scenario-configuration-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--scenario-name]
                                 [--subscription]
                                 [--workspace-name]

Examples

Execute the scenario execution with the given scenario configuration.

az chaos scenario config execute --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --scenario-configuration-name -n

Name of the scenario definition.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scenario-name

Name of the scenario.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

String that represents a Workspace resource name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config fix-permissions

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Fix RBAC permissions for a scenario configuration.

Assigns the RBAC roles required for the configuration's targeted resources. The operation runs its own internal validation before fixing permissions, so a prior 'az chaos scenario config validate' call is NOT required. However, the workspace, scenario, and configuration must all exist; a 404 NotFound typically means one of these resources is missing or the workspace has not finished provisioning. Use --what-if for a server-side dry-run that returns the role assignments that would be made without actually creating them. Note that --what-if is server-evaluated (not client-only like PowerShell's -WhatIf) and the response shape is the same PermissionsFix resource regardless of mode.

az chaos scenario config fix-permissions --name
                                         --resource-group
                                         --scenario-name
                                         --workspace-name
                                         [--acquire-policy-token]
                                         [--change-reference]
                                         [--no-wait]
                                         [--what-if]

Examples

Fix permissions for a configuration

az chaos scenario config fix-permissions --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1

Preview what permissions would be assigned (what-if mode)

az chaos scenario config fix-permissions --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1 --what-if

Required Parameters

--name -n

Name of the scenario configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the parent scenario.

--workspace-name

Name of the parent Chaos Studio workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--what-if

Submit a server-side dry run that reports the role assignments that would be made, without actually creating them.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config list

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a list of scenario definitions.

az chaos scenario config list --resource-group
                              --scenario-name
                              --workspace-name
                              [--max-items]
                              [--next-token]

Examples

List scenario configurations under a scenario.

az chaos scenario config list --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the scenario.

--workspace-name

String that represents a Workspace resource name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config show

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a scenario definition.

az chaos scenario config show [--ids]
                              [--name --scenario-configuration-name]
                              [--resource-group]
                              [--scenario-name]
                              [--subscription]
                              [--workspace-name]

Examples

Get a scenario configuration.

az chaos scenario config show --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 -n my-config

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --scenario-configuration-name -n

Name of the scenario definition.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scenario-name

Name of the scenario.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

String that represents a Workspace resource name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config show-permission-fix

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the latest permission-fix result for a scenario configuration.

Retrieves the most recent permission-fix result. This is a read-only GET — it does NOT trigger a new fix. The response body carries 'properties.whatIfMode' indicating whether the latest fix was a what-if dry run or an actual fix; the singleton returns whichever was most recently submitted. Use 'az chaos scenario config fix-permissions' to trigger a new fix (with optional --what-if for a server-side dry run).

az chaos scenario config show-permission-fix --name
                                             --resource-group
                                             --scenario-name
                                             --workspace-name
                                             [--acquire-policy-token]
                                             [--change-reference]

Examples

Show the latest permission-fix result

az chaos scenario config show-permission-fix --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1

Show the latest permission-fix result with JSON output

az chaos scenario config show-permission-fix --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1 --output json

Required Parameters

--name -n

Name of the scenario configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the parent scenario.

--workspace-name

Name of the parent Chaos Studio workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config show-validation

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the latest validation result for a scenario configuration.

Retrieves the most recent validation result for a scenario configuration. This is a read-only GET — it does NOT trigger a new validation. Use 'az chaos scenario config validate' to submit a new validation request.

az chaos scenario config show-validation --name
                                         --resource-group
                                         --scenario-name
                                         --workspace-name
                                         [--acquire-policy-token]
                                         [--change-reference]

Examples

Show the latest validation result

az chaos scenario config show-validation --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1

Show validation result with JSON output

az chaos scenario config show-validation --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1 --output json

Required Parameters

--name -n

Name of the scenario configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the parent scenario.

--workspace-name

Name of the parent Chaos Studio workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config update

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a scenario definition.

az chaos scenario config update [--acquire-policy-token]
                                [--add]
                                [--change-reference]
                                [--exclusions]
                                [--filters]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--name --scenario-configuration-name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--parameters]
                                [--remove]
                                [--resource-group]
                                [--scenario-id]
                                [--scenario-name]
                                [--set]
                                [--subscription]
                                [--workspace-name]

Examples

Update a scenario configuration.

az chaos scenario config update --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--exclusions

Exclusion criteria for protecting resources from fault injection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--filters

Filter criteria used to constrain which discovered resources participate in fault injection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --scenario-configuration-name -n

Name of the scenario definition.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--parameters

Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scenario-id

Resource ID of the scenario this configuration applies to.

Property	Value
Parameter group:	Properties Arguments

--scenario-name

Name of the scenario.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--workspace-name

String that represents a Workspace resource name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config validate

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Validate a scenario configuration.

Submits a validation request for a scenario configuration and, by default, waits for the validation to complete and auto-fetches the validation result.

With --no-wait, the command submits the validation and returns immediately. Use 'az chaos scenario config show-validation' to retrieve the result once the operation completes.

For non-custom (catalog) scenarios, the workspace must be evaluated before validation can succeed. If the workspace has not been evaluated, the command will fail with a hint to run 'az chaos workspace refresh-recommendation'.

az chaos scenario config validate --name
                                  --resource-group
                                  --scenario-name
                                  --workspace-name
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--no-wait]

Examples

Validate a scenario configuration and display results

az chaos scenario config validate --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1

Submit validation without waiting (use 'show-validation' to fetch the result later)

az chaos scenario config validate --workspace-name MyWorkspace --resource-group MyRG --scenario-name ZoneDown-1.0 --name zone1 --no-wait

Required Parameters

--name -n

Name of the scenario configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--scenario-name

Name of the parent scenario.

--workspace-name

Name of the parent Chaos Studio workspace.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az chaos scenario config wait

Preview

Command group 'az chaos scenario' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az chaos scenario config wait [--acquire-policy-token]
                              [--change-reference]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--name --scenario-configuration-name]
                              [--resource-group]
                              [--scenario-name]
                              [--subscription]
                              [--timeout]
                              [--updated]
                              [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --scenario-configuration-name -n

Name of the scenario definition.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--scenario-name

Name of the scenario.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--workspace-name

String that represents a Workspace resource name.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False