Microsoft.Chaos workspaces/scenarios/configurations

Bicep resource definition

The workspaces/scenarios/configurations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Chaos/workspaces/scenarios/configurations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Chaos/workspaces/scenarios/configurations@2026-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    exclusions: {
      resources: [
        'string'
      ]
      tags: [
        {
          key: 'string'
          value: 'string'
        }
      ]
      types: [
        'string'
      ]
    }
    filters: {
      locations: [
        'string'
      ]
      physicalZones: [
        'string'
      ]
      zones: [
        'string'
      ]
    }
    parameters: [
      {
        key: 'string'
        value: 'string'
      }
    ]
    scenarioId: 'string'
  }
}

Property Values

Microsoft.Chaos/workspaces/scenarios/configurations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Pattern = ^[^<>%&:?#/\\]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: workspaces/scenarios
properties The properties of scenario definition. ScenarioConfigurationProperties

ConfigurationExclusions

Name Description Value
resources Array of specific resource IDs to exclude from fault injection. string[]
tags Array of tag key-value pairs. Resources with matching tags are excluded. KeyValuePair[]
types Array of resource types. All resources of these types are excluded. string[]

ConfigurationFilters

Name Description Value
locations Array of Azure location strings. Only resources in these locations are included.

Null or omitted means all locations (no filter). Empty array means include nothing.
string[]
physicalZones Array of physical availability zone identifiers in {region}-az{N} format
(e.g., "westus2-az1"). Only resources in the corresponding logical zone
for each subscription are included.

At execution time, each physical zone is resolved to per-subscription
logical zones via the Azure locations API. The resolved mapping is surfaced
on the scenario run response (zoneResolution).

Null or omitted means physical zone targeting is not used.
Only one physical zone is supported in preview.

Mutually exclusive with zones — set one or the other, not both.
string[]
zones Array of availability zone identifiers ("1", "2", "3", "zone-redundant").
Only resources whose zones intersect this list are included.

Null or omitted means all zones (including non-zonal). Empty array means include nothing.

Mutually exclusive with physicalZones — set one or the other, not both.
string[]

KeyValuePair

Name Description Value
key The name of the setting for the action. string

Constraints:
Min length = 1 (required)
value The value of the setting for the action. string

Constraints:
Min length = 1 (required)

ScenarioConfigurationProperties

Name Description Value
exclusions Exclusion criteria for protecting resources from fault injection. ConfigurationExclusions
filters Filter criteria used to constrain which discovered resources participate in fault injection. ConfigurationFilters
parameters Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario. KeyValuePair[]
scenarioId Resource ID of the scenario this configuration applies to. string (required)

ARM template resource definition

The workspaces/scenarios/configurations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Chaos/workspaces/scenarios/configurations resource, add the following JSON to your template.

{
  "type": "Microsoft.Chaos/workspaces/scenarios/configurations",
  "apiVersion": "2026-05-01-preview",
  "name": "string",
  "properties": {
    "exclusions": {
      "resources": [ "string" ],
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "types": [ "string" ]
    },
    "filters": {
      "locations": [ "string" ],
      "physicalZones": [ "string" ],
      "zones": [ "string" ]
    },
    "parameters": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "scenarioId": "string"
  }
}

Property Values

Microsoft.Chaos/workspaces/scenarios/configurations

Name Description Value
apiVersion The api version '2026-05-01-preview'
name The resource name string

Constraints:
Min length = 1
Pattern = ^[^<>%&:?#/\\]+$ (required)
properties The properties of scenario definition. ScenarioConfigurationProperties
type The resource type 'Microsoft.Chaos/workspaces/scenarios/configurations'

ConfigurationExclusions

Name Description Value
resources Array of specific resource IDs to exclude from fault injection. string[]
tags Array of tag key-value pairs. Resources with matching tags are excluded. KeyValuePair[]
types Array of resource types. All resources of these types are excluded. string[]

ConfigurationFilters

Name Description Value
locations Array of Azure location strings. Only resources in these locations are included.

Null or omitted means all locations (no filter). Empty array means include nothing.
string[]
physicalZones Array of physical availability zone identifiers in {region}-az{N} format
(e.g., "westus2-az1"). Only resources in the corresponding logical zone
for each subscription are included.

At execution time, each physical zone is resolved to per-subscription
logical zones via the Azure locations API. The resolved mapping is surfaced
on the scenario run response (zoneResolution).

Null or omitted means physical zone targeting is not used.
Only one physical zone is supported in preview.

Mutually exclusive with zones — set one or the other, not both.
string[]
zones Array of availability zone identifiers ("1", "2", "3", "zone-redundant").
Only resources whose zones intersect this list are included.

Null or omitted means all zones (including non-zonal). Empty array means include nothing.

Mutually exclusive with physicalZones — set one or the other, not both.
string[]

KeyValuePair

Name Description Value
key The name of the setting for the action. string

Constraints:
Min length = 1 (required)
value The value of the setting for the action. string

Constraints:
Min length = 1 (required)

ScenarioConfigurationProperties

Name Description Value
exclusions Exclusion criteria for protecting resources from fault injection. ConfigurationExclusions
filters Filter criteria used to constrain which discovered resources participate in fault injection. ConfigurationFilters
parameters Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario. KeyValuePair[]
scenarioId Resource ID of the scenario this configuration applies to. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaces/scenarios/configurations resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Chaos/workspaces/scenarios/configurations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Chaos/workspaces/scenarios/configurations@2026-05-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      exclusions = {
        resources = [
          "string"
        ]
        tags = [
          {
            key = "string"
            value = "string"
          }
        ]
        types = [
          "string"
        ]
      }
      filters = {
        locations = [
          "string"
        ]
        physicalZones = [
          "string"
        ]
        zones = [
          "string"
        ]
      }
      parameters = [
        {
          key = "string"
          value = "string"
        }
      ]
      scenarioId = "string"
    }
  }
}

