capabilities

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

Overview

Name	capabilities
Type	Resource
Id	azure.chaos.capabilities

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.
description	string	Localized string of the description.
parametersSchema	string	URL to retrieve JSON schema of the Capability parameters.
provisioningState	string	Resource provisioning state. Not currently in use because resource is created synchronously. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
publisher	string	String of the Publisher that this Capability extends.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetType	string	String of the Target Type that this Capability 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.
description	string	Localized string of the description.
parametersSchema	string	URL to retrieve JSON schema of the Capability parameters.
provisioningState	string	Resource provisioning state. Not currently in use because resource is created synchronously. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
publisher	string	String of the Publisher that this Capability extends.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetType	string	String of the Target Type that this Capability 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	resource_group_name, parent_provider_namespace, parent_resource_type, parent_resource_name, target_name, capability_name, subscription_id		Get a Capability resource that extends a Target resource.
list	select	resource_group_name, parent_provider_namespace, parent_resource_type, parent_resource_name, target_name, subscription_id	continuationToken	Get a list of Capability resources that extend a Target resource.
create_or_update	insert	resource_group_name, parent_provider_namespace, parent_resource_type, parent_resource_name, target_name, capability_name, subscription_id		Create or update a Capability resource that extends a Target resource.
create_or_update	replace	resource_group_name, parent_provider_namespace, parent_resource_type, parent_resource_name, target_name, capability_name, subscription_id		Create or update a Capability resource that extends a Target resource.
delete	delete	resource_group_name, parent_provider_namespace, parent_resource_type, parent_resource_name, target_name, capability_name, subscription_id		Delete a Capability that extends a Target resource.

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_name	string	String that represents a Capability resource name. Required.
parent_provider_namespace	string	The parent resource provider namespace. Required.
parent_resource_name	string	The parent resource name. Required.
parent_resource_type	string	The parent resource type. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
target_name	string	String that represents a Target resource name. Required.
continuationToken	string	String that sets the continuation token. Default value is None.

SELECT examples

get

Get a Capability resource that extends a Target resource.

SELECT
id,
name,
description,
parametersSchema,
provisioningState,
publisher,
systemData,
targetType,
type,
urn
FROM azure.chaos.capabilities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_provider_namespace = '{{ parent_provider_namespace }}' -- required
AND parent_resource_type = '{{ parent_resource_type }}' -- required
AND parent_resource_name = '{{ parent_resource_name }}' -- required
AND target_name = '{{ target_name }}' -- required
AND capability_name = '{{ capability_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get a list of Capability resources that extend a Target resource.

SELECT
id,
name,
description,
parametersSchema,
provisioningState,
publisher,
systemData,
targetType,
type,
urn
FROM azure.chaos.capabilities
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND parent_provider_namespace = '{{ parent_provider_namespace }}' -- required
AND parent_resource_type = '{{ parent_resource_type }}' -- required
AND parent_resource_name = '{{ parent_resource_name }}' -- required
AND target_name = '{{ target_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

INSERT examples

create_or_update

Create or update a Capability resource that extends a Target resource.

INSERT INTO azure.chaos.capabilities (
properties,
resource_group_name,
parent_provider_namespace,
parent_resource_type,
parent_resource_name,
target_name,
capability_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ parent_provider_namespace }}',
'{{ parent_resource_type }}',
'{{ parent_resource_name }}',
'{{ target_name }}',
'{{ capability_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: capabilities
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the capabilities resource.
  - name: parent_provider_namespace
    value: "{{ parent_provider_namespace }}"
    description: Required parameter for the capabilities resource.
  - name: parent_resource_type
    value: "{{ parent_resource_type }}"
    description: Required parameter for the capabilities resource.
  - name: parent_resource_name
    value: "{{ parent_resource_name }}"
    description: Required parameter for the capabilities resource.
  - name: target_name
    value: "{{ target_name }}"
    description: Required parameter for the capabilities resource.
  - name: capability_name
    value: "{{ capability_name }}"
    description: Required parameter for the capabilities resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the capabilities resource.
  - name: properties
    description: |
      The properties of a capability resource.
    value:
      publisher: "{{ publisher }}"
      targetType: "{{ targetType }}"
      description: "{{ description }}"
      parametersSchema: "{{ parametersSchema }}"
      urn: "{{ urn }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create or update a Capability resource that extends a Target resource.

REPLACE azure.chaos.capabilities
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND parent_provider_namespace = '{{ parent_provider_namespace }}' --required
AND parent_resource_type = '{{ parent_resource_type }}' --required
AND parent_resource_name = '{{ parent_resource_name }}' --required
AND target_name = '{{ target_name }}' --required
AND capability_name = '{{ capability_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Capability that extends a Target resource.

DELETE FROM azure.chaos.capabilities
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND parent_provider_namespace = '{{ parent_provider_namespace }}' --required
AND parent_resource_type = '{{ parent_resource_type }}' --required
AND parent_resource_name = '{{ parent_resource_name }}' --required
AND target_name = '{{ target_name }}' --required
AND capability_name = '{{ capability_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;