Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/chaos/discovered-resource/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos discovered-resource list_

List a list of discovered resources for a workspace.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L2Rpc2NvdmVyZWRyZXNvdXJjZXM=/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/discoveredresources 2026-05-01-preview -->

#### examples

- List discovered resources for a workspace.
```bash
chaos discovered-resource list --resource-group exampleRG --workspace-name exampleWorkspace
```
16 changes: 16 additions & 0 deletions Commands/chaos/discovered-resource/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos discovered-resource show_

Get a discovered resource.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L2Rpc2NvdmVyZWRyZXNvdXJjZXMve30=/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/discoveredresources/{} 2026-05-01-preview -->

#### examples

- Get a discovered resource.
```bash
chaos discovered-resource show --resource-group exampleRG --workspace-name exampleWorkspace --discovered-resource-name a1b2c3d4-e5f6-7890-abcd-ef1234567890
```
13 changes: 13 additions & 0 deletions Commands/chaos/discovered-resource/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# [Group] _chaos discovered-resource_

Browse discovered resources in a Chaos Studio workspace.

Discovered resources are populated by workspace discovery scans (triggered via 'az chaos workspace refresh-recommendation'). Use 'list' to see all discovered resources and 'show' to inspect a specific one.

## Commands

- [list](/Commands/chaos/discovered-resource/_list.md)
: List a list of discovered resources for a workspace.

- [show](/Commands/chaos/discovered-resource/_show.md)
: Get a discovered resource.
16 changes: 16 additions & 0 deletions Commands/chaos/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Group] _chaos_

Manage Azure Chaos Studio resources.

Create and manage Chaos Studio v2 workspaces, scenarios, scenario configurations, and runs for chaos engineering experiments.

## Subgroups

- [discovered-resource](/Commands/chaos/discovered-resource/readme.md)
: Browse discovered resources in a Chaos Studio workspace.

- [scenario](/Commands/chaos/scenario/readme.md)
: Manage Chaos Studio scenarios within a workspace.

- [workspace](/Commands/chaos/workspace/readme.md)
: Manage Chaos Studio workspaces.
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario create_

Create a scenario.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{} 2026-05-01-preview -->

#### examples

- Create or update a scenario.
```bash
chaos scenario create --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name zoneDownScenario --description 'Induces an outage of all discovered VM and VMSS instances in the target zone.' --parameters "[{name:duration,type:string,default:PT15M,required:False,description:'The duration of the outage scenario.'}]" --actions "[{name:vmZoneDown,action-id:'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}%%'}]}]"
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario delete_

Delete a scenario.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{} 2026-05-01-preview -->

#### examples

- Delete a scenario in a workspace.
```bash
chaos scenario delete --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name myScenario
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario list_

List a list of scenarios.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcw==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios 2026-05-01-preview -->

#### examples

- List scenarios in a workspace.
```bash
chaos scenario list --resource-group exampleRG --workspace-name exampleWorkspace
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario show_

Get a scenario.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{} 2026-05-01-preview -->

#### examples

- Get a scenario.
```bash
chaos scenario show --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name zoneDownScenario
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario update_

Update a scenario.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{} 2026-05-01-preview -->

#### examples

- Update a scenario.
```bash
chaos scenario update --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name zoneDownScenario
```
21 changes: 21 additions & 0 deletions Commands/chaos/scenario/config/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _chaos scenario config create_

Create a scenario definition.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{} 2026-05-01-preview -->

#### examples

- Create or update a scenario configuration with physical zone targeting.
```bash
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.
```bash
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}]"
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config delete_

Delete a scenario definition.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{} 2026-05-01-preview -->

#### examples

- Delete a scenario configuration.
```bash
chaos scenario config delete --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_execute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config execute_

Execute the scenario execution with the given scenario configuration.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fS9leGVjdXRl/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{}/execute 2026-05-01-preview -->

#### examples

- Execute the scenario execution with the given scenario configuration.
```bash
chaos scenario config execute --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_fix-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config fix-permissions_

