Skip to content

Commit 3321bae

Browse files
committed
Revert "Removed disclaimers"
This reverts commit d98ec40.
1 parent d98ec40 commit 3321bae

File tree

1 file changed

+29
-34
lines changed

1 file changed

+29
-34
lines changed

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

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,32 @@ This article provides background information and steps to configure customer-Man
1414

1515
We recommend you review [Limitations and constraints](#limitations-and-constraints) below before configuration.
1616

17-
## Customer-managed key (CMK) overview
17+
## Disclaimers
1818

19-
The CMK capability is delivered on dedicated Log Analytics clusters. To verify that we have the required capacity in your region, we require that your subscription is whitelisted beforehand. Use your Microsoft contact to get your subscription whitelisted before you start configuring CMK.
19+
The CMK capability is delivered on dedicated Log Analytics clusters. The [Log Analytics clusters pricing model](https://docs.microsoft.com/azure/azure-monitor/platform/manage-cost-storage#log-analytics-dedicated-clusters) uses Capacity Reservations starting at a 1000 GB/day level.
2020

21-
The [Log Analytics clusters pricing model](https://docs.microsoft.com/azure/azure-monitor/platform/manage-cost-storage#log-analytics-dedicated-clusters) uses Capacity Reservations starting at a 1000 GB/day level.
21+
## Customer-managed key (CMK) overview
2222

23-
[Encryption at Rest](https://docs.microsoft.com/azure/security/fundamentals/encryption-atrest) is a common privacy and security requirement in organizations. You can let Azure completely manage Encryption at Rest, while you have various options to closely manage encryption or encryption keys.
23+
Encryption at Rest(https://docs.microsoft.com/azure/security/fundamentals/encryption-atrest) is a common privacy and security requirement in organizations. You can let Azure completely manage Encryption at Rest, while you have various options to closely manage encryption or encryption keys.
2424

2525
Azure Monitor ensures that all data is encrypted at rest using Azure-managed keys. Azure Monitor also provides an option for data encryption using your own key that is stored in your [Azure Key Vault](https://docs.microsoft.com/azure/key-vault/key-vault-overview) and accessed by Storage using system-assigned [managed identity](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview) authentication. This key can be either [software or hardware-HSM protected](https://docs.microsoft.com/azure/key-vault/key-vault-overview).
2626

27-
When using CMK, you can control the access to your data and revoke it at any time. Azure Monitor Storage always respects changes in key permissions within an hour. Data ingested in the last 14 days is also kept in hot-cache (SSD-backed) for efficient query engine operation. This data remains encrypted with Microsoft keys regardless CMK configuration, but your control over SSD data adheres to [key revocation](#cmk-kek-revocation). We are working to have SSD data encrypted with CMK in the second half of 2020.
28-
2927
Azure Monitor use of encryption is identical to the way [Azure Storage encryption](https://docs.microsoft.com/azure/storage/common/storage-service-encryption#about-azure-storage-encryption) operates.
3028

29+
Data ingested in the last 14 days is also kept in hot-cache (SSD-backed) for efficient query engine operation. This data remains encrypted with Microsoft keys regardless CMK configuration, but your control over SSD data adheres to [key revocation](#cmk-kek-revocation). We are working to have SSD data encrypted with CMK in the second half of 2020.
30+
31+
The frequency that Azure Monitor Storage accesses Key Vault for wrap and unwrap operations is between 6 to 60 seconds. Azure Monitor Storage always respects changes in key permissions within an hour.
32+
3133
## How CMK works in Azure Monitor
3234

3335
Azure Monitor leverages system-assigned managed identity to grant access
34-
to your Azure Key Vault. System-assigned managed identity can only be
35-
associated with a single Azure resource while the identity of the Log Analytics cluster is supported at the cluster level. This
36+
to your Azure Key Vault. System-assigned managed identity can only be
37+
associated with a single Azure resource. The identity of the Log Analytics cluster is supported at the cluster level and this
3638
dictates that the CMK capability is delivered on a dedicated Log Analytics cluster. To support CMK on multiple workspaces, a new Log Analytics
3739
*Cluster* resource performs as an intermediate identity connection
38-
between your Key Vault and your Log Analytics workspaces. The Log Analytics cluster storage uses the
40+
between your Key Vault and your Log Analytics workspaces, which maintains the identity between the Log Analytics cluster and your Key Vault. The Log Analytics cluster storage uses the
3941
managed identity that\'s associated with the *Cluster* resource to
40-
authenticate to your Azure Key Vault via Azure Active Directory.
41-
42-
After CMK configuration, any data ingested to workspaces associated to your *Cluster* resource gets encrypted with your key in Key Vault.
43-
44-
You can disassociate workspaces from the *Cluster* resource at any time. New data gets ingested to Log Analytics storage and encrypted with Microsoft key, while you can query your new and old data seamlessly.
42+
authenticate and access your Azure Key Vault via Azure Active Directory.
4543

4644
![CMK Overview](media/customer-managed-keys/cmk-overview-8bit.png)
4745
1. Key Vault
@@ -78,8 +76,8 @@ The following rules apply:
7876
1. Subscription whitelisting -- To assure that we have the required capacity in your region to provision a Log Analytics cluster, we need to verify and whitelist your subscription beforehand
7977
2. Creating Azure Key Vault and storing key
8078
3. Creating a *Cluster* resource
81-
4. Granting permissions to your Key Vault
82-
5. Associating Log Analytics workspaces
79+
5. Granting permissions to your Key Vault
80+
6. Associating Log Analytics workspaces
8381

8482
The procedure is not supported in the UI currently and the provisioning process is performed via REST API.
8583

@@ -283,7 +281,7 @@ details.
283281

284282
This Resource Manager request is asynchronous operation when updating Key identifier details, while it is synchronous when updating Capacity value.
285283

286-
> [!NOTE]
284+
> [!Note]
287285
> You can provide partial body in *Cluster* resource to update a *sku*, *keyVaultProperties* or *billingType*.
288286
289287
```rst
@@ -302,9 +300,9 @@ Content-type: application/json
302300
"properties": {
303301
"billingType": "cluster",
304302
"KeyVaultProperties": {
305-
"KeyVaultUri": "https://<key-vault-name>.vault.azure.net",
306-
"KeyName": "<key-name>",
307-
"KeyVersion": "<current-version>"
303+
KeyVaultUri: "https://<key-vault-name>.vault.azure.net",
304+
KeyName: "<key-name>",
305+
KeyVersion: "<current-version>"
308306
}
309307
},
310308
"location":"<region-name>"
@@ -335,9 +333,9 @@ A response to GET request on the *Cluster* resource should look like this when K
335333
},
336334
"properties": {
337335
"keyVaultProperties": {
338-
"keyVaultUri": "https://key-vault-name.vault.azure.net",
339-
"kyName": "key-name",
340-
"keyVersion": "current-version"
336+
keyVaultUri: "https://key-vault-name.vault.azure.net",
337+
kyName: "key-name",
338+
keyVersion: "current-version"
341339
},
342340
"provisioningState": "Succeeded",
343341
"clusterType": "LogAnalytics",
@@ -402,7 +400,7 @@ GET https://management.azure.com/subscriptions/<subscription-id>/resourcegroups/
402400
"name": "pricing-tier-name",
403401
"lastSkuUpdate": "Tue, 28 Jan 2020 12:26:30 GMT"
404402
},
405-
"retentionInDays": 31,
403+
"retentionInDays": days,
406404
"features": {
407405
"legacy": 0,
408406
"searchVersion": 1,
@@ -442,7 +440,7 @@ All your data remains accessible after the key rotation operation including data
442440

443441
- The max number of *Cluster* resources per region and subscription is 2
444442

445-
- You can associate a workspace to your *Cluster* resource and then disassociate it if CMK isn't required for the workspace. The number of workspace association on particular workspace in a period of 30 days is limited to 2
443+
- You can associate a workspace to your *Cluster* resource and then disassociate it when CMK for its data is no longer needed or any other reason. The number of workspace association that you can perform on a workspace in a period of 30 days is limited to 2
446444

447445
- Workspace association to *Cluster* resource should be carried ONLY after you have verified that the Log Analytics cluster provisioning was completed. Data sent to your workspace prior to the completion will be dropped and won't be recoverable.
448446

@@ -466,7 +464,7 @@ All your data remains accessible after the key rotation operation including data
466464
associated to another *Cluster* resource
467465

468466

469-
## CMK Management
467+
## Management
470468

471469
- **Get all *Cluster* resources for a resource group**
472470

@@ -493,9 +491,9 @@ All your data remains accessible after the key rotation operation including data
493491
},
494492
"properties": {
495493
"keyVaultProperties": {
496-
"keyVaultUri": "https://key-vault-name.vault.azure.net",
497-
"keyName": "key-name",
498-
"keyVersion": "current-version"
494+
keyVaultUri: "https://key-vault-name.vault.azure.net",
495+
keyName: "key-name",
496+
keyVersion: "current-version"
499497
},
500498
"provisioningState": "Succeeded",
501499
"clusterType": "LogAnalytics",
@@ -559,7 +557,6 @@ All your data remains accessible after the key rotation operation including data
559557

560558
```rest
561559
DELETE https://management.azure.com/subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/microsoft.operationalinsights/workspaces/<workspace-name>/linkedservices/cluster?api-version=2020-03-01-preview
562-
Authorization: Bearer <token>
563560
```
564561

565562
**Response**
@@ -595,9 +592,7 @@ All your data remains accessible after the key rotation operation including data
595592

596593
- Transient connection errors -- Storage handles transient errors (timeouts, connection failures, DNS issues) by allowing keys to stay in cache for a short while longer and this overcomes any small blips in availability. The query and ingestion capabilities continue without interruption.
597594

598-
- Live site -- Unavailability of about 30 minutes will cause the Storage account to become unavailable. The query capability is unavailable and ingested data is cached for several hours using Microsoft key to avoid data loss. When access to Key Vault is restored, query becomes available and the temporary cached data is ingested to the data-store and encrypted with CMK.
599-
600-
- Key Vault access rate -- The frequency that Azure Monitor Storage accesses Key Vault for wrap and unwrap operations is between 6 to 60 seconds.
595+
- Live site -- unavailability of about 30 minutes will cause the Storage account to become unavailable. The query capability is unavailable and ingested data is cached for several hours using Microsoft key to avoid data loss. When access to Key Vault is restored, query becomes available and the temporary cached data is ingested to the data-store and encrypted with CMK.
601596

602597
- If you create a *Cluster* resource and specify the KeyVaultProperties immediately, the operation may fail since the
603598
access policy can't be defined until system identity is assigned to the *Cluster* resource.
@@ -614,5 +609,5 @@ All your data remains accessible after the key rotation operation including data
614609

615610
- If you update your key version in Key Vault and don't update the new key identifier details in the *Cluster* resource, the Log Analytics cluster will keep using your previous key and your data will become inaccessible. Update new key identifier details in the *Cluster* resource to resume data ingestion and ability to query data.
616611

617-
- For questions and support related to CMK, use your Microsoft account.
612+
- For support and help related to customer managed key, use your contacts into Microsoft.
618613

0 commit comments

Comments
 (0)