actions

Creates, updates, deletes, gets or lists an actions resource.

Overview

Name	actions
Type	Resource
Id	azure.chaos.actions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
actionName	string	The short name of the action (e.g., "Shutdown").
actionType	string	The type of the action. Known values are: "Discrete", "Continuous", and "Cancelable". (Discrete, Continuous, Cancelable)
canonicalId	string	Canonical identifier of the action (e.g., "microsoft-compute-shutdown/1.0").
description	string	Description of what this action does.
displayName	string	Human-readable display name of the action.
parametersSchema	object	JSON Schema describing the parameters for this action.
recommendedRoles	array	Recommended Azure RBAC role definition GUIDs for this action.
supportedTargetTypes	array	List of target types supported by this action.
systemData	object	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".
version	string	The version of the action (e.g., "1.0.0").

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
actionName	string	The short name of the action (e.g., "Shutdown").
actionType	string	The type of the action. Known values are: "Discrete", "Continuous", and "Cancelable". (Discrete, Continuous, Cancelable)
canonicalId	string	Canonical identifier of the action (e.g., "microsoft-compute-shutdown/1.0").
description	string	Description of what this action does.
displayName	string	Human-readable display name of the action.
parametersSchema	object	JSON Schema describing the parameters for this action.
recommendedRoles	array	Recommended Azure RBAC role definition GUIDs for this action.
supportedTargetTypes	array	List of target types supported by this action.
systemData	object	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".
version	string	The version of the action (e.g., "1.0.0").

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, action_name, subscription_id		Get an Action resource for a given location.
list	select	location, subscription_id	continuationToken	Get a list of Action resources for a given location.

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
action_name	string	String that represents an Action resource name. Required.
location	string	The name of the Azure region. Required.
subscription_id	string
continuationToken	string	String that sets the continuation token. Default value is None.

SELECT examples

get

Get an Action resource for a given location.

SELECT
id,
name,
actionName,
actionType,
canonicalId,
description,
displayName,
parametersSchema,
recommendedRoles,
supportedTargetTypes,
systemData,
type,
version
FROM azure.chaos.actions
WHERE location = '{{ location }}' -- required
AND action_name = '{{ action_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get a list of Action resources for a given location.

SELECT
id,
name,
actionName,
actionType,
canonicalId,
description,
displayName,
parametersSchema,
recommendedRoles,
supportedTargetTypes,
systemData,
type,
version
FROM azure.chaos.actions
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;