Chaos Fault - Enable Disable

Service:

Cosmos DB Resource Provider

API Version:

2025-05-01-preview

Enable, disable Chaos Fault in a CosmosDB account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/chaosFaults/{chaosFault}?api-version=2025-05-01-preview

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
chaosFault	path	True	string	The name of the ChaosFault.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
properties.action	SupportedActions	Indicates whether what action to take for the Chaos Fault.
properties.containerName	string	Container name.
properties.databaseName	string	Database name.
properties.region	string	Region of the account where the Chaos Fault is to be enabled/disabled.

Responses

Name	Type	Description
200 OK	chaosFaultResource	Success
201 Created	chaosFaultResource	Success
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

ChaosFaultEnableDisable

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/chaosFaults/ServiceUnavailability?api-version=2025-05-01-preview

{
  "properties": {
    "action": "Enable",
    "region": "EastUS",
    "databaseName": "testDatabase",
    "containerName": "testCollection"
  }
}

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/chaosFaults/ServiceUnavailability",
  "properties": {
    "provisioningState": "Completed",
    "action": "Enable",
    "region": "EastUS",
    "databaseName": "testDatabase",
    "containerName": "testCollection"
  }
}

Status code:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/chaosFaults/ServiceUnavailability",
  "properties": {
    "provisioningState": "Completed",
    "action": "Enable",
    "region": "EastUS",
    "databaseName": "testDatabase",
    "containerName": "testCollection"
  }
}

Definitions

Name	Description
chaosFaultResource	A request object to enable/disable the chaos fault
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SupportedActions	Indicates whether what action to take for the Chaos Fault.
systemData	Metadata pertaining to creation and last modification of the resource.

chaosFaultResource

Object

A request object to enable/disable the chaos fault

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.action	SupportedActions	Indicates whether what action to take for the Chaos Fault.
properties.containerName	string	Container name.
properties.databaseName	string	Database name.
properties.provisioningState	string	A provisioning state of the Chaos Fault.
properties.region	string	Region of the account where the Chaos Fault is to be enabled/disabled.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SupportedActions

Enumeration

Indicates whether what action to take for the Chaos Fault.

Value	Description
Enable
Disable

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.