recovery_plans

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

Overview

Name	recovery_plans
Type	Resource
Id	azure.resilience_management.recovery_plans

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	Error details associated with the resource.
identity	object	The managed service identities assigned to this resource.
latestFailoverStatus	object	The status of the most recent failover operation executed.
latestValidationStatus	object	The status of the most recent validation performed.
planDescription	string	A description of the recovery orchestration plan. Required.
planState	string	The current state of the recovery orchestration plan. Known values are: "UnderEdit", "Warning", and "Ready". (UnderEdit, Warning, Ready)
planType	string	The type of the recovery orchestration plan, which can be set during creation but cannot be changed afterward. Required. Known values are: "Regional" and "Zonal". (Regional, Zonal)
provisioningState	string	The provisioning state of the recovery orchestration plan. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupsSetting	object	Settings for the recovery orchestration groups associated with the recovery orchestration plan. 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	Error details associated with the resource.
identity	object	The managed service identities assigned to this resource.
latestFailoverStatus	object	The status of the most recent failover operation executed.
latestValidationStatus	object	The status of the most recent validation performed.
planDescription	string	A description of the recovery orchestration plan. Required.
planState	string	The current state of the recovery orchestration plan. Known values are: "UnderEdit", "Warning", and "Ready". (UnderEdit, Warning, Ready)
planType	string	The type of the recovery orchestration plan, which can be set during creation but cannot be changed afterward. Required. Known values are: "Regional" and "Zonal". (Regional, Zonal)
provisioningState	string	The provisioning state of the recovery orchestration plan. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupsSetting	object	Settings for the recovery orchestration groups associated with the recovery orchestration plan. 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, recovery_plan_name		Get a RecoveryPlan.
list	select	service_group_name	$skipToken, $top	List RecoveryPlan resources by tenant.
create_or_update	insert	service_group_name, recovery_plan_name		Create a RecoveryPlan.
update	update	service_group_name, recovery_plan_name		Update a RecoveryPlan.
create_or_update	replace	service_group_name, recovery_plan_name		Create a RecoveryPlan.
delete	delete	service_group_name, recovery_plan_name		Delete a RecoveryPlan.

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
recovery_plan_name	string	The name of the recovery orchestration plan. 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 RecoveryPlan.

SELECT
id,
name,
errorDetails,
identity,
latestFailoverStatus,
latestValidationStatus,
planDescription,
planState,
planType,
provisioningState,
recoveryGroupsSetting,
systemData,
type
FROM azure.resilience_management.recovery_plans
WHERE service_group_name = '{{ service_group_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
;

list

List RecoveryPlan resources by tenant.

SELECT
id,
name,
errorDetails,
identity,
latestFailoverStatus,
latestValidationStatus,
planDescription,
planState,
planType,
provisioningState,
recoveryGroupsSetting,
systemData,
type
FROM azure.resilience_management.recovery_plans
WHERE service_group_name = '{{ service_group_name }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create a RecoveryPlan.

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

Manifest

# Description fields are for documentation purposes
- name: recovery_plans
props:
  - name: service_group_name
    value: "{{ service_group_name }}"
    description: Required parameter for the recovery_plans resource.
  - name: recovery_plan_name
    value: "{{ recovery_plan_name }}"
    description: Required parameter for the recovery_plans resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      planType: "{{ planType }}"
      planState: "{{ planState }}"
      planDescription: "{{ planDescription }}"
      recoveryGroupsSetting:
        defaultGroup:
          id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupUniqueId: "{{ groupUniqueId }}"
            orderId: {{ orderId }}
            description: "{{ description }}"
            preActions:
              - name: "{{ name }}"
                description: "{{ description }}"
                type: "{{ type }}"
                timeoutInMinutes: {{ timeoutInMinutes }}
            postActions:
              - name: "{{ name }}"
                description: "{{ description }}"
                type: "{{ type }}"
                timeoutInMinutes: {{ timeoutInMinutes }}
        additionalGroups:
          - id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            systemData:
              createdBy: "{{ createdBy }}"
              createdByType: "{{ createdByType }}"
              createdAt: "{{ createdAt }}"
              lastModifiedBy: "{{ lastModifiedBy }}"
              lastModifiedByType: "{{ lastModifiedByType }}"
              lastModifiedAt: "{{ lastModifiedAt }}"
            properties:
              groupUniqueId: "{{ groupUniqueId }}"
              orderId: {{ orderId }}
              description: "{{ description }}"
              preActions:
                - name: "{{ name }}"
                  description: "{{ description }}"
                  type: "{{ type }}"
                  timeoutInMinutes: {{ timeoutInMinutes }}
              postActions:
                - name: "{{ name }}"
                  description: "{{ description }}"
                  type: "{{ type }}"
                  timeoutInMinutes: {{ timeoutInMinutes }}
      latestFailoverStatus:
        lastExecutedAt: "{{ lastExecutedAt }}"
        operationStatus: "{{ operationStatus }}"
        errorDetails:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
        recoveryTimeActual: "{{ recoveryTimeActual }}"
      latestValidationStatus:
        lastExecutedAt: "{{ lastExecutedAt }}"
        operationStatus: "{{ operationStatus }}"
        errorDetails:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a RecoveryPlan.

UPDATE azure.resilience_management.recovery_plans
SET 
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
service_group_name = '{{ service_group_name }}' --required
AND recovery_plan_name = '{{ recovery_plan_name }}' --required
RETURNING
id,
name,
identity,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a RecoveryPlan.

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

DELETE examples

delete

Delete a RecoveryPlan.

DELETE FROM azure.resilience_management.recovery_plans
WHERE service_group_name = '{{ service_group_name }}' --required
AND recovery_plan_name = '{{ recovery_plan_name }}' --required
;