az site-recovery protection-container 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 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 --name
                                                     --protection-container --protection-container-name
                                                     --resource-group
                                                     --vault-name
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--policy-id]
                                                     [--provider-input --provider-specific-input]
                                                     [--target-container --target-protection-container-id]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--policy-id

Applicable policy.

Property	Value
Parameter group:	Properties Arguments

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

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

Property	Value
Parameter group:	Properties Arguments

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

The target unique protection container name.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

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 --name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--protection-container --protection-container-name]
                                                     [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--fabric-name

Fabric name.

Property	Value
Parameter group:	Resource Id Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--mapping-name --name -n

Protection container mapping name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Protection container name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--vault-name

The name of the recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --protection-container-name
                                                   --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

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 --name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--protection-container --protection-container-name]
                                                     [--provider-input --provider-specific-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--fabric-name

Fabric name.

Property	Value
Parameter group:	Resource Id Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--mapping-name --name -n

Protection container mapping name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Protection container name.

Property	Value
Parameter group:	Resource Id Arguments

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

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

Property	Value
Parameter group:	Properties Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--vault-name

The name of the recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --name]
                                                   [--protection-container --protection-container-name]
                                                   [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--fabric-name

Fabric name.

Property	Value
Parameter group:	Resource Id Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--mapping-name --name -n

Protection Container mapping name.

Property	Value
Parameter group:	Resource Id Arguments

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

Protection container name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--vault-name

The name of the recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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 --name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--policy-id]
                                                     [--protection-container --protection-container-name]
                                                     [--provider-input --provider-specific-input]
                                                     [--remove]
                                                     [--resource-group]
                                                     [--set]
                                                     [--subscription]
                                                     [--target-container --target-protection-container-id]
                                                     [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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>.

Property	Value
Parameter group:	Generic Update Arguments

--fabric-name

Fabric name.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--mapping-name --name -n

Protection Container mapping name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--policy-id

Applicable policy.

Property	Value
Parameter group:	Properties Arguments

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

Protection container name.

Property	Value
Parameter group:	Resource Id Arguments

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

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

Property	Value
Parameter group:	Properties Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

The target unique protection container name.

Property	Value
Parameter group:	Properties Arguments

--vault-name

The name of the recovery services vault.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False