|
1 | 1 | ---
|
2 |
| -title: Data encryption for Azure Database for PostgreSQL - Single server troubleshooting |
3 |
| -description: Learn how to troubleshoot the data encryption for your Azure Database for PostgreSQL - Single server |
| 2 | +title: Troubleshoot data encryption in Azure Database for PostgreSQL - Single Server |
| 3 | +description: Learn how to troubleshoot the data encryption on your Azure Database for PostgreSQL - Single Server |
4 | 4 | author: kummanish
|
5 | 5 | ms.author: manishku
|
6 | 6 | ms.service: postgresql
|
7 | 7 | ms.topic: conceptual
|
8 | 8 | ms.date: 02/13/2020
|
9 | 9 | ---
|
10 | 10 |
|
11 |
| -# Troubleshooting data encryption with customer-managed keys in Azure Database for PostgreSQL - Single server |
12 |
| -This article describes how to identify and resolve common issues/errors that occur on an Azure Database for PostgreSQL - Single server configured with Data Encryption using customer-managed key. |
| 11 | +# Troubleshoot data encryption in Azure Database for PostgreSQL - Single Server |
13 | 12 |
|
14 |
| -## Introduction |
15 |
| -When data encryption is configured to use a customer-managed key in Azure Key Vault, continuous access to this key is required for the server to stay available. If the server loses access to the customer-managed key in Azure Key Vault, the server will start denying all connections with the appropriate error message and change its state to ***Inaccessible*** in the Azure portal. |
| 13 | +This article helps you identify and resolve common issues that can occur in the single-server deployment of Azure Database for PostgreSQL when configured with data encryption using a customer-managed key. |
16 | 14 |
|
17 |
| -If an inaccessible Azure Database for PostgreSQL - Single server is no longer needed, it can be deleted immediately to stop incurring costs. All other actions on the server are not permitted until access to the Azure key vault has been restored and the server is back available. Changing the data encryption option from ‘Yes’(customer-managed) to ‘No’ (service-managed) on an inaccessible the server is also not possible while a server is encrypted with customer-managed. You must revalidate the key manually to make the server back available. This is necessary to protect the data from unauthorized access while permissions to the customer-managed key have been revoked. |
| 15 | +## Introduction |
18 | 16 |
|
19 |
| -## Common errors causing server to become inaccessible |
| 17 | +When you configure data encryption to use a customer-managed key in Azure Key Vault, the server requires continuous access to the key. If the server loses access to the customer-managed key in Azure Key Vault, it will deny all connections, return the appropriate error message, and change its state to ***Inaccessible*** in the Azure portal. |
20 | 18 |
|
21 |
| -Most issues that occur when you use data encryption with Azure Key Vault are caused by one of the following misconfigurations- |
| 19 | +If you no longer need an inaccessible Azure Database for PostgreSQL server, you can delete it to stop incurring costs. No other actions on the server are permitted until access to the key vault has been restored and the server is available. It's also not possible to change the data encryption option from `Yes`(customer-managed) to `No` (service-managed) on an inaccessible server when it's encrypted with a customer-managed key. You'll have to revalidate the key manually before the server is accessible again. This action is necessary to protect the data from unauthorized access while permissions to the customer-managed key are revoked. |
22 | 20 |
|
23 |
| -The key vault is unavailable or doesn't exist |
| 21 | +## Common errors causing server to become inaccessible |
24 | 22 |
|
25 |
| -* The key vault was accidentally deleted. |
26 |
| -* An intermittent network error causes the key vault to be unavailable. |
| 23 | +The following misconfigurations cause most issues with data encryption that use Azure Key Vault keys: |
27 | 24 |
|
28 |
| -No permissions to access the key vault or the key doesn't exist |
| 25 | +- The key vault is unavailable or doesn't exist: |
| 26 | + - The key vault was accidentally deleted. |
| 27 | + - An intermittent network error causes the key vault to be unavailable. |
29 | 28 |
|
30 |
| -* The key was accidentally deleted, disabled or the key expired. |
31 |
| -* The Azure Database for PostgreSQL - Single server instance-managed identity was accidentally deleted. |
32 |
| -* Permissions granted to the Azure Database for PostgreSQL managed identity for the keys aren't sufficient (they don't include Get, Wrap, and Unwrap). |
33 |
| -* Permissions for the Azure Database for PostgreSQL Single server instance-managed identity were revoked or deleted. |
| 29 | +- You don't have permissions to access the key vault or the key doesn't exist: |
| 30 | + - The key expired or was accidentally deleted or disabled. |
| 31 | +- The managed identity of the Azure Database for PostgreSQL instance was accidentally deleted. |
| 32 | + - The managed identity of the Azure Database for PostgreSQL instance has insufficient key permissions. For example, the permissions don't include Get, Wrap, and Unwrap. |
| 33 | + - The managed identity permissions to the Azure Database for PostgreSQL instance were revoked or deleted. |
34 | 34 |
|
35 | 35 | ## Identify and resolve common errors
|
| 36 | + |
36 | 37 | ### Errors on the key vault
|
37 | 38 |
|
38 | 39 | #### Disabled key vault
|
39 |
| -* AzureKeyVaultKeyDisabledMessage |
40 |
| -* **Explanation** : The operation could not be completed on server because the Azure Key Vault key is disabled. |
| 40 | + |
| 41 | +- `AzureKeyVaultKeyDisabledMessage` |
| 42 | +- **Explanation**: The operation couldn't be completed on server because the Azure Key Vault key is disabled. |
41 | 43 |
|
42 | 44 | #### Missing key vault permissions
|
43 |
| -* AzureKeyVaultMissingPermissionsMessage |
44 |
| -* The server does not have the required Get, Wrap, and Unwrap permissions to the Azure Key Vault permissions. Grant any missing permissions to the service principal with ID. |
| 45 | + |
| 46 | +- `AzureKeyVaultMissingPermissionsMessage` |
| 47 | +- **Explanation**: The server doesn't have the required Get, Wrap, and Unwrap permissions to Azure Key Vault. Grant any missing permissions to the service principal with ID. |
45 | 48 |
|
46 | 49 | ### Mitigation
|
47 |
| -* Confirm that the customer-managed key is present in Key Vault: |
48 |
| -* Identify the key vault, then go to the key vault in the Azure portal. |
49 |
| -* Ensure that the key identified by the key URI is present. |
50 | 50 |
|
| 51 | +- Confirm that the customer-managed key is present in the key vault. |
| 52 | +- Identify the key vault, then go to the key vault in the Azure portal. |
| 53 | +- Ensure that the key URI identifies a key that is present. |
51 | 54 |
|
52 | 55 | ## Next steps
|
53 |
| -[Set up data encryption with a customer-managed key for your Azure database for PostgreSQL by using the Azure portal](howto-data-encryption-portal.md). |
| 56 | + |
| 57 | +[Use the Azure portal to set up data encryption with a customer-managed key on Azure Database for PostgreSQL](howto-data-encryption-portal.md) |
0 commit comments