Fixes resource permissions for the given scenario configuration.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fS9maXhyZXNvdXJjZXBlcm1pc3Npb25z/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{}/fixresourcepermissions 2026-05-01-preview -->

#### examples

- Fix resource permissions required to run a scenario configuration.
```bash
chaos scenario config fix-permissions --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 -n my-config
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config list_

List a list of scenario definitions.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucw==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations 2026-05-01-preview -->

#### examples

- List scenario configurations under a scenario.
```bash
chaos scenario config list --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config show_

Get a scenario definition.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{} 2026-05-01-preview -->

#### examples

- Get a scenario configuration.
```bash
chaos scenario config show --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 -n my-config
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config update_

Update a scenario definition.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{} 2026-05-01-preview -->

#### examples

- Update a scenario configuration.
```bash
chaos scenario config update --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/config/_validate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario config validate_

Validate the given scenario configuration.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9jb25maWd1cmF0aW9ucy97fS92YWxpZGF0ZQ==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/configurations/{}/validate 2026-05-01-preview -->

#### examples

- Validate a scenario configuration.
```bash
chaos scenario config validate --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --name my-config
```
31 changes: 31 additions & 0 deletions Commands/chaos/scenario/config/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# [Group] _chaos scenario config_

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

- [create](/Commands/chaos/scenario/config/_create.md)
: Create a scenario definition.

- [delete](/Commands/chaos/scenario/config/_delete.md)
: Delete a scenario definition.

- [execute](/Commands/chaos/scenario/config/_execute.md)
: Execute the scenario execution with the given scenario configuration.

- [fix-permissions](/Commands/chaos/scenario/config/_fix-permissions.md)
: Fixes resource permissions for the given scenario configuration.

- [list](/Commands/chaos/scenario/config/_list.md)
: List a list of scenario definitions.

- [show](/Commands/chaos/scenario/config/_show.md)
: Get a scenario definition.

- [update](/Commands/chaos/scenario/config/_update.md)
: Update a scenario definition.

- [validate](/Commands/chaos/scenario/config/_validate.md)
: Validate the given scenario configuration.
30 changes: 30 additions & 0 deletions Commands/chaos/scenario/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [Group] _chaos scenario_

Manage Chaos Studio scenarios within a workspace.

Scenarios define the fault-injection actions available in a workspace. Catalog scenarios are populated by workspace evaluation (see 'az chaos workspace refresh-recommendation'); custom scenarios can be created directly.

## Subgroups

- [config](/Commands/chaos/scenario/config/readme.md)
: Manage scenario configurations for a Chaos Studio scenario.

- [run](/Commands/chaos/scenario/run/readme.md)
: Manage scenario runs for a Chaos Studio scenario.

## Commands

- [create](/Commands/chaos/scenario/_create.md)
: Create a scenario.

- [delete](/Commands/chaos/scenario/_delete.md)
: Delete a scenario.

- [list](/Commands/chaos/scenario/_list.md)
: List a list of scenarios.

- [show](/Commands/chaos/scenario/_show.md)
: Get a scenario.

- [update](/Commands/chaos/scenario/_update.md)
: Update a scenario.
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/run/_cancel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario run cancel_

Cancel the currently running scenario execution.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9ydW5zL3t9L2NhbmNlbA==/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/runs/{}/cancel 2026-05-01-preview -->

#### examples

- Cancel a running scenario run.
```bash
chaos scenario run cancel --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0 --run-id abcd1234-5678-9012-3456-789012345678
```
16 changes: 16 additions & 0 deletions Commands/chaos/scenario/run/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _chaos scenario run list_

List a list of scenario runs.

## Versions

### [2026-05-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFvcy93b3Jrc3BhY2VzL3t9L3NjZW5hcmlvcy97fS9ydW5z/2026-05-01-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.chaos/workspaces/{}/scenarios/{}/runs 2026-05-01-preview -->

#### examples

- List scenario runs under a scenario.
```bash
chaos scenario run list --resource-group exampleRG --workspace-name exampleWorkspace --scenario-name ZoneDown-1.0
```
Loading
Loading