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

--fabric-name

Unique fabric ARM name.

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

Unique protection container ARM 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

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

Provider specific inputs for container creation. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Required Parameters

--fabric-name

Fabric 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 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_name

Optional Parameters

--fabric-name

Unique fabric ARM 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.

--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-name -n

The name of the protection container.

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

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

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

--fabric-name

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

--no-wait

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

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

--protected-item --replication-protected-item-name

The unique replication protected item name.

--protection-container-name -n

The name of the protection container.

--provider-details --provider-specific-details

Provider specific switch protection input. 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 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

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.

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

Protection container 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

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

Provider specific inputs for container creation. 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.

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