az site-recovery recovery-plan
Note
This reference is part of the site-recovery extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az site-recovery recovery-plan command. Learn more about extensions.
Manage the recovery plans in the vault.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az site-recovery recovery-plan create |
Create operation to create a recovery plan. |
Extension | GA |
| az site-recovery recovery-plan delete |
Delete a recovery plan. |
Extension | GA |
| az site-recovery recovery-plan list |
List the recovery plans in the vault. |
Extension | GA |
| az site-recovery recovery-plan show |
Get the details of the recovery plan. |
Extension | GA |
| az site-recovery recovery-plan update |
Update operation to create a recovery plan. |
Extension | GA |
az site-recovery recovery-plan create
Create operation to create a recovery plan.
az site-recovery recovery-plan create --groups
--name
--primary-fabric-id
--recovery-fabric-id
--resource-group
--vault-name
[--failover-deploy-model {Classic, NotApplicable, ResourceManager}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-input]Examples
recovery-plan create A2A
az site-recovery recovery-plan create -n recovery_plan_name -g rg --vault-name vault_name --groups '[{group-type:Boot,replication-protected-items:[{id:protected_item_id,virtual-machine-id:vm_id}]}]' --primary-fabric-id fabric1_id --recovery-fabric-id fabric2_id --failover-deployment-model ResourceManagerrecovery-plan create hyper-v-replica-azure
az site-recovery recovery-plan create -n "recovery_plan_name" -g "rg" --vault-name "vault_name" --groups '[{group-type:Boot,replication-protected-items:[{id:"protected_item_id",virtual-machine-id:"protectable_item_id"}]}]' --primary-fabric-id "fabric_id" --recovery-fabric-id "Microsoft Azure" --failover-deployment-model ResourceManagerrecovery-plan create for v2arcm
az site-recovery recovery-plan create -n "recovery_plan_name" -g "rg" --vault-name "vault_name" --groups '[{group-type:Boot,replication-protected-items:[{id:"protected_item_id",virtual-machine-id:"vm_id"}]}]' --primary-fabric-id "fabric_id" --recovery-fabric-id "Microsoft Azure" --failover-deployment-model ResourceManagerRequired Parameters
The recovery plan groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Recovery plan name.
The primary fabric Id.
The recovery fabric Id.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the recovery services vault.
Optional Parameters
The failover deployment model.
Do not wait for the long-running operation to finish.
The provider specific input. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az site-recovery recovery-plan delete
Delete a recovery plan.
az site-recovery recovery-plan delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--vault-name]
[--yes]Examples
recovery-plan delete
az site-recovery recovery-plan delete -n recovery_plan_name -g rg --vault-name vault_nameOptional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Recovery plan name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the recovery services vault.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az site-recovery recovery-plan list
List the recovery plans in the vault.
az site-recovery recovery-plan list --resource-group
--vault-name
[--max-items]
[--next-token]Examples
recovery-plan list
az site-recovery recovery-plan list -g rg --vault-name vault_nameRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the recovery services vault.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az site-recovery recovery-plan show
Get the details of the recovery plan.
az site-recovery recovery-plan show [--ids]
[--name]
[--resource-group]
[--subscription]
[--vault-name]Examples
recovery-plan show
az site-recovery recovery-plan show -n recovery_plan_name -g rg --vault-name vault_nameOptional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the recovery plan.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the recovery services vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az site-recovery recovery-plan update
Update operation to create a recovery plan.
az site-recovery recovery-plan update [--add]
[--failover-deploy-model {Classic, NotApplicable, ResourceManager}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--groups]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--primary-fabric-id]
[--provider-input]
[--recovery-fabric-id]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--vault-name]Examples
recovery-plan update
az site-recovery recovery-plan update -n recovery_plan_name -g rg --vault-name vault_name --groups '[{group-type:Boot,replication-protected-items:[{id:protected_item_id,virtual-machine-id:vm_id}]}]' --primary-fabric-id fabric1_id --recovery-fabric-id fabric2_id --failover-deployment-model ResourceManagerOptional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
The failover deployment model.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The recovery plan groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the recovery plan.
Do not wait for the long-running operation to finish.
The primary fabric Id.
The provider specific input. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The recovery fabric Id.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the recovery services vault.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for