goal_templates

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

Overview

Name	goal_templates
Type	Resource
Id	azure.resilience_management.goal_templates

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.
errorDetails	object	Details of any errors encountered during the operation.
goalType	string	Type of Goal Template created by customer. Required. "Resiliency" (Resiliency)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
regionalRecoveryPointObjective	string	Regional recovery point objective specified by customer. eg, PT15M for 15 minutes.
regionalRecoveryTimeObjective	string	Regional recovery time objective specified by customer. eg, PT15M for 15 minutes.
requireDisasterRecovery	string	Option specified by customer under disaster recovery section of goal template. Known values are: "NotRequired" and "Required". (NotRequired, Required)
requireHighAvailability	string	Option specified by customer under high availability section of goal template. Known values are: "NotRequired" and "Required". (NotRequired, Required)
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".

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.
errorDetails	object	Details of any errors encountered during the operation.
goalType	string	Type of Goal Template created by customer. Required. "Resiliency" (Resiliency)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
regionalRecoveryPointObjective	string	Regional recovery point objective specified by customer. eg, PT15M for 15 minutes.
regionalRecoveryTimeObjective	string	Regional recovery time objective specified by customer. eg, PT15M for 15 minutes.
requireDisasterRecovery	string	Option specified by customer under disaster recovery section of goal template. Known values are: "NotRequired" and "Required". (NotRequired, Required)
requireHighAvailability	string	Option specified by customer under high availability section of goal template. Known values are: "NotRequired" and "Required". (NotRequired, Required)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_group_name, goal_template_name		Get a GoalTemplate.
list	select	service_group_name	$skipToken, $top	List GoalTemplate resources by tenant.
create_or_update	insert	service_group_name, goal_template_name		Create a GoalTemplate.
update	update	service_group_name, goal_template_name		Update a GoalTemplate.
create_or_update	replace	service_group_name, goal_template_name		Create a GoalTemplate.
delete	delete	service_group_name, goal_template_name		Delete a GoalTemplate.

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
goal_template_name	string	The name of the goalTemplate. Required.
service_group_name	string	The name of the service group. Required.
$skipToken	string	Skip over when retrieving results. Default value is None.
$top	integer	Number of elements to return when retrieving results. Default value is None.

SELECT examples

get

Get a GoalTemplate.

SELECT
id,
name,
errorDetails,
goalType,
provisioningState,
regionalRecoveryPointObjective,
regionalRecoveryTimeObjective,
requireDisasterRecovery,
requireHighAvailability,
systemData,
type
FROM azure.resilience_management.goal_templates
WHERE service_group_name = '{{ service_group_name }}' -- required
AND goal_template_name = '{{ goal_template_name }}' -- required
;

list

List GoalTemplate resources by tenant.

SELECT
id,
name,
errorDetails,
goalType,
provisioningState,
regionalRecoveryPointObjective,
regionalRecoveryTimeObjective,
requireDisasterRecovery,
requireHighAvailability,
systemData,
type
FROM azure.resilience_management.goal_templates
WHERE service_group_name = '{{ service_group_name }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create a GoalTemplate.

INSERT INTO azure.resilience_management.goal_templates (
properties,
service_group_name,
goal_template_name
)
SELECT 
'{{ properties }}',
'{{ service_group_name }}',
'{{ goal_template_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: goal_templates
props:
  - name: service_group_name
    value: "{{ service_group_name }}"
    description: Required parameter for the goal_templates resource.
  - name: goal_template_name
    value: "{{ goal_template_name }}"
    description: Required parameter for the goal_templates resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      requireHighAvailability: "{{ requireHighAvailability }}"
      requireDisasterRecovery: "{{ requireDisasterRecovery }}"
      regionalRecoveryPointObjective: "{{ regionalRecoveryPointObjective }}"
      regionalRecoveryTimeObjective: "{{ regionalRecoveryTimeObjective }}"
      goalType: "{{ goalType }}"
      provisioningState: "{{ provisioningState }}"
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"

UPDATE examples

update

Update a GoalTemplate.

UPDATE azure.resilience_management.goal_templates
SET 
properties = '{{ properties }}'
WHERE 
service_group_name = '{{ service_group_name }}' --required
AND goal_template_name = '{{ goal_template_name }}' --required;

REPLACE examples

create_or_update

Create a GoalTemplate.

REPLACE azure.resilience_management.goal_templates
SET 
properties = '{{ properties }}'
WHERE 
service_group_name = '{{ service_group_name }}' --required
AND goal_template_name = '{{ goal_template_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a GoalTemplate.

DELETE FROM azure.resilience_management.goal_templates
WHERE service_group_name = '{{ service_group_name }}' --required
AND goal_template_name = '{{ goal_template_name }}' --required
;