Share via

az site-recovery protection-container mapping

  • Reference

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 mapping command. Learn more about extensions.

Manage a protection container mapping for a protection container.

Commands

Name Description Type Status
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 mapping create

Create operation to create a protection container mapping.

az site-recovery protection-container mapping create --fabric-name
                                                     --mapping-name
                                                     --protection-container
                                                     --resource-group
                                                     --vault-name
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--policy-id]
                                                     [--provider-input]
                                                     [--target-container]

Examples

protection-container mapping create for A2A

az site-recovery protection-container mapping create -g rg --fabric-name fabric1_name -n container_mapping1_name --protection-container container1_name --vault-name vault_name --policy-id policy_id --provider-input '{a2a:{agent-auto-update-status:Disabled}}' --target-container container2_id

protection-container mapping create for H2A

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:""}'

protection-container mapping create for V2A RCM

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 '{in-mage-rcm:{enable-agent-auto-upgrade:true}}'

Required Parameters

--fabric-name

Fabric name.

--mapping-name --name -n

Protection container mapping name.

--protection-container --protection-container-name

Protection container name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vault-name

The name of the recovery services vault.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--policy-id

Applicable policy.

--provider-input --provider-specific-input

Provider specific input for pairing. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--target-container --target-protection-container-id

The target unique protection container name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az site-recovery protection-container mapping delete

Delete operation to purge(force delete) a protection container mapping.

az site-recovery protection-container mapping delete [--fabric-name]
                                                     [--ids]
                                                     [--mapping-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--protection-container]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vault-name]
                                                     [--yes]

Examples

protection-container mapping delete

az site-recovery protection-container mapping delete -g rg --fabric-name fabric1_name -n container_mapping1_name --protection-container container1_name --vault-name vault_name

Optional Parameters

--fabric-name

Fabric name.

--ids

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.

--mapping-name --name -n

Protection container mapping name.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--protection-container --protection-container-name

Protection container name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--vault-name

The name of the recovery services vault.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az site-recovery protection-container mapping list

List the protection container mappings for a protection container.

az site-recovery protection-container mapping list --fabric-name
                                                   --protection-container
                                                   --resource-group
                                                   --vault-name
                                                   [--max-items]
                                                   [--next-token]

Examples

protection-container mapping list

az site-recovery protection-container mapping list -g rg --fabric-name fabric_source_name --protection-container container_source_name --vault-name vault_name

Required Parameters

--fabric-name

Fabric name.

--protection-container --protection-container-name

Protection container name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vault-name

The name of the recovery services vault.

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az site-recovery protection-container mapping remove

The operation to delete or remove a protection container mapping.

az site-recovery protection-container mapping remove [--fabric-name]
                                                     [--ids]
                                                     [--mapping-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--protection-container]
                                                     [--provider-input]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--vault-name]

Examples

protection-container mapping remove

az site-recovery protection-container mapping remove -g rg --fabric-name fabric_source_name -n container_mapping_source_name --protection-container container_source_name --vault-name vault_name

Optional Parameters

--fabric-name

Fabric name.

--ids

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.

--mapping-name --name -n

Protection container mapping name.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--protection-container --protection-container-name

Protection container name.

--provider-input --provider-specific-input

Provider specific input for unpairing. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--vault-name

The name of the recovery services vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az site-recovery protection-container mapping show

Get the details of a protection container mapping.

az site-recovery protection-container mapping show [--fabric-name]
                                                   [--ids]
                                                   [--mapping-name]
                                                   [--protection-container]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--vault-name]

Examples

protection-container mapping show

az site-recovery protection-container mapping show -g rg --fabric-name fabric_source_name -n container_mapping_source_name --protection-container container_source_name --vault-name vault_name

Optional Parameters

--fabric-name

Fabric name.

--ids

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.

--mapping-name --name -n

Protection Container mapping name.

--protection-container --protection-container-name

Protection container name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--vault-name

The name of the recovery services vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az site-recovery protection-container mapping update

Update operation to create a protection container mapping.

az site-recovery protection-container mapping update [--add]
                                                     [--fabric-name]
                                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--ids]
                                                     [--mapping-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--policy-id]
                                                     [--protection-container]
                                                     [--provider-input]
                                                     [--remove]
                                                     [--resource-group]
                                                     [--set]
                                                     [--subscription]
                                                     [--target-container]
                                                     [--vault-name]

Examples

protection-container mapping update

az site-recovery protection-container mapping update -g rg --fabric-name fabric_source_name -n container_mapping_source_name --protection-container container_source_name --vault-name vault_name --policy-id policy_id --provider-input '{a2a:{agent-auto-update-status:Enabled}}' --target-container container_recovery_id

Optional Parameters

--add

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

Fabric name.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

--mapping-name --name -n

Protection Container mapping name.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--policy-id

Applicable policy.

--protection-container --protection-container-name

Protection container name.

--provider-input --provider-specific-input

Provider specific input for pairing. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--target-container --target-protection-container-id

The target unique protection container name.

--vault-name

The name of the recovery services vault.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.