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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedOperations	array	The list of allowed operations.
currentScenario	object	The current scenario details.
currentScenarioStatus	string	The recovery plan status.
currentScenarioStatusDescription	string	The recovery plan status description.
failoverDeploymentModel	string	The failover deployment model.
friendlyName	string	The friendly name.
groups	array	The recovery plan groups.
lastPlannedFailoverTime	string (date-time)	The start time of the last planned failover.
lastTestFailoverTime	string (date-time)	The start time of the last test failover.
lastUnplannedFailoverTime	string (date-time)	The start time of the last unplanned failover.
location	string	Resource Location.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryFabricId	string	The primary fabric Id.
providerSpecificDetails	array	The provider id and provider specific details.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryFabricId	string	The recovery fabric Id.
replicationProviders	array	The list of replication providers.
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.
allowedOperations	array	The list of allowed operations.
currentScenario	object	The current scenario details.
currentScenarioStatus	string	The recovery plan status.
currentScenarioStatusDescription	string	The recovery plan status description.
failoverDeploymentModel	string	The failover deployment model.
friendlyName	string	The friendly name.
groups	array	The recovery plan groups.
lastPlannedFailoverTime	string (date-time)	The start time of the last planned failover.
lastTestFailoverTime	string (date-time)	The start time of the last test failover.
lastUnplannedFailoverTime	string (date-time)	The start time of the last unplanned failover.
location	string	Resource Location.
primaryFabricFriendlyName	string	The primary fabric friendly name.
primaryFabricId	string	The primary fabric Id.
providerSpecificDetails	array	The provider id and provider specific details.
recoveryFabricFriendlyName	string	The recovery fabric friendly name.
recoveryFabricId	string	The recovery fabric Id.
replicationProviders	array	The list of replication providers.
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	resource_group_name, resource_name, recovery_plan_name, subscription_id		Gets the requested recovery plan. Gets the details of the recovery plan.
list	select	resource_group_name, resource_name, subscription_id		Gets the list of recovery plans. Lists the recovery plans in the vault.
create	insert	resource_group_name, resource_name, recovery_plan_name, subscription_id, properties		Creates a recovery plan with the given details. The operation to create a recovery plan.
update	update	resource_group_name, resource_name, recovery_plan_name, subscription_id		Updates the given recovery plan. The operation to update a recovery plan.
delete	delete	resource_group_name, resource_name, recovery_plan_name, subscription_id		Deletes the specified recovery plan. Delete a recovery plan.
failover_cancel	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id		Execute cancel failover of the recovery plan. The operation to cancel the failover of a recovery plan.
failover_commit	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id		Execute commit failover of the recovery plan. The operation to commit the failover of a recovery plan.
planned_failover	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id, properties		Execute planned failover of the recovery plan. The operation to start the planned failover of a recovery plan.
reprotect	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id		Execute reprotect of the recovery plan. The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.
test_failover	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id, properties		Execute test failover of the recovery plan. The operation to start the test failover of a recovery plan.
test_failover_cleanup	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id, properties		Execute test failover cleanup of the recovery plan. The operation to cleanup test failover of a recovery plan.
unplanned_failover	exec	resource_group_name, resource_name, recovery_plan_name, subscription_id, properties		Execute unplanned failover of the recovery plan. 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
recovery_plan_name	string	Name of the recovery plan. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string

SELECT examples

get

Gets the requested recovery plan. Gets the details of the recovery plan.

SELECT
id,
name,
allowedOperations,
currentScenario,
currentScenarioStatus,
currentScenarioStatusDescription,
failoverDeploymentModel,
friendlyName,
groups,
lastPlannedFailoverTime,
lastTestFailoverTime,
lastUnplannedFailoverTime,
location,
primaryFabricFriendlyName,
primaryFabricId,
providerSpecificDetails,
recoveryFabricFriendlyName,
recoveryFabricId,
replicationProviders,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of recovery plans. Lists the recovery plans in the vault.

SELECT
id,
name,
allowedOperations,
currentScenario,
currentScenarioStatus,
currentScenarioStatusDescription,
failoverDeploymentModel,
friendlyName,
groups,
lastPlannedFailoverTime,
lastTestFailoverTime,
lastUnplannedFailoverTime,
location,
primaryFabricFriendlyName,
primaryFabricId,
providerSpecificDetails,
recoveryFabricFriendlyName,
recoveryFabricId,
replicationProviders,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a recovery plan with the given details. The operation to create a recovery plan.

INSERT INTO azure.recovery_services_site_recovery.replication_recovery_plans (
properties,
resource_group_name,
resource_name,
recovery_plan_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ recovery_plan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_recovery_plans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_recovery_plans resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_recovery_plans resource.
  - name: recovery_plan_name
    value: "{{ recovery_plan_name }}"
    description: Required parameter for the replication_recovery_plans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_recovery_plans resource.
  - name: properties
    description: |
      Recovery plan creation properties. Required.
    value:
      primaryFabricId: "{{ primaryFabricId }}"
      recoveryFabricId: "{{ recoveryFabricId }}"
      failoverDeploymentModel: "{{ failoverDeploymentModel }}"
      groups:
        - groupType: "{{ groupType }}"
          replicationProtectedItems: "{{ replicationProtectedItems }}"
          startGroupActions: "{{ startGroupActions }}"
          endGroupActions: "{{ endGroupActions }}"
      providerSpecificInput:
        - instanceType: "{{ instanceType }}"

UPDATE examples

update

Updates the given recovery plan. The operation to update a recovery plan.

UPDATE azure.recovery_services_site_recovery.replication_recovery_plans
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND recovery_plan_name = '{{ recovery_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified recovery plan. Delete a recovery plan.

DELETE FROM azure.recovery_services_site_recovery.replication_recovery_plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND recovery_plan_name = '{{ recovery_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

failover_cancel

Execute cancel failover of the recovery plan. The operation to cancel the failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.failover_cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

failover_commit

Execute commit failover of the recovery plan. The operation to commit the failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.failover_commit 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

planned_failover

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

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.planned_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reprotect

Execute reprotect of the recovery plan. The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.reprotect 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

test_failover

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

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.test_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_failover_cleanup

Execute test failover cleanup of the recovery plan. The operation to cleanup test failover of a recovery plan.

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.test_failover_cleanup 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

unplanned_failover

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

EXEC azure.recovery_services_site_recovery.replication_recovery_plans.unplanned_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@recovery_plan_name='{{ recovery_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;