Merge pull request #102797 from yossi-y/patch-44

Some edits

Author: PRMerger14

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

@@ -178,13 +178,14 @@ Content-type: application/json
 {
   "location": "<region-name>",
    "properties": {
-      "clusterType": "LogAnalytics"   //Should be "ApplicationInsights" for Application Insights CMK
+      "clusterType": "LogAnalytics"
     },
    "identity": {
       "type": "systemAssigned"
    }
 }
 ```
+"clusterType" value is "ApplicationInsights" for Application Insights CMK.
 
 **Response**
 
@@ -195,12 +196,12 @@ Identity is assigned to the *Cluster* resource at creation time.
   "identity": {
     "type": "SystemAssigned",
     "tenantId": "tenant-id",
-    "principalId": "principle-id"    //A GUID that was generated by the managed identity service
+    "principalId": "principle-id"
   },
   "properties": {
     "provisioningState": "Succeeded",
     "clusterType": "LogAnalytics", 
-    "clusterId": "cluster-id"	 //A GUID that Log Analytics generates for the cluster
+    "clusterId": "cluster-id"
   },
   "id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name",    //The cluster resource Id
   "name": "cluster-name",
@@ -209,6 +210,8 @@ Identity is assigned to the *Cluster* resource at creation time.
 }
 
 ```
+"principalId" is a GUID generated by the managed identity service for the *Cluster* resource.
+
 > [!IMPORTANT]
 > Copy and keep the "cluster-id" value since you will need it in next steps.
 
