recovery_plan_actions
Creates, updates, deletes, gets or lists a recovery_plan_actions resource.
Overview
| Name | recovery_plan_actions |
| Type | Resource |
| Id | azure.resilience_management.recovery_plan_actions |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
finalize | exec | service_group_name, recovery_plan_name, operation-id | This action finalizes the recovery orchestration plan, ensuring all necessary configurations are in place. | |
update_resources | exec | service_group_name, recovery_plan_name, operation-id | This action adds or updates the resources to be included in the recovery orchestration plan. | |
validate_for_operation | exec | service_group_name, recovery_plan_name, operation-id, operationName | This action checks if the recovery orchestration plan is eligible for operations like failover and reprotect, ensuring it meets the necessary criteria. | |
validate_for_failover | exec | service_group_name, recovery_plan_name, operation-id, failoverDirection | This action checks if the recovery orchestration plan is eligible for failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. | |
validate_for_failover_commit | exec | service_group_name, recovery_plan_name, operation-id | This action checks if the recovery orchestration plan is eligible for failover commit operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. | |
validate_for_test_failover | exec | service_group_name, recovery_plan_name, operation-id, failoverDirection | This action checks if the recovery orchestration plan is eligible for test failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. | |
validate_for_test_failover_cleanup | exec | service_group_name, recovery_plan_name, operation-id | This action checks if the recovery orchestration plan is eligible for test failover cleanup operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. | |
validate_for_reprotect | exec | service_group_name, recovery_plan_name, operation-id | This action checks if the recovery orchestration plan is eligible for reprotect operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. | |
check_readiness | exec | service_group_name, recovery_plan_name, operation-id | This action performs the necessary readiness check on the recovery orchestration plan to ensure it is in the desired state and eligible for all recovery actions, including all protected resources. | |
failover | exec | service_group_name, recovery_plan_name, operation-id, failoverDirection | This action triggers the failover operation on the recovery orchestration plan for the qualified resources. | |
failover_commit | exec | service_group_name, recovery_plan_name, operation-id | This action triggers the failover commit operation on the recovery orchestration plan for the qualified resources. | |
reprotect | exec | service_group_name, recovery_plan_name, operation-id | This action triggers the reprotect operation on the recovery orchestration plan for the qualified resources. | |
test_failover | exec | service_group_name, recovery_plan_name, operation-id, failoverDirection | This action triggers the test failover operation on the recovery orchestration plan for the qualified resources. | |
test_failover_cleanup | exec | service_group_name, recovery_plan_name, operation-id | This action triggers the test failover cleanup operation on the recovery orchestration plan for the qualified resources. |
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 |
|---|---|---|
operation-id | string | A GUID that represents the Long Running OperationId. Required. |
recovery_plan_name | string | The name of the recovery orchestration plan. Required. |
service_group_name | string | The name of the service group. Required. |
Lifecycle Methods
- finalize
- update_resources
- validate_for_operation
- validate_for_failover
- validate_for_failover_commit
- validate_for_test_failover
- validate_for_test_failover_cleanup
- validate_for_reprotect
- check_readiness
- failover
- failover_commit
- reprotect
- test_failover
- test_failover_cleanup
This action finalizes the recovery orchestration plan, ensuring all necessary configurations are in place.
EXEC azure.resilience_management.recovery_plan_actions.finalize
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
;
This action adds or updates the resources to be included in the recovery orchestration plan.
EXEC azure.resilience_management.recovery_plan_actions.update_resources
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"resourcesToUpdate": "{{ resourcesToUpdate }}",
"resourcesToRemove": "{{ resourcesToRemove }}"
}'
;
This action checks if the recovery orchestration plan is eligible for operations like failover and reprotect, ensuring it meets the necessary criteria.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_operation
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"operationName": "{{ operationName }}"
}'
;
This action checks if the recovery orchestration plan is eligible for failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_failover
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"failoverDirection": "{{ failoverDirection }}",
"failoverRequestProperties": "{{ failoverRequestProperties }}"
}'
;
This action checks if the recovery orchestration plan is eligible for failover commit operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_failover_commit
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
;
This action checks if the recovery orchestration plan is eligible for test failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_test_failover
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"failoverDirection": "{{ failoverDirection }}",
"failoverRequestProperties": "{{ failoverRequestProperties }}"
}'
;
This action checks if the recovery orchestration plan is eligible for test failover cleanup operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_test_failover_cleanup
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
;
This action checks if the recovery orchestration plan is eligible for reprotect operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources.
EXEC azure.resilience_management.recovery_plan_actions.validate_for_reprotect
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"reprotectRequestProperties": "{{ reprotectRequestProperties }}"
}'
;
This action performs the necessary readiness check on the recovery orchestration plan to ensure it is in the desired state and eligible for all recovery actions, including all protected resources.
EXEC azure.resilience_management.recovery_plan_actions.check_readiness
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
;
This action triggers the failover operation on the recovery orchestration plan for the qualified resources.
EXEC azure.resilience_management.recovery_plan_actions.failover
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"failoverDirection": "{{ failoverDirection }}",
"failoverRequestProperties": "{{ failoverRequestProperties }}"
}'
;
This action triggers the failover commit operation on the recovery orchestration plan for the qualified resources.
EXEC azure.resilience_management.recovery_plan_actions.failover_commit
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
;
This action triggers the reprotect operation on the recovery orchestration plan for the qualified resources.
EXEC azure.resilience_management.recovery_plan_actions.reprotect
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"reprotectRequestProperties": "{{ reprotectRequestProperties }}"
}'
;
This action triggers the test failover operation on the recovery orchestration plan for the qualified resources.
EXEC azure.resilience_management.recovery_plan_actions.test_failover
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"failoverDirection": "{{ failoverDirection }}",
"failoverRequestProperties": "{{ failoverRequestProperties }}"
}'
;
This action triggers the test failover cleanup operation on the recovery orchestration plan for the qualified resources.
EXEC azure.resilience_management.recovery_plan_actions.test_failover_cleanup
@service_group_name='{{ service_group_name }}' --required,
@recovery_plan_name='{{ recovery_plan_name }}' --required,
@operation-id='{{ operation-id }}' --required
@@json=
'{
"comments": "{{ comments }}"
}'
;