az chaos workspace

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 workspace command. Learn more about extensions.

Manage Chaos Studio workspaces.

Workspaces are the top-level resource for Chaos Studio v2. They define the scope of resources that can be targeted by chaos scenarios and the managed identity used for fault injection.

Commands

Name Description Type Status
az chaos workspace create

Create a Workspace resource.

Extension Preview
az chaos workspace delete

Delete a Workspace resource.

Extension Preview
az chaos workspace evaluate-scenarios

Refreshes recommendation status for all scenarios in a given workspace.

Extension Preview
az chaos workspace identity

Manage Identity.

Extension Preview
az chaos workspace identity assign

Assign the user or system managed identities.

Extension Preview
az chaos workspace identity remove

Remove the user or system managed identities.

Extension Preview
az chaos workspace identity show

Show the details of managed identities.

Extension Preview
az chaos workspace identity wait

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

Extension Preview
az chaos workspace list

List a list of all Workspace resources in a subscription.

Extension Preview
az chaos workspace refresh-recommendation

Refreshes recommendation status for all scenarios in a given workspace.

Extension Preview
az chaos workspace show

Get a Workspace resource.

Extension Preview
az chaos workspace show-discovery

Get the latest resource-discovery result for a workspace.

Extension GA
az chaos workspace show-evaluation

Get the latest scenario-evaluation result for a workspace.

Extension GA
az chaos workspace update

Update a Workspace resource.

Extension Preview
az chaos workspace wait

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

Extension GA

az chaos workspace create

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Workspace resource.

az chaos workspace create --name --workspace-name
                          --resource-group
                          --scopes
                          [--acquire-policy-token]
                          [--change-reference]
                          [--location]
                          [--mi-system-assigned --system-assigned]
                          [--mi-user-assigned --user-assigned]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--tags]

Examples

Create or update a Workspace.

az chaos workspace create --resource-group exampleRG --workspace-name exampleWorkspace --location eastus --scopes /subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG --tags '{key1:value1,key2:value2}'

Create or update a Workspace with a user-assigned managed identity.

az chaos workspace create --resource-group exampleRG --workspace-name exampleWorkspace --location eastus --mi-user-assigned /subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/exampleIdentity --scopes /subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG

Required Parameters

--name --workspace-name -n

String that represents a Workspace resource name.

--resource-group -g

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

--scopes

The intended workspace-level resource scope to be used by child scenarios. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments

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
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--mi-system-assigned --system-assigned

Set the system managed identity.

Property Value
Parameter group: Identity Arguments
--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity 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
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource 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 workspace delete

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Workspace resource.

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

Examples

Delete a Workspace in a resource group.

az chaos workspace delete --resource-group exampleRG --workspace-name exampleWorkspace

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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
--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 workspace evaluate-scenarios

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Refreshes recommendation status for all scenarios in a given workspace.

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

Examples

Refresh recommendations for all scenarios in a workspace.

az chaos workspace refresh-recommendation --resource-group exampleRG --workspace-name exampleWorkspace

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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
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 workspace list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List a list of all Workspace resources in a subscription.

az chaos workspace list [--continuation-token]
                        [--max-items]
                        [--next-token]
                        [--resource-group]

Examples

List Workspaces in a resource group.

az chaos workspace list --resource-group exampleRG

List all Workspaces in a subscription.

az chaos workspace list

Optional Parameters

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

--continuation-token

String that sets the continuation token.

--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
--resource-group -g

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

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 workspace refresh-recommendation

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Refreshes recommendation status for all scenarios in a given workspace.

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

Examples

Refresh recommendations for all scenarios in a workspace.

az chaos workspace refresh-recommendation --resource-group exampleRG --workspace-name exampleWorkspace

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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
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 workspace show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Workspace resource.

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

Examples

Get a Workspace in a resource group.

az chaos workspace show --resource-group exampleRG --workspace-name exampleWorkspace

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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
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 workspace show-discovery

Get the latest resource-discovery result for a workspace.

Retrieves the latest workspace-scope resource-discovery operation result. Returns the discovery operation's state (in-progress, succeeded, failed) and any failure details. This is a read-only GET — it does NOT trigger a new discovery. Use 'az chaos workspace refresh-recommendation' to trigger a new discovery scan.

az chaos workspace show-discovery --name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]

Examples

Show the latest discovery result

az chaos workspace show-discovery --name MyWorkspace --resource-group MyRG

Show discovery result with JSON output

az chaos workspace show-discovery --name MyWorkspace --resource-group MyRG --output json

Required Parameters

--name -n

Name of the Chaos Studio workspace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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
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 workspace show-evaluation

Get the latest scenario-evaluation result for a workspace.

Retrieves the latest workspace scenario-evaluation operation result. Returns the evaluation state — useful for checking whether the workspace has been evaluated (a prerequisite for 'scenario config validate' and 'scenario run start' on catalog scenarios). This is a read-only GET — it does NOT trigger a new evaluation. Use 'az chaos workspace refresh-recommendation' to trigger evaluation.

az chaos workspace show-evaluation --name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

Examples

Show the latest evaluation result

az chaos workspace show-evaluation --name MyWorkspace --resource-group MyRG

Show evaluation result with JSON output

az chaos workspace show-evaluation --name MyWorkspace --resource-group MyRG --output json

Required Parameters

--name -n

Name of the Chaos Studio workspace.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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
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 workspace update

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Workspace resource.

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

Examples

Create/update a workspace in a resource group.

az chaos workspace update --resource-group exampleRG --workspace-name exampleWorkspace

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
--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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
--scopes

The intended workspace-level resource scope to be used by child scenarios. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource 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 workspace wait

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

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

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 --workspace-name -n

String that represents a Workspace resource name.

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
--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
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