Skip to content

Commit eb5d668

Browse files
authored
Merge pull request #105291 from yossi-y/patch-48
Updated CMK configuration with new API and process
2 parents ded4c81 + 1e5fa67 commit eb5d668

File tree

1 file changed

+39
-68
lines changed

1 file changed

+39
-68
lines changed

articles/azure-monitor/platform/customer-managed-keys.md

Lines changed: 39 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.subservice: logs
66
ms.topic: conceptual
77
author: yossi-y
88
ms.author: yossiy
9-
ms.date: 02/05/2020
9+
ms.date: 02/24/2020
1010

1111
---
1212
# Azure Monitor customer-managed key configuration
@@ -114,8 +114,8 @@ For Application Insights CMK configuration, follow the Appendix content for step
114114
feature
115115
2. Creating Azure Key Vault and storing key
116116
3. Create a *Cluster* resource
117-
4. Grant permissions to your Key Vault
118-
5. Azure Monitor data-store (ADX cluster) provisioning
117+
4. Azure Monitor data-store (ADX cluster) provisioning
118+
5. Grant permissions to your Key Vault
119119
6. Log Analytics workspaces association
120120

121121
The procedure is not supported in the UI currently and the provisioning process is performed via REST API.
@@ -164,7 +164,7 @@ These settings are available via CLI and PowerShell:
164164

165165
### Create *Cluster* resource
166166

167-
This resource is used as intermediate identity connection between your Key Vault and your workspaces. After you receive confirmation that your subscriptions were whitelisted, create a Log Analytics *Cluster* resource at the region where your workspaces are located. Application Insights and Log Analytics require separate Cluster resources. The type of the Cluster resource is defined at creation time by setting the “clusterType” property to either ‘LogAnalytics’, or ‘ApplicationInsights’. The Cluster resource type can’t be altered.
167+
This resource is used as intermediate identity connection between your Key Vault and your workspaces. After you receive confirmation that your subscriptions were whitelisted, create a Log Analytics *Cluster* resource at the region where your workspaces are located. Application Insights and Log Analytics require separate Cluster resources. The type of the *Cluster* resource is defined at creation time by setting the “clusterType” property to either ‘LogAnalytics’, or ‘ApplicationInsights’. The Cluster resource type can’t be altered.
168168

169169
For Application Insights CMK configuration, follow the Appendix content for this step.
170170

