Skip to content

Commit 2f69bd3

Browse files
Fix unallowed syntax
1 parent 6543514 commit 2f69bd3

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

articles/synapse-analytics/security/workspaces-encryption.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,13 @@ Workspaces can be configured to enable double encryption with a customer-managed
5050
5151
:::image type="content" source="media/workspaces-encryption/workspaces-encryption.png" alt-text="This diagram shows the option that must be selected to enable a workspace for double encryption with a customer-managed key." lightbox="media/workspaces-encryption/workspaces-encryption.png":::
5252

53-
---
54-
5553
## Prerequisites: Key Rotation and SQL Pool Status
5654

5755
> [!WARNING]
5856
> **Before changing the encryption key of your workspace:**
5957
>
6058
> - **Ensure all dedicated SQL pools are in the Online state.** Offline pools will not be re-encrypted and cannot resume if the old key or key version is deleted, disabled, or expired.
61-
> - **Retain all old keys and key versions** used for encryption until every SQL pool has been brought online and re-encrypted with the new key. Only disable or delete the old key after all pools have successfully rotated to the new key.
59+
> - **Retain all old keys and key versions** used for encryption until every SQL pool is brought online and re-encrypted with the new key. Only disable or delete the old key after all pools have successfully rotated to the new key.
6260
>
6361
> ⚠️ *Failure to follow these prerequisites may result in SQL pools being permanently inaccessible, or backup data becoming unrecoverable.*
6462
@@ -72,8 +70,6 @@ Workspaces can be configured to enable double encryption with a customer-managed
7270
| 4 | Verify all pools are re-encrypted ||
7371
| 5 | Safely disable old key or key version (after all pools done) ||
7472

75-
---
76-
7773
## Key management best practices
7874

7975
> [!IMPORTANT]
@@ -86,37 +82,38 @@ Workspaces can be configured to enable double encryption with a customer-managed
8682
>
8783
> **To ensure a smooth CMK rotation,** if some SQL pools are offline during the process, the old key or key version should remain enabled and have its expiration date set in the future. This is crucial until the offline pools are successfully resumed and re-encrypted with the new key or key version.
8884
>
89-
> **Do not delete old keys or key versions** until all pools and backups have been successfully re-encrypted and validated. Only *disable* the old key after all requirements are met.
90-
91-
---
85+
> **Do not delete old keys or key versions** until all pools and backups are successfully re-encrypted and validated. Only *disable* the old key after all requirements are met.
9286
9387
### Key Rotation Troubleshooting
9488

9589
If a SQL pool is stuck offline after a key rotation:
9690

9791
1. **Check the SQL pool key version** using PowerShell to confirm which key or key version the pool is expecting:
92+
9893
```powershell
9994
Get-AzSqlServerTransparentDataEncryptionProtector -ServerName 'ContosoServer' -ResourceGroupName 'WORKSPACE_MANAGED_RESOURCE_GROUP'
10095
```
101-
> **Note:**
102-
> The `ResourceGroupName` refers to the workspace's **managed resource group**. You can find this in the Azure portal by selecting your Synapse workspace and viewing the `managedResourceGroup` value in the JSON view.
96+
> [!NOTE]
97+
> The `ResourceGroupName` refers to the workspace's **managed resource group**. You can find this in the Azure portal by selecting your Synapse workspace and viewing the `managedResourceGroup` value in the JSON view.
98+
10399
2. **Enable** the required old key or key version in Azure Key Vault.
104100
3. **Set an expiration date** in the future for the old key or key version.
105101
4. Resume the SQL pool.
106102
5. Once the pool is back online, allow it to re-encrypt with the new key.
107103
6. **Verify the encryption status** of each database by running the following T-SQL query in your SQL pool:
104+
108105
```sql
109106
SELECT
110107
[name],
111108
[is_encrypted]
112109
FROM
113110
sys.databases;
114111
```
112+
115113
- The `is_encrypted` column will show the encryption status (`1` = encrypted, `0` = not encrypted).
114+
116115
7. After confirming all pools and backups are accessible and encrypted, you may safely disable (not delete) the old key or key version.
117116
118-
---
119-
120117
### Key access and workspace activation
121118
122119
The Azure Synapse encryption model with customer-managed keys involves the workspace accessing the keys in Azure Key Vault to encrypt and decrypt as needed. The keys are made accessible to the workspace either through an access policy or [Azure Key Vault RBAC](/azure/key-vault/general/rbac-guide). When granting permissions via an Azure Key Vault access policy, choose the ["Application-only"](/azure/key-vault/general/security-features#key-vault-authentication-options) option during policy creation (select the workspaces managed identity and do not add it as an authorized application).
@@ -126,6 +123,7 @@ The workspace managed identity must be granted the permissions it needs on the k
126123
<a id="using-a-user-assigned-managed-identity"></a>
127124
128125
#### Use a User-assigned Managed identity
126+
129127
Workspaces can be configured to use a [User-assigned Managed identity](../../active-directory/managed-identities-azure-resources/overview.md) to access your customer-managed key stored in Azure Key Vault. Configure a User-assigned Managed identity to avoid phased activation of your Azure Synapse workspace when using double encryption with customer-managed keys. The Managed Identity Contributor built-in role is required to assign a user-assigned managed identity to an Azure Synapse workspace.
130128
131129
> [!NOTE]
@@ -190,4 +188,4 @@ Use the following cmdlets for Azure Synapse workspace.
190188
## Related content
191189
192190
- [Use built-in Azure Policies to implement encryption protection for Synapse workspaces](../policy-reference.md)
193-
- [Create an Azure key vault and a key by using Resource Manager template](/azure/key-vault/keys/quick-create-template)
191+
- [Create an Azure key vault and a key by using Resource Manager template](/azure/key-vault/keys/quick-create-template)

0 commit comments

Comments
 (0)