Property Values

Microsoft.Chaos/workspaces/scenarios/configurations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Pattern = ^[^<>%&:?#/\\]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces/scenarios
properties The properties of scenario definition. ScenarioConfigurationProperties
type The resource type "Microsoft.Chaos/workspaces/scenarios/configurations@2026-05-01-preview"

ConfigurationExclusions

Name Description Value
resources Array of specific resource IDs to exclude from fault injection. string[]
tags Array of tag key-value pairs. Resources with matching tags are excluded. KeyValuePair[]
types Array of resource types. All resources of these types are excluded. string[]

ConfigurationFilters

Name Description Value
locations Array of Azure location strings. Only resources in these locations are included.

Null or omitted means all locations (no filter). Empty array means include nothing.
string[]
physicalZones Array of physical availability zone identifiers in {region}-az{N} format
(e.g., "westus2-az1"). Only resources in the corresponding logical zone
for each subscription are included.

At execution time, each physical zone is resolved to per-subscription
logical zones via the Azure locations API. The resolved mapping is surfaced
on the scenario run response (zoneResolution).

Null or omitted means physical zone targeting is not used.
Only one physical zone is supported in preview.

Mutually exclusive with zones — set one or the other, not both.
string[]
zones Array of availability zone identifiers ("1", "2", "3", "zone-redundant").
Only resources whose zones intersect this list are included.

Null or omitted means all zones (including non-zonal). Empty array means include nothing.

Mutually exclusive with physicalZones — set one or the other, not both.
string[]

KeyValuePair

Name Description Value
key The name of the setting for the action. string

Constraints:
Min length = 1 (required)
value The value of the setting for the action. string

Constraints:
Min length = 1 (required)

ScenarioConfigurationProperties

Name Description Value
exclusions Exclusion criteria for protecting resources from fault injection. ConfigurationExclusions
filters Filter criteria used to constrain which discovered resources participate in fault injection. ConfigurationFilters
parameters Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario. KeyValuePair[]
scenarioId Resource ID of the scenario this configuration applies to. string (required)