capability_types

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

Overview

Name	capability_types
Type	Resource
Id	azure.chaos.capability_types

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.
azureRbacActions	array	Control plane actions necessary to execute capability type.
azureRbacDataActions	array	Data plane actions necessary to execute capability type.
description	string	Localized string of the description.
displayName	string	Localized string of the display name.
kind	string	String of the kind of this Capability Type.
parametersSchema	string	URL to retrieve JSON schema of the Capability Type parameters.
publisher	string	String of the Publisher that this Capability Type extends.
requiredAzureRoleDefinitionIds	array	Required Azure Role Definition Ids to execute capability type.
runtimeProperties	object	Runtime properties of this Capability Type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetType	string	String of the Target Type that this Capability Type extends.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
urn	string	String of the URN for this Capability Type.

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.
azureRbacActions	array	Control plane actions necessary to execute capability type.
azureRbacDataActions	array	Data plane actions necessary to execute capability type.
description	string	Localized string of the description.
displayName	string	Localized string of the display name.
kind	string	String of the kind of this Capability Type.
parametersSchema	string	URL to retrieve JSON schema of the Capability Type parameters.
publisher	string	String of the Publisher that this Capability Type extends.
requiredAzureRoleDefinitionIds	array	Required Azure Role Definition Ids to execute capability type.
runtimeProperties	object	Runtime properties of this Capability Type.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetType	string	String of the Target Type that this Capability Type extends.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
urn	string	String of the URN for this Capability Type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, target_type_name, capability_type_name, subscription_id		Get a Capability Type resource for given Target Type and location.
list	select	location, target_type_name, subscription_id	continuationToken	Get a list of Capability Type resources for given Target Type and 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
capability_type_name	string	String that represents a Capability Type resource name. Required.
location	string	The name of the Azure region. Required.
subscription_id	string
target_type_name	string	String that represents a Target Type resource name. Required.
continuationToken	string	String that sets the continuation token. Default value is None.

SELECT examples

get

Get a Capability Type resource for given Target Type and location.

SELECT
id,
name,
azureRbacActions,
azureRbacDataActions,
description,
displayName,
kind,
parametersSchema,
publisher,
requiredAzureRoleDefinitionIds,
runtimeProperties,
systemData,
targetType,
type,
urn
FROM azure.chaos.capability_types
WHERE location = '{{ location }}' -- required
AND target_type_name = '{{ target_type_name }}' -- required
AND capability_type_name = '{{ capability_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get a list of Capability Type resources for given Target Type and location.

SELECT
id,
name,
azureRbacActions,
azureRbacDataActions,
description,
displayName,
kind,
parametersSchema,
publisher,
requiredAzureRoleDefinitionIds,
runtimeProperties,
systemData,
targetType,
type,
urn
FROM azure.chaos.capability_types
WHERE location = '{{ location }}' -- required
AND target_type_name = '{{ target_type_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;