@@ -185,66 +185,78 @@ Content-type: application/json
185185
}
186186
}
187187
```
188+
The identity is assigned to the *Cluster* resource at creation time.
188189
"clusterType" value is "ApplicationInsights" for Application Insights CMK.
189190

190191
**Response**
191192

192-
Identity is assigned to the *Cluster* resource at creation time.
193+
202 Accepted. This is a standard Resource Manager response for asynchronous operations.
194+
195+
If you what to delete the *Cluster* resource for any reason -- for example, create it with a different name or clusterType, use this REST API:
193196

197+
```rst
198+
DELETE
199+
https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.OperationalInsights/clusters/<cluster-name>?api-version=2019-08-01-preview
200+
```
201+
202+
### Azure Monitor data-store (ADX cluster) provisioning
203+
204+
During the early access period of the feature, the ADX cluster is
205+
provisioned manually by the product team once the previous steps are
206+
completed. Use the channel you have with Microsoft to provide the *Cluster* resource details. The JSON response can be retrieved using GET REST API:
207+
208+
```rst
209+
GET https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.OperationalInsights/clusters/<cluster-name>?api-version=2019-08-01-preview
210+
Authorization: Bearer <token>
211+
```
212+
213+
**Response**
194214
```json
195215
{
196216
"identity": {
197217
"type": "SystemAssigned",
198218
"tenantId": "tenant-id",
199-
"principalId": "principle-id"
200-
},
219+
"principalId": "principal-Id"
220+
},
201221
"properties": {
202222
"provisioningState": "Succeeded",
203223
"clusterType": "LogAnalytics",
204224
"clusterId": "cluster-id"
205-
},
206-
"id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name", //The cluster resource Id
225+
},
226+
"id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name",
207227
"name": "cluster-name",
208228
"type": "Microsoft.OperationalInsights/clusters",
209229
"location": "region-name"
210-
}
211-
230+
}
212231
```
232+
213233
"principalId" is a GUID generated by the managed identity service for the *Cluster* resource.
214234

215235
> [!IMPORTANT]
216236
> Copy and keep the "cluster-id" value since you will need it in next steps.
217237
218-
If you what to delete the *Cluster* resource for any reason -- for example, create it with a different name or clusterType, use this API call:
219-
220-
```rst
221-
DELETE
222-
https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.OperationalInsights/clusters/<cluster-name>?api-version=2019-08-01-preview
223-
```
224238

225239
### Grant Key Vault permissions
226240

227-
Update your Key Vault and add access policy for the Cluster resource. Permissions to your Key Vault are then propagated to the underlaying Azure Monitor Storage to be used for data encryption.
228-
Open your Key Vault in Azure portal and click “Access Policies” then “+ Add Access Policy” to create a new policy with these settings:
241+
> [!IMPORTANT]
242+
> This step should be carried ONLY after you received confirmation from the product group through your Microsoft channel that the Azure > Monitor data-store (ADX cluster) provisioning was fulfilled. Updating Key Vault access policy prior to this provisioning, the access policy update in Key Vault will fail.
243+
244+
Update your Key Vault and add access policy for the *Cluster* resource. Permissions to your Key Vault are then propagated to the underlaying Azure Monitor Storage to be used for data encryption.
245+
Open your Key Vault in Azure portal and click "Access Policies" then "+ Add Access Policy" to create a new policy with these settings:
229246

230-
- Key permissions: select Get’, ‘Wrap Key and Unwrap Key permissions.
247+
- Key permissions: select 'Get', 'Wrap Key' and 'Unwrap Key' permissions.
231248

232-
- Select principal: enter the cluster-id, which is the "clusterId" value in the response of the previous step.
249+
- Select principal: enter the cluster-id value that returned in the response in the previous step.
233250

234251
![grant Key Vault permissions](media/customer-managed-keys/grant-key-vault-permissions.png)
235252

236253
The *Get* permission is required to verify that your Key Vault is
237254
configured as recoverable to protect your key and the access to your
238255
Azure Monitor data.
239256

240-
It takes a few minutes until the *Cluster* resource is propagated in
241-
Azure Resource Manager. When configuring this Access Policy
242-
immediately after the *Cluster* resource creation, a transient error
243-
may occur. In this case, try again after a few minutes.
244-
245257
### Update Cluster resource with Key identifier details
246258

247-
This step applies following future key version updates in your Key Vault. Update the *Cluster* resource with Key Vault *Key identifier* details, to allow Azure Monitor Storage to use the new key version. Select the current version of your key in Azure Key Vault to get the Key identifier details.
259+
This step applies for future key version updates in your Key Vault. Update the *Cluster* resource with Key Vault *Key identifier* details, to allow Azure Monitor Storage to use the new key version. Select the current version of your key in Azure Key Vault to get the Key identifier details.
248260

249261
![Grant Key Vault permissions](media/customer-managed-keys/key-identifier-8bit.png)
250262

@@ -300,47 +312,6 @@ Content-type: application/json
300312
}
301313
```
302314

303-
### Azure Monitor data-store (ADX cluster) provisioning
304-
305-
During the early access period of the feature, the ADX cluster is
306-
provisioned manually by the product team once the previous steps are
307-
completed. Use the channel you have with Microsoft to provide the
308-
following details:
309-
310-
- Confirmation that the steps above where completed successfully.
311-
312-
- The JSON response from the previous step. It can be retrieved at any time using a Get API call:
313-
314-
```rst
315-
GET https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.OperationalInsights/clusters/<cluster-name>?api-version=2019-08-01-preview
316-
Authorization: Bearer <token>
317-
```
318-
319-
**Response**
320-
```json
321-
{
322-
"identity": {
323-
"type": "SystemAssigned",
324-
"tenantId": "tenant-id",
325-
"principalId": "principal-Id"
326-
},
327-
"properties": {
328-
"KeyVaultProperties": {
329-
KeyVaultUri: "https://key-vault-name.vault.azure.net",
330-
KeyName: "key-name",
331-
KeyVersion: "current-version"
332-
},
333-
"provisioningState": "Succeeded",
334-
"clusterType": "LogAnalytics",
335-
"clusterId": "cluster-id"
336-
},
337-
"id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name",
338-
"name": "cluster-name",
339-
"type": "Microsoft.OperationalInsights/clusters",
340-
"location": "region-name"
341-
}
342-
```
343-
344315
### Workspace association to *Cluster* resource
345316

346317
> [!NOTE]

0 commit comments

Comments
 (0)