chaos_faults

Creates, updates, deletes, gets or lists a chaos_faults resource.

Overview

Name	chaos_faults
Type	Resource
Id	azure.cosmos_db.chaos_faults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	A request object to enable/disable the chaos fault.

list

Name	Datatype	Description
properties	object	A request object to enable/disable the chaos fault.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, chaosFault		Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.
list	select	subscriptionId, resourceGroupName, accountName		List Chaos Faults for CosmosDB account.
enable_disable	exec	subscriptionId, resourceGroupName, accountName, chaosFault		Enable, disable Chaos Fault in a CosmosDB account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	Cosmos DB database account name.
chaosFault	string	The name of the ChaosFault.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get Chaos Fault for a CosmosdB account for a particular Chaos Fault.

SELECT
properties
FROM azure.cosmos_db.chaos_faults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND chaosFault = '{{ chaosFault }}' -- required
;

list

List Chaos Faults for CosmosDB account.

SELECT
properties
FROM azure.cosmos_db.chaos_faults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

Lifecycle Methods

enable_disable

Enable, disable Chaos Fault in a CosmosDB account.

EXEC azure.cosmos_db.chaos_faults.enable_disable 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@chaosFault='{{ chaosFault }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;