az site-recovery protection-container
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 protection-container command. Learn more about extensions.
Manage Protection Container.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az site-recovery protection-container create |
Create to create a protection container. |
Extension | GA |
| az site-recovery protection-container list |
List the protection containers in the specified fabric. |
Extension | GA |
| az site-recovery protection-container mapping |
Manage a protection container mapping for a protection container. |
Extension | GA |
| az site-recovery protection-container mapping create |
Create operation to create a protection container mapping. |
Extension | GA |
| az site-recovery protection-container mapping delete |
Delete operation to purge(force delete) a protection container mapping. |
Extension | GA |
| az site-recovery protection-container mapping list |
List the protection container mappings for a protection container. |
Extension | GA |
| az site-recovery protection-container mapping remove |
The operation to delete or remove a protection container mapping. |
Extension | GA |
| az site-recovery protection-container mapping show |
Get the details of a protection container mapping. |
Extension | GA |
| az site-recovery protection-container mapping update |
Update operation to create a protection container mapping. |
Extension | GA |
| az site-recovery protection-container remove |
Operation to remove a protection container. |
Extension | GA |
| az site-recovery protection-container show |
Get the details of a protection container. |
Extension | GA |
| az site-recovery protection-container switch-protection |
Operation to switch protection from one container to another or one replication provider to another. |
Extension | GA |
| az site-recovery protection-container update |
Update to create a protection container. |
Extension | GA |
az site-recovery protection-container create
Create to create a protection container.
az site-recovery protection-container create --fabric-name
--name
--resource-group
--vault-name
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-input]Examples
protection-container create for A2A
az site-recovery protection-container create -g rg --fabric-name fabric1_name -n container1_name --vault-name vault_name --provider-input '[{instance-type:A2A}]'protection-container create for hyper-v-replica-azure
az site-recovery protection-container mapping create -g "rg" --fabric-name "fabric_name" -n "container_mapping_name" --protection-container "container_name" --vault-name "vault_name" --policy-id "policy_id" --target-container "Microsoft Azure" --provider-input '{hyper-v-replica-azure:""}'Required Parameters
Unique fabric ARM name.
Unique protection container ARM name.
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
Do not wait for the long-running operation to finish.
Provider specific inputs for container creation. 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 protection-container list
List the protection containers in the specified fabric.
az site-recovery protection-container list --fabric-name
--resource-group
--vault-name
[--max-items]
[--next-token]Examples
protection-container list
az site-recovery protection-container list -g rg --fabric-name fabric_source_name --vault-name vault_nameRequired Parameters
Fabric name.
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 protection-container remove
Operation to remove a protection container.
az site-recovery protection-container remove [--fabric-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--protection-container-name]
[--resource-group]
[--subscription]
[--vault-name]Examples
protection-container remove
az site-recovery protection-container remove -g rg --fabric-name fabric1_name -n container1_name --vault-name vault_nameOptional Parameters
Unique fabric ARM name.
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.
Do not wait for the long-running operation to finish.
The name of the protection container.
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 protection-container show
Get the details of a protection container.
az site-recovery protection-container show [--fabric-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--vault-name]Examples
protection-container show
az site-recovery protection-container show -g rg --fabric-name fabric1_name -n container1_name --vault-name vault_nameOptional Parameters
Fabric name.
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.
Protection container name.
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 protection-container switch-protection
Operation to switch protection from one container to another or one replication provider to another.
az site-recovery protection-container switch-protection [--fabric-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--protected-item]
[--protection-container-name]
[--provider-details]
[--resource-group]
[--subscription]
[--vault-name]Examples
protection-container switch-protection for A2A
az site-recovery protection-container switch-protection --fabric-name fabric1_name -n container1_name --protected-item protected_item_name -g rg --vault-name vault_name --provider-details '{a2a:{policy-id:policy_id,recovery-container-id:container1_id,recovery-resource-group-id:vm_rg_id,vm-managed-disks:[{disk-id:recovery_os_disk,primary-staging-azure-storage-account-id:storage2_id,recovery-resource-group-id:vm_rg_id}]}}'Optional Parameters
Unique fabric name.
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.
Do not wait for the long-running operation to finish.
The unique replication protected item name.
The name of the protection container.
Provider specific switch protection input. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 protection-container update
Update to create a protection container.
az site-recovery protection-container update [--add]
[--fabric-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-input]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--vault-name]Examples
protection-container update
az site-recovery protection-container update -g rg --fabric-name fabric_source_name -n container_source_name --vault-name vault_name --provider-input '[{instance-type:A2ACrossClusterMigration}]'Optional 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>.
Fabric name.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Protection container name.
Do not wait for the long-running operation to finish.
Provider specific inputs for container creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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