Share via


az backup vault encryption

Encryption details of a Recovery Services Vault.

Commands

Name Description Type Status
az backup vault encryption show

Show details of encryption properties of a Recovery Services Vault.

Core GA
az backup vault encryption update

Update encryption properties of a Recovery Services Vault.

Core GA

az backup vault encryption show

Show details of encryption properties of a Recovery Services Vault.

az backup vault encryption show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Show details of encryption properties of a Recovery Services Vault.

az backup vault encryption show --resource-group MyResourceGroup --name MyVault

Optional Parameters

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

Name of the Recovery services vault.

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

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 backup vault encryption update

Update encryption properties of a Recovery Services Vault.

az backup vault encryption update --encryption-key-id
                                  [--ids]
                                  [--infrastructure-encryption {Disabled, Enabled}]
                                  [--mi-system-assigned]
                                  [--mi-user-assigned]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--tenant-id]

Examples

Update encryption properties to use user assigned identity of a Recovery Services Vault.

az backup vault encryption update --encryption-key-id MyEncryptionKeyId --mi-user-assigned MyUserAssignedIdentityId --resource-group MyResourceGroup --name MyVault

Update encryption properties to use system assigned identity of a Recovery Services Vault.

az backup vault encryption update --encryption-key-id MyEncryptionKeyId --mi-system-assigned --resource-group MyResourceGroup --name MyVault

Required Parameters

--encryption-key-id

The encryption key id you want to use for encryption.

Optional Parameters

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

--infrastructure-encryption

Use this parameter to enable/disable infrastructure encryption. This must be set when configuring encryption of the vault for the first time. Once enabled/disabled, infrastructure encryption setting cannot be changed. Default value: Disabled. Allowed values: Enabled, Disabled.

Accepted values: Disabled, Enabled
--mi-system-assigned

Provide this flag to use system assigned identity for encryption.

--mi-user-assigned

UserAssigned Identity Id to be used for CMK encryption, this will be applicable for encryption using userassigned identity.

--name -n

Name of the Recovery services vault.

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

--tenant-id

ID of the tenant if the Resource Guard protecting the vault exists in a different tenant.

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.