az site-recovery network mapping
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 network mapping command. Learn more about extensions.
Manage Network Mapping.
Commands
Name | Description | Type | Status |
---|---|---|---|
az site-recovery network mapping create |
Create operation to create an ASR network mapping. |
Extension | GA |
az site-recovery network mapping delete |
Delete operation to delete a network mapping. |
Extension | GA |
az site-recovery network mapping list |
List all ASR network mappings for the specified network. |
Extension | GA |
az site-recovery network mapping show |
Get the details of an ASR network mapping. |
Extension | GA |
az site-recovery network mapping update |
Update operation to create an ASR network mapping. |
Extension | GA |
az site-recovery network mapping create
Create operation to create an ASR network mapping.
az site-recovery network mapping create --fabric-name
--name
--network-name
--recovery-network-id
--resource-group
--vault-name
[--fabric-details]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--recovery-fabric-name]
Examples
network mapping create for A2A fabric
az site-recovery network mapping create -g rg --fabric-name fabric1_name -n network_mapping1_name --network-name azureNetwork --vault-name vault_name --recovery-network-id vnet2_id --fabric-details '{azure-to-azure:{primary-network-id:vnetvm_id}}' --recovery-fabric-name fabric2_name
network mapping create for H2A E2A (VMM)
az site-recovery network mapping create -g "rg" --fabric-name "fabric_name" -n "network_mapping_name" --network-name "vnet_source_name" --vault-name "vault_name" --recovery-network-id "vnet_recovery_id" --fabric-details '{vmm-to-azure:""}'
Required Parameters
Primary fabric name.
Network mapping name.
Primary network name.
Recovery network 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
Fabric specific input properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Do not wait for the long-running operation to finish.
Recovery fabric Name.
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 network mapping delete
Delete operation to delete a network mapping.
az site-recovery network mapping delete [--fabric-name]
[--ids]
[--name]
[--network-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--vault-name]
[--yes]
Examples
network mapping delete
az site-recovery network mapping delete -g rg --fabric-name fabric_source_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name'
Optional Parameters
Primary 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.
ARM Resource Name for network mapping.
Primary network 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 network mapping list
List all ASR network mappings for the specified network.
az site-recovery network mapping list --fabric-name
--network-name
--resource-group
--vault-name
[--max-items]
[--next-token]
Examples
network mapping list
az site-recovery network mapping list -g rg --fabric-name fabric_source_name --network-name azureNetwork --vault-name vault_name
Required Parameters
Primary fabric name.
Primary network 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 network mapping show
Get the details of an ASR network mapping.
az site-recovery network mapping show [--fabric-name]
[--ids]
[--name]
[--network-name]
[--resource-group]
[--subscription]
[--vault-name]
Examples
network mapping show
az site-recovery network mapping show -g rg --fabric-name fabric_source_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name
Optional Parameters
Primary 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.
Network mapping name.
Primary network 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 network mapping update
Update operation to create an ASR network mapping.
az site-recovery network mapping update [--add]
[--fabric-details]
[--fabric-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--network-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--recovery-fabric-name]
[--recovery-network-id]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--vault-name]
Examples
network mapping update
az site-recovery network mapping update -g rg --fabric-name fabric_recovery_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name --recovery-network-id vnetvm_id --fabric-details '{azure-to-azure:{primary-network-id:vnet_recovery_id}}' --recovery-fabric-name fabric_source_name
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 specific input properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Primary 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.
Network mapping name.
Primary network name.
Do not wait for the long-running operation to finish.
Recovery fabric Name.
Recovery network Id.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
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=<value>
.
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.
Azure CLI