Microsoft.DocumentDB databaseAccounts/chaosFaults 2024-12-01-preview
Bicep resource definition
The databaseAccounts/chaosFaults 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.DocumentDB/databaseAccounts/chaosFaults resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/chaosFaults@2024-12-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
action: 'string'
containerName: 'string'
databaseName: 'string'
region: 'string'
}
}
Property values
ChaosFaultProperties
| Name | Description | Value |
|---|---|---|
| action | Indicates whether what action to take for the Chaos Fault. | 'Disable' 'Enable' |
| containerName | Container name. | string |
| databaseName | Database name. | string |
| region | Region of the account where the Chaos Fault is to be enabled/disabled. | string |
Microsoft.DocumentDB/databaseAccounts/chaosFaults
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (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: databaseAccounts |
| properties | A request object to enable/disable the chaos fault. | ChaosFaultProperties |
ARM template resource definition
The databaseAccounts/chaosFaults 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.DocumentDB/databaseAccounts/chaosFaults resource, add the following JSON to your template.
{
"type": "Microsoft.DocumentDB/databaseAccounts/chaosFaults",
"apiVersion": "2024-12-01-preview",
"name": "string",
"properties": {
"action": "string",
"containerName": "string",
"databaseName": "string",
"region": "string"
}
}
Property values
ChaosFaultProperties
| Name | Description | Value |
|---|---|---|
| action | Indicates whether what action to take for the Chaos Fault. | 'Disable' 'Enable' |
| containerName | Container name. | string |
| databaseName | Database name. | string |
| region | Region of the account where the Chaos Fault is to be enabled/disabled. | string |
Microsoft.DocumentDB/databaseAccounts/chaosFaults
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01-preview' |
| name | The resource name | string (required) |
| properties | A request object to enable/disable the chaos fault. | ChaosFaultProperties |
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/chaosFaults' |
Terraform (AzAPI provider) resource definition
The databaseAccounts/chaosFaults 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.DocumentDB/databaseAccounts/chaosFaults resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/chaosFaults@2024-12-01-preview"
name = "string"
body = jsonencode({
properties = {
action = "string"
containerName = "string"
databaseName = "string"
region = "string"
}
})
}
Property values
ChaosFaultProperties
| Name | Description | Value |
|---|---|---|
| action | Indicates whether what action to take for the Chaos Fault. | 'Disable' 'Enable' |
| containerName | Container name. | string |
| databaseName | Database name. | string |
| region | Region of the account where the Chaos Fault is to be enabled/disabled. | string |
Microsoft.DocumentDB/databaseAccounts/chaosFaults
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: databaseAccounts |
| properties | A request object to enable/disable the chaos fault. | ChaosFaultProperties |
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/chaosFaults@2024-12-01-preview" |