@@ -257,7 +260,7 @@ Content-type: application/json
 
 {
    "properties": {
-       "KeyVaultProperties": {     //Key Vault key identifier details taken from Key identifier URI
+       "KeyVaultProperties": {
             KeyVaultUri: "https://<key-vault-name>.vault.azure.net",
             KeyName: "<key-name>",
             KeyVersion: "<current-version>"
@@ -269,6 +272,7 @@ Content-type: application/json
         }
 }
 ```
+"KeyVaultProperties" contains the Key Vault key identifier details.
 
 **Response**
 
@@ -277,10 +281,10 @@ Content-type: application/json
   "identity": {
     "type": "SystemAssigned",
     "tenantId": "tenant-id",
-    "principalId": "principle-id"    //A GUID that was generated by the managed identity service
+    "principalId": "principle-id"
   },
   "properties": {
-       "KeyVaultProperties": {     // Key Vault key identifier
+       "KeyVaultProperties": {
             KeyVaultUri: "https://key-vault-name.vault.azure.net",
             KeyName: "key-name",
             KeyVersion: "current-version"
@@ -289,10 +293,10 @@ Content-type: application/json
     "clusterType": "LogAnalytics", 
     "clusterId": "cluster-id"
   },
-  "id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name",    //The cluster resource Id
+  "id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name",
   "name": "cluster-name",
   "type": "Microsoft.OperationalInsights/clusters",
-  "location": "region-name"    //Example: Switzerland North
+  "location": "region-name"
 }
 ```
 
@@ -321,7 +325,7 @@ following details:
        "principalId": "principal-Id"
      },
      "properties": {
-          "KeyVaultProperties": {    // Key Vault key identifier
+          "KeyVaultProperties": {
                KeyVaultUri: "https://key-vault-name.vault.azure.net",
                KeyName: "key-name",
                KeyVersion: "current-version"
@@ -358,9 +362,9 @@ Content-type: application/json
 {
   "properties": {
     "source": "Azure",
-    "customerId": "<workspace-id>",    //Available in Azure portal under Log Analytics workspace Overview section
+    "customerId": "<workspace-id>",
     "features": {
-      "clusterDefinitionId": "<cluster-id>"    //It's the "clusterId" value provided in the respond from the previous step 
+      "clusterDefinitionId": "<cluster-id>" 
     }
   },
   "id": "/subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/microsoft.operationalinsights/workspaces/<workspace-name>",
@@ -369,6 +373,7 @@ Content-type: application/json
   "location": "<region-name>"
 }
 ```
+"clusterDefinitionId" is the "clusterId" value provided in the response from the previous step
 
 **Response**
 
@@ -381,7 +386,7 @@ Content-type: application/json
     "features": {
       "legacy": value,
       "searchVersion": value,
-      "clusterDefinitionId": "cluster-id" //The id of the Cluster resource
+      "clusterDefinitionId": "cluster-id"
     },
     "workspaceCapping": {
       "dailyQuotaGb": value,
@@ -514,7 +519,7 @@ If you update your key in Key Vault and don't update the new *Key identifier* de
 
 - If you try to delete a *Cluster* resource that is associated to a workspace, the delete operation will fail.
 
-- Use this API call to get all *Cluster* resources for a resource group:
+- Use this API to get all *Cluster* resources for a resource group:
 
   ```rst
   GET https://management.azure.com/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.OperationalInsights/clusters?api-version=2019-08-01-preview
@@ -533,8 +538,8 @@ If you update your key in Key Vault and don't update the new *Key identifier* de
           "principalId": "principal-Id"
         },
         "properties": {
-           "KeyVaultProperties": {    // Key Vault key identifier
-              KeyVaultUri: "https://{key-vault-name}.vault.azure.net",
+           "KeyVaultProperties": {
+              KeyVaultUri: "https://key-vault-name.vault.azure.net",
               KeyName: "key-name",
               KeyVersion: "current-version"
               },
@@ -635,19 +640,23 @@ Identity is assigned to the *Cluster* resource at creation time.
   "identity": {
     "type": "SystemAssigned",
     "tenantId": "tenant-id",
-    "principalId": "principle-id"    //A GUID that was generated by the managed identity service
+    "principalId": "principle-id"
   },
   "properties": {
     "provisioningState": "Succeeded",
     "clusterType": "ApplicationInsights",    //The value is ‘ApplicationInsights’ for Application Insights CMK
-    "clusterId": "cluster-id"	//A GUID that Log Analytics generates for the cluster - copy it since you need it for Key Vault and components association 
+    "clusterId": "cluster-id" 
   },
   "id": "/subscriptions/subscription-id/resourceGroups/resource-group-name/providers/Microsoft.OperationalInsights/clusters/cluster-name", //The cluster resource Id
   "name": "cluster-name",
   "type": "Microsoft.OperationalInsights/clusters",
   "location": "region-name"
 }
 ```
+"principalId" is a GUID that was generated by the managed identity service.
+
+> [!IMPORTANT]
+> Copy and keep the "cluster-id" value since you will need it in next steps.
 
 ### Associate a component to a *Cluster* resource using [Components - Create Or Update](https://docs.microsoft.com/rest/api/application-insights/components/createorupdate) API
 
@@ -658,12 +667,14 @@ Content-type: application/json
 
 {
   "properties": {
-    "clusterDefinitionId": "cluster-id"    //It's the "clusterId" value provided in the respond from the previous step
+    "clusterDefinitionId": "cluster-id"
   },
   "location": "<region-name>",
-  "kind": "<component-type>",    //Example: web
+  "kind": "<component-type>"
 }
 ```
+"clusterDefinitionId" is the "clusterId" value provided in the respond from the previous step.
+"kind" example is "web".
 
 **Response**
 
@@ -676,7 +687,7 @@ Content-type: application/json
   "tags": "",
   "kind": "",
   "properties": {
-    "clusterDefinitionId": "cluster-id"    //The Cluster resource ID that is associated to this component
+    "clusterDefinitionId": "cluster-id"
     "ApplicationId": "",
     "AppId": "",
     "Application_Type": "",
@@ -696,5 +707,6 @@ Content-type: application/json
   }
 }
 ```
+"clusterDefinitionId" is the *Cluster* resource ID that is associated to this component.
 
 After the association, data that is sent to your components is stored encrypted with your managed key.