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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom details.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom details.
type	string	Resource Type

Methods

The following methods are available for this resource:

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

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
recoveryPlanName	string	Recovery plan name.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
api-version	string	Client Api Version.

SELECT examples

get

Gets the details of the recovery plan.

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

list

Lists the recovery plans in the vault.

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

INSERT examples

create

The operation to create a recovery plan.

INSERT INTO azure.recovery_services_site_recovery.replication_recovery_plans (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
recoveryPlanName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ recoveryPlanName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_recovery_plans
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_recovery_plans resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_recovery_plans resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_recovery_plans resource.
    - name: recoveryPlanName
      value: string
      description: Required parameter for the replication_recovery_plans resource.
    - name: properties
      value: object
      description: |
        Recovery plan creation properties.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

The operation to update a recovery plan.

UPDATE azure.recovery_services_site_recovery.replication_recovery_plans
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND recoveryPlanName = '{{ recoveryPlanName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

DELETE examples

delete

Delete a recovery plan.

DELETE FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND recoveryPlanName = '{{ recoveryPlanName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

failover_cancel

The operation to cancel the failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.failover_cancel 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}'
;

failover_commit

The operation to commit the failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.failover_commit 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}'
;

planned_failover

The operation to start the planned failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.planned_failover 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reprotect

The operation to reprotect(reverse replicate) a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.reprotect 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}'
;

test_failover

The operation to start the test failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.test_failover 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_failover_cleanup

The operation to cleanup test failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.test_failover_cleanup 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

unplanned_failover

The operation to start the unplanned failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.unplanned_failover 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@recoveryPlanName='{{ recoveryPlanName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;