Skip to content

Commit 8f0e6ad

Browse files
authored
Merge pull request #119809 from Amitbergman/patch-2
improve CMK documentation of microsoft sentinel
2 parents d16bb9c + 626f96d commit 8f0e6ad

File tree

1 file changed

+15
-28
lines changed

1 file changed

+15
-28
lines changed

articles/sentinel/customer-managed-keys.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Set up customer-managed keys in Microsoft Sentinel| Microsoft Docs
3-
description: Learn how to set up customer-managed keys (CMK) in Microsoft Sentinel.
3+
description: Learn how to set up customer-managed key (CMK) in Microsoft Sentinel.
44
author: yelevin
55
ms.topic: how-to
66
ms.date: 06/08/2023
@@ -14,9 +14,8 @@ This article provides background information and steps to configure a [customer-
1414
## Prerequisites
1515

1616
1. Configure a Log Analytics dedicated cluster with at least a 100 GB/day commitment tier. When multiple workspaces are linked to the same dedicated cluster, they share the same customer-managed key. Learn about [Log Analytics Dedicated Cluster Pricing](../azure-monitor/logs/logs-dedicated-clusters.md#cluster-pricing-model).
17-
1. Configure the CMK within Azure Monitor. Don't onboard the workspace to Sentinel yet. Learn about the [CMK provisioning steps](../azure-monitor/logs/customer-managed-keys.md?tabs=portal#customer-managed-key-provisioning-steps).
18-
1. Contact the [Microsoft Sentinel Product Group](mailto:[email protected]) - you must receive onboarding confirmation as part of completing the steps in this guide before you use the workspace.
19-
17+
1. Configure CMK on the dedicated cluster and link your workspace to that cluster. Learn about the [CMK provisioning steps in Azure Monitor](../azure-monitor/logs/customer-managed-keys.md?tabs=portal#customer-managed-key-provisioning-steps).
18+
2019
## Considerations
2120

2221
- Onboarding a CMK workspace to Sentinel is supported only via REST API, and not via the Azure portal. Azure Resource Manager templates (ARM templates) currently aren't supported for CMK onboarding.
@@ -56,46 +55,34 @@ For more information, see:
5655
5756
## Enable CMK
5857

59-
To provision CMK, follow these steps: 
60-
1. Create an Azure Key Vault and generate or import a key.
61-
1. Enable CMK on your Log Analytics workspace.
58+
To provision CMK, follow these steps:
59+
1. Make sure you have a Log Analytics workspace, and that it's linked to a dedicated cluster on which CMK is enabled. (See [Prerequisites](#prerequisites).)
6260
1. Register to the Azure Cosmos DB Resource Provider.
6361
1. Add an access policy to your Azure Key Vault instance.
6462
1. Onboard the workspace to Microsoft Sentinel via the [Onboarding API](/rest/api/securityinsights/preview/sentinel-onboarding-states/create).
6563
1. Contact the Microsoft Sentinel Product group to confirm onboarding.
6664

67-
### Step 1: Create an Azure Key Vault and generate or import a key
68-
69-
1. [Create Azure Key Vault resource](/azure-stack/user/azure-stack-key-vault-manage-portal), then generate or import a key to be used for data encryption.
70-
71-
> [!NOTE]
72-
> Azure Key Vault must be configured as recoverable to protect your key and the access.
73-
74-
1. [Turn on recovery options:](../key-vault/general/key-vault-recovery.md)
75-
76-
- Make sure [Soft Delete](../key-vault/general/soft-delete-overview.md) is turned on.
77-
78-
- Turn on [Purge protection](../key-vault/general/soft-delete-overview.md#purge-protection) to guard against forced deletion of the secret/vault even after soft delete.
79-
80-
### Step 2: Enable CMK on your Log Analytics workspace
65+
### Step 1: Configure CMK on a Log Analytics workspace on a dedicated cluster
8166

67+
As mentioned in the [prerequisites](#prerequisites), to onboard a Log Analytics workspace with CMK to Microsoft Sentinel, this workspace must first be linked to a dedicated Log Analytics cluster on which CMK is enabled.
68+
Microsoft Sentinel will use the same key used by the dedicated cluster.
8269
Follow the instructions in [Azure Monitor customer-managed key configuration](../azure-monitor/logs/customer-managed-keys.md) in order to create a CMK workspace that is used as the Microsoft Sentinel workspace in the following steps.
8370

84-
### Step 3: Register the Azure Cosmos DB Resource Provider
71+
### Step 2: Register the Azure Cosmos DB Resource Provider
8572

86-
Microsoft Sentinel works with Azure Cosmos DB as an additional storage resource. Make sure to register to the Azure Cosmos DB Resource Provider.
73+
Microsoft Sentinel works with Azure Cosmos DB as an additional storage resource. Make sure to register to the Azure Cosmos DB Resource Provider before onboarding a CMK workspace to Microsoft Sentinel.
8774

8875
Follow the instructions to [Register the Azure Cosmos DB Resource Provider](../cosmos-db/how-to-setup-cmk.md#register-resource-provider) for your Azure subscription.
8976

90-
### Step 4: Add an access policy to your Azure Key Vault instance
77+
### Step 3: Add an access policy to your Azure Key Vault instance
9178

92-
Add an access policy that allows your Azure Cosmos DB to access the Azure Key Vault instance created in [**STEP 1**](#step-1-create-an-azure-key-vault-and-generate-or-import-a-key).
79+
Add an access policy that allows Azure Cosmos DB to access the Azure Key Vault instance that is linked to your dedicated Log Analytics cluster (the same key will be used by Microsoft Sentinel).
9380

9481
Follow the instructions here to [add an access policy to your Azure Key Vault instance](../cosmos-db/how-to-setup-cmk.md#add-access-policy) with an Azure Cosmos DB principal.
9582

9683
:::image type="content" source="../cosmos-db/media/how-to-setup-customer-managed-keys/add-access-policy-principal.png" lightbox="../cosmos-db/media/how-to-setup-customer-managed-keys/add-access-policy-principal.png" alt-text="Screenshot of the Select principal option on the Add access policy page.":::
9784

98-
### Step 5: Onboard the workspace to Microsoft Sentinel via the onboarding API
85+
### Step 4: Onboard the workspace to Microsoft Sentinel via the onboarding API
9986

10087
Onboard the CMK enabled workspace to Microsoft Sentinel via the [onboarding API](/rest/api/securityinsights/preview/sentinel-onboarding-states/create) using the `customerManagedKey` property as `true`. For more context on the onboarding API, see [this document](https://github.com/Azure/Azure-Sentinel/raw/master/docs/Azure%20Sentinel%20management.docx) in the Microsoft Sentinel GitHub repo.
10188

@@ -115,9 +102,9 @@ PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{
115102
}
116103
```
117104

118-
### Step 6: Contact the Microsoft Sentinel Product group to confirm onboarding
105+
### Step 5: Contact the Microsoft Sentinel Product group to confirm onboarding
119106

120-
Lastly, you must confirm the onboarding status of your CMK enabled workspace by contacting the [Microsoft Sentinel Product Group](mailto:[email protected]).
107+
Lastly, confirm the onboarding status of your CMK-enabled workspace by contacting the [Microsoft Sentinel Product Group](mailto:[email protected]).
121108

122109
## Key Encryption Key revocation or deletion
123110

0 commit comments

Comments
 (0)