Skip to content

Commit 1e99020

Browse files
committed
Update to mention requirement on validity of current key.
1 parent 1a32e9b commit 1e99020

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

articles/azure-app-configuration/concept-customer-managed-keys.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ After these resources are configured, use the following steps so that the Azure
3535
* For Key Vault's with [Azure RBAC](/azure/key-vault/general/rbac-guide) enabled, assign the identity the `Key Vault Crypto Service Encryption User` role on the target Key Vault.
3636
* For Key Vault's using access policy authorization, grant the identity `GET`, `WRAP`, and `UNWRAP` permissions in the target Key Vault's access policy.
3737

38-
## Enable customer-managed key encryption for your App Configuration store
38+
## Enable customer-managed key encryption
3939

4040
1. [Create an App Configuration store](./quickstart-azure-app-configuration-create.md) in the Standard or Premium tier if you don't have one.
4141

@@ -107,17 +107,19 @@ After these resources are configured, use the following steps so that the Azure
107107
108108
Your Azure App Configuration instance is now configured to use a customer-managed key stored in Azure Key Vault.
109109
110-
## Disable customer-managed key encryption for your App Configuration store
110+
## Disable customer-managed key encryption
111111
112-
1. Use the Azure CLI to update your App Configuration instance and remove the customer-managed key configuration. Replace `contoso-resource-group` and `contoso-app-config` with the appropriate values for your setup.
112+
1. Ensure the current customer-managed key is valid and operational. App Configuration needs to decrypt existing data with the current key before reverting to Microsoft-managed keys. If the current key has expired or its access has been revoked, you must first restore access to that key.
113+
114+
2. Use the Azure CLI to update your App Configuration instance and remove the customer-managed key configuration. Replace `contoso-resource-group` and `contoso-app-config` with the appropriate values for your setup.
113115
114116
```azurecli
115117
az appconfig update -g contoso-resource-group -n contoso-app-config --encryption-key-name ""
116118
```
117119
118120
This command removes the customer-managed key configuration from your App Configuration instance.
119121
120-
1. Verify that the customer-managed key configuration has been removed by checking the properties of your App Configuration instance.
122+
3. Verify that the customer-managed key configuration has been removed by checking the properties of your App Configuration instance.
121123
122124
```azurecli
123125
az appconfig show -g contoso-resource-group -n contoso-app-config --query "encryption"
@@ -139,7 +141,7 @@ When users enable the customer-managed key capability on their Azure App Configu
139141
140142
## Key Rotation
141143
142-
When customer-managed key is configured on an App Configuration instance it is necessary to periodically rotate the managed key to ensure that it never expires. [Key vault key auto-rotation](/azure/key-vault/keys/how-to-configure-key-rotation) can be configured to avoid the need to manually rotate encryption keys, and thus ensure that the latest version of a key remains valid. When relying on key vault key auto-rotation, you should ensure your App Configuration instance's managed key configuration does not reference a specific key version. Omitting the version allows App Configuration to always move to the latest version of the key vault key when an auto-rotation is performed. Failure to rotate the managed key can be considered a security concern, but additionally a lack of rotation can result in loss of access to the App Configuration instance. This is due to the fact that if the managed key version in use expires, then App Configuration will not be able to decrypt data.
144+
When customer-managed key is configured on an App Configuration instance it is necessary to periodically rotate the managed key to ensure that it never expires. It's important to note that for a successful key rotation, the current key must be valid and operational. If the current key has already expired or App Configuration's access to it has been revoked, the App Configuration instance will not be able to decrypt data, making rotation impossible. [Key vault key auto-rotation](/azure/key-vault/keys/how-to-configure-key-rotation) can be configured to avoid the need to manually rotate encryption keys, and thus ensure that the latest version of a key remains valid. When relying on key vault key auto-rotation, you should ensure your App Configuration instance's managed key configuration does not reference a specific key version. Omitting the version allows App Configuration to always move to the latest version of the key vault key when an auto-rotation is performed. Failure to rotate the managed key can be considered a security concern, but additionally a lack of rotation can result in loss of access to the App Configuration instance. This is due to the fact that if the managed key version in use expires, then App Configuration will not be able to decrypt data.
143145
144146
To recap, the following best practices are encouraged:
145147

0 commit comments

Comments
 (0)