Microsoft.Chaos experiments 2023-10-27-preview

Article
12/09/2024

Bicep resource definition

The experiments resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Chaos/experiments@2023-10-27-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    customerDataStorage: {
      blobContainerName: 'string'
      storageAccountResourceId: 'string'
    }
    selectors: [
      {
        filter: {
          type: 'string'
          // For remaining properties, see Filter objects
        }
        id: 'string'
        type: 'string'
        // For remaining properties, see Selector objects
      }
    ]
    steps: [
      {
        branches: [
          {
            actions: [
              {
                name: 'string'
                type: 'string'
                // For remaining properties, see Action objects
              }
            ]
            name: 'string'
          }
        ]
        name: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Filter objects

Set the type property to specify the type of object.

For Simple, use:

{
  parameters: {
    zones: [
      'string'
    ]
  }
  type: 'Simple'
}

Action objects

Set the type property to specify the type of object.

For continuous, use:

{
  duration: 'string'
  parameters: [
    {
      key: 'string'
      value: 'string'
    }
  ]
  selectorId: 'string'
  type: 'continuous'
}

For delay, use:

{
  duration: 'string'
  type: 'delay'
}

For discrete, use:

{
  parameters: [
    {
      key: 'string'
      value: 'string'
    }
  ]
  selectorId: 'string'
  type: 'discrete'
}

Selector objects

Set the type property to specify the type of object.

For List, use:

{
  targets: [
    {
      id: 'string'
      type: 'string'
    }
  ]
  type: 'List'
}

For Query, use:

{
  queryString: 'string'
  subscriptionIds: [
    'string'
  ]
  type: 'Query'
}

Property Values

Action

Name	Description	Value
name	String that represents a Capability URN.	string Constraints: Max length = 2048 (required)
type	Set to 'continuous' for type ContinuousAction. Set to 'delay' for type DelayAction. Set to 'discrete' for type DiscreteAction.	'continuous' 'delay' 'discrete' (required)

Branch

Name	Description	Value
actions	List of actions.	Action[] (required)
name	String of the branch name.	string Constraints: Min length = 1 (required)

ContinuousAction

Name	Description	Value
duration	ISO8601 formatted string that represents a duration.	string (required)
parameters	List of key value pairs.	KeyValuePair[] (required)
selectorId	String that represents a selector.	string Constraints: Min length = 1 (required)
type	Enum that discriminates between action models.	'continuous' (required)

CustomerDataStorageProperties

Name	Description	Value
blobContainerName	Name of the Azure Blob Storage container to use or create.	string Constraints: Min length = 3 Max length = 63 Pattern = `^[a-z0-9]([a-z0-9]\|(-(?!-))){1,61}[a-z0-9]$`
storageAccountResourceId	ARM Resource ID of the Storage account to use for Customer Data storage.	string

DelayAction

Name	Description	Value
duration	ISO8601 formatted string that represents a duration.	string (required)
type	Enum that discriminates between action models.	'delay' (required)

DiscreteAction

Name	Description	Value
parameters	List of key value pairs.	KeyValuePair[] (required)
selectorId	String that represents a selector.	string Constraints: Min length = 1 (required)
type	Enum that discriminates between action models.	'discrete' (required)

ExperimentProperties

Name	Description	Value
customerDataStorage	Optional customer-managed Storage account where Experiment schema will be stored.	CustomerDataStorageProperties
selectors	List of selectors.	Selector[] (required)
steps	List of steps.	Step[] (required)

Filter

Name	Description	Value
type	Set to 'Simple' for type SimpleFilter.	'Simple' (required)

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)

ListSelector

Name	Description	Value
targets	List of Target references.	TargetReference[] (required)
type	Enum of the selector type.	'List' (required)