replication_recovery_plans

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

Overview

Name	replication_recovery_plans
Type	Resource
Id	azure.recovery_services_site_recovery.replication_recovery_plans

Fields

vw_replication_recovery_plans

Name	Datatype	Description
id	text	Resource Id
name	text	Resource Name
allowed_operations	text	field from the properties object
current_scenario	text	field from the properties object
current_scenario_status	text	field from the properties object
current_scenario_status_description	text	field from the properties object
failover_deployment_model	text	field from the properties object
friendly_name	text	field from the properties object
groups	text	field from the properties object
last_planned_failover_time	text	field from the properties object
last_test_failover_time	text	field from the properties object
last_unplanned_failover_time	text	field from the properties object
location	text	Resource Location
primary_fabric_friendly_name	text	field from the properties object
primary_fabric_id	text	field from the properties object
provider_specific_details	text	field from the properties object
recoveryPlanName	text	field from the properties object
recovery_fabric_friendly_name	text	field from the properties object
recovery_fabric_id	text	field from the properties object
replication_providers	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	Resource Type

replication_recovery_plans

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	Recovery plan properties.
type	string	Resource Type

Methods

Name	Accessible by	Required Params	Description
get	SELECT	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	Gets the details of the recovery plan.
list	SELECT	resourceGroupName, resourceName, subscriptionId	Lists the recovery plans in the vault.
create	INSERT	recoveryPlanName, resourceGroupName, resourceName, subscriptionId, data__properties	The operation to create a recovery plan.
delete	DELETE	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	Delete a recovery plan.
update	UPDATE	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	The operation to update a recovery plan.
failover_cancel	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	The operation to cancel the failover of a recovery plan.
failover_commit	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	The operation to commit the failover of a recovery plan.
planned_failover	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId, data__properties	The operation to start the planned failover of a recovery plan.
reprotect	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId	The operation to reprotect(reverse replicate) a recovery plan.
test_failover	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId, data__properties	The operation to start the test failover of a recovery plan.
test_failover_cleanup	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId, data__properties	The operation to cleanup test failover of a recovery plan.
unplanned_failover	EXEC	recoveryPlanName, resourceGroupName, resourceName, subscriptionId, data__properties	The operation to start the unplanned failover of a recovery plan.

SELECT examples

Lists the recovery plans in the vault.

vw_replication_recovery_plans

SELECT
id,
name,
allowed_operations,
current_scenario,
current_scenario_status,
current_scenario_status_description,
failover_deployment_model,
friendly_name,
groups,
last_planned_failover_time,
last_test_failover_time,
last_unplanned_failover_time,
location,
primary_fabric_friendly_name,
primary_fabric_id,
provider_specific_details,
recoveryPlanName,
recovery_fabric_friendly_name,
recovery_fabric_id,
replication_providers,
resourceGroupName,
resourceName,
subscriptionId,
type
FROM azure.recovery_services_site_recovery.vw_replication_recovery_plans
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

replication_recovery_plans

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new replication_recovery_plans resource.

All Properties

/*+ create */
INSERT INTO azure.recovery_services_site_recovery.replication_recovery_plans (
recoveryPlanName,
resourceGroupName,
resourceName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ recoveryPlanName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: primaryFabricId
          value: string
        - name: recoveryFabricId
          value: string
        - name: failoverDeploymentModel
          value: string
        - name: groups
          value:
            - - name: groupType
                value: string
              - name: replicationProtectedItems
                value:
                  - - name: id
                      value: string
                    - name: virtualMachineId
                      value: string
              - name: startGroupActions
                value:
                  - - name: actionName
                      value: string
                    - name: failoverTypes
                      value:
                        - string
                    - name: failoverDirections
                      value:
                        - string
                    - name: customDetails
                      value:
                        - name: instanceType
                          value: string
              - name: endGroupActions
                value:
                  - - name: actionName
                      value: string
                    - name: failoverTypes
                      value:
                        - string
                    - name: failoverDirections
                      value:
                        - string
        - name: providerSpecificInput
          value:
            - - name: instanceType
                value: string

UPDATE example

Updates a replication_recovery_plans resource.

/*+ update */
UPDATE azure.recovery_services_site_recovery.replication_recovery_plans
SET 
properties = '{{ properties }}'
WHERE 
recoveryPlanName = '{{ recoveryPlanName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified replication_recovery_plans resource.

/*+ delete */
DELETE FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE recoveryPlanName = '{{ recoveryPlanName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';