Share via

az dataprotection backup-vault resource-guard-mapping

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-vault resource-guard-mapping command. Learn more about extensions.

Manage ResourceGuard mappings for a backup vault.

Commands

Name Description Type Status
az dataprotection backup-vault resource-guard-mapping create

Create a ResourceGuard mapping.

 Extension GA
az dataprotection backup-vault resource-guard-mapping delete

Delete the ResourceGuard mapping.

 Extension GA
az dataprotection backup-vault resource-guard-mapping show

Get the ResourceGuard mapping object associated with the vault, and that matches the name in the request.

 Extension GA

az dataprotection backup-vault resource-guard-mapping create

Create a ResourceGuard mapping.

az dataprotection backup-vault resource-guard-mapping create --resource-group
                                                             --vault-name
                                                             [--name --resource-guard-mapping-name]
                                                             [--resource-guard-id --resource-guard-resource-id]

Examples

Create a ResourceGuard mapping

az dataprotection backup-vault resource-guard-mapping create -n "DppResourceGuardProxy" -g "sampleRG" --vault-name "sampleVault" --resource-guard-id "/subscription/00000000-0000-0000-0000-000000000000/resourcegroups/sampleRG/providers/Microsoft.DataProtection/resourceGuards/sampleResourceGuard"

Required Parameters

--resource-group -g

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

--vault-name -v

The name of the backup 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.

--name --resource-guard-mapping-name -n

The name of the resource guard mapping.

Property Value
Default value: DppResourceGuardProxy
--resource-guard-id --resource-guard-resource-id

ARM Id of the resource guard to be mapped to.

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 dataprotection backup-vault resource-guard-mapping delete

Delete the ResourceGuard mapping.

az dataprotection backup-vault resource-guard-mapping delete [--ids]
                                                             [--name --resource-guard-mapping-name]
                                                             [--resource-group]
                                                             [--subscription]
                                                             [--vault-name]
                                                             [--yes]

Examples

Delete a ResourceGuard Mapping

az dataprotection backup-vault resource-guard-mapping delete -n "DppResourceGuardProxy" -g "sampleRG" -v "sampleVault"

Optional Parameters

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

--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
--name --resource-guard-mapping-name -n

The name of the resource guard mapping.

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

The name of the backup 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 dataprotection backup-vault resource-guard-mapping show

Get the ResourceGuard mapping object associated with the vault, and that matches the name in the request.

az dataprotection backup-vault resource-guard-mapping show [--ids]
                                                           [--name --resource-guard-mapping-name]
                                                           [--resource-group]
                                                           [--subscription]
                                                           [--vault-name]

Examples

Show a ResourceGuard Mapping associated with a vault

az dataprotection backup-vault resource-guard-mapping show -n "DppResourceGuardProxy" -g "sampleRG" -v "sampleVault"

Optional Parameters

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

--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
--name --resource-guard-mapping-name -n

The name of the resource guard mapping.

Property Value
Parameter group: Resource Id Arguments
Default value: DppResourceGuardProxy
--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 -v

The name of the backup 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