Skip to content

Commit f3626a3

Browse files
committed
fix the block issues
1 parent 9bc1acb commit f3626a3

9 files changed

+31
-31
lines changed

articles/synapse-analytics/spark/apache-spark-azure-log-analytics.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ spark.synapse.diagnostic.emitter.LA.secret: <LOG_ANALYTICS_WORKSPACE_KEY>
5757
#### Option 2: Configure with Azure Key Vault
5858

5959
> [!NOTE]
60-
> You need to grant read secret permission to the users who will submit Apache Spark applications. For more information, see [Provide access to Key Vault keys, certificates, and secrets with an Azure role-based access control](/azure/key-vault/general/rbac-guide). When you enable this feature in a Synapse pipeline, you need to use **Option 3**. This is necessary to obtain the secret from Azure Key Vault with workspace managed identity.
60+
> You need to grant read secret permission to the users who submit Apache Spark applications. For more information, see [Provide access to Key Vault keys, certificates, and secrets with an Azure role-based access control](/azure/key-vault/general/rbac-guide). When you enable this feature in a Synapse pipeline, you need to use **Option 3**. This is necessary to obtain the secret from Azure Key Vault with workspace managed identity.
6161
6262
To configure Azure Key Vault to store the workspace key, follow these steps:
6363

6464
1. Create and go to your key vault in the Azure portal.
65-
1. Grant the right permission to the users or workspace managed identites.
65+
1. Grant the right permission to the users or workspace managed identities.
6666
1. On the settings page for the key vault, select **Secrets**.
6767
1. Select **Generate/Import**.
6868
1. On the **Create a secret** screen, choose the following values:
@@ -146,7 +146,7 @@ You can create an Apache Spark Configuration to your workspace, and when you cre
146146
1. Select **New** button to create a new Apache Spark configuration.
147147
1. **New Apache Spark configuration** page will be opened after you select **New** button.
148148

149-
:::image type="content" source="./media/apache-spark-azure-log-analytics/create-spark-configuration.png" alt-text="Screenshot that create spark configuration.":::
149+
:::image type="content" source="./media/apache-spark-azure-log-analytics/create-spark-configuration.png" alt-text="Screenshot that creates Spark configuration.":::
150150

151151
1. For **Name**, you can enter your preferred and valid name.
152152
1. For **Description**, you can input some description in it.
@@ -277,7 +277,7 @@ You can follow below steps to create a managed private endpoint connection to Az
277277
1. Navigate to your AMPLS in Azure portal again, on the **Private Endpoint connections** page, select the connection provisioned and **Approve**.
278278

279279
> [!NOTE]
280-
> - The AMPLS object has a number of limits you should consider when planning your Private Link setup. See [AMPLS limits](/azure/azure-monitor/logs/private-link-security) for a deeper review of these limits.
280+
> - The AMPLS object has many limits you should consider when planning your Private Link setup. See [AMPLS limits](/azure/azure-monitor/logs/private-link-security) for a deeper review of these limits.
281281
> - Check if you have [right permission](../security/synapse-workspace-access-control-overview.md) to create managed private endpoint.
282282
283283
## Available configurations
@@ -291,7 +291,7 @@ You can follow below steps to create a managed private endpoint connection to Az
291291
| `spark.synapse.diagnostic.emitter.<destination>.secret` | Optional. The secret (Log Aanalytics key) content. To find this, in the Azure portal, go to Azure Log Analytics workspace > Agents > Primary key. |
292292
| `spark.synapse.diagnostic.emitter.<destination>.secret.keyVault` | Required if `.secret` is not specified. The [Azure Key vault](/azure/key-vault/general/overview) name where the secret (AccessKey or SAS) is stored. |
293293
| `spark.synapse.diagnostic.emitter.<destination>.secret.keyVault.secretName` | Required if `.secret.keyVault` is specified. The Azure Key vault secret name where the secret is stored. |
294-
| `spark.synapse.diagnostic.emitter.<destination>.secret.keyVault.linkedService` | Optional. The Azure Key vault linked service name. When enabled in Synapse pipeline, this is necessary to obtain the secret from AKV. (Please make sure MSI has read permission on the AKV). |
294+
| `spark.synapse.diagnostic.emitter.<destination>.secret.keyVault.linkedService` | Optional. The Azure Key vault linked service name. When enabled in Synapse pipeline, this is necessary to obtain the secret from Azure Key vault. (Make sure the MSI has read access to the Azure Key vault). |
295295
| `spark.synapse.diagnostic.emitter.<destination>.filter.eventName.match` | Optional. The comma-separated Log4j logger names, you can specify which logs to collect. For example `SparkListenerApplicationStart,SparkListenerApplicationEnd` |
296296
| `spark.synapse.diagnostic.emitter.<destination>.filter.loggerName.match` | Optional. The comma-separated log4j logger names, you can specify which logs to collect. For example: `org.apache.spark.SparkContext,org.example.Logger` |
297297
| `spark.synapse.diagnostic.emitter.<destination>.filter.metricName.match` | Optional. The comma-separated spark metric name suffixes, you can specify which metrics to collect. For example:`jvm.heap.used` |

articles/synapse-analytics/spark/how-to-use-certsp-emit-log-to-eventhub.md renamed to articles/synapse-analytics/spark/how-to-use-certificate-with-service-principalp-emit-log-event-hubs.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: How to use cert+sp emit log to eventhub
3-
description: Learn to setting up Azure services, particularly focusing on integrating Azure Synapse with Event Hubs and Key Vault.
2+
title: How to use certificate and Service Principal emit log to Azure Event Hubs
3+
description: Learn to setting up Azure services, particularly focusing on integrating Azure Synapse with Azure Event Hubs and Key Vault.
44
author: jejiang
55
ms.author: jejiang
66
ms.reviewer: whhender
77
ms.topic: tutorial
88
ms.date: 03/24/2025
99
---
1010

11-
# How to use certificate and Service Principal emit log to eventhub
11+
# How to use certificate and service principal emit log to Azure Event Hubs
1212

1313
## Prerequisites
1414

15-
- An Azure subscription. If you don't have one, [create a free account](https://azure.microsoft.com/free/) before you begin.
16-
- [Synapse Analytics workspace](/azure/synapse-analytics/get-started-create-workspace)
17-
- If you are new to Azure Event Hubs, read through [Event Hubs overview](/azure/event-hubs/event-hubs-about) and [Event Hubs features](/azure/event-hubs/event-hubs-features).
15+
- An Azure subscription. You can also [create a free account](https://azure.microsoft.com/free/) before you get started.
16+
- [Synapse Analytics workspace](/azure/synapse-analytics/get-started-create-workspace).
17+
- [Azure Event Hubs](/azure/event-hubs/event-hubs-about).
1818
- [Azure Key Vault](/azure/key-vault/general/overview)
1919
- [App Registration](https://ms.portal.azure.com/#view/Microsoft_AAD_RegisteredApps/ApplicationsListBlade)
2020

@@ -28,17 +28,17 @@ ms.date: 03/24/2025
2828
1. Sign in to the [Azure portal](https://portal.azure.com/) and go to [App registrations](/entra/identity-platform/quickstart-register-app#register-an-application).
2929
2. Create a new app registration for your Synapse workspace.
3030

31-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\create-a-new-app-registration.png" alt-text="Screenshot showing create a new app registration.":::
31+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\create-a-new-app-registration.png" alt-text="Screenshot showing create a new app registration.":::
3232

33-
## Step 2. Generate a Certificate in Key Vault
33+
## Step 2. Generate a certificate in Key Vault
3434

3535
1. Navigate to Key Vault.
3636
2. Expand the **Object**, and select the **Certificates**.
3737
3. Click on **Generate/Import**.
3838

39-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\generate-a-new-certificate.png" alt-text="Screenshot showing generate a new certificate for app.":::
39+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\generate-a-new-certificate.png" alt-text="Screenshot showing generate a new certificate for app.":::
4040

41-
## Step 3. Trust the Certificate in the Application
41+
## Step 3. Trust the certificate in the application
4242

4343
1. Go to the app created in Step 1 -> **Manage** -> **Manifest**.
4444
2. Append the certificate details to the manifest file to establish trust.
@@ -53,27 +53,27 @@ ms.date: 03/24/2025
5353
]
5454
```
5555
56-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\trust-the-certificate.png" alt-text="Screenshot showing trust the certificate in the application.":::
56+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\trust-the-certificate.png" alt-text="Screenshot showing trust the certificate in the application.":::
5757
5858
## Step 4. Assign Azure Event Hubs Data Sender Role
5959
60-
1. In Event Hub, navigate to Access control (IAM).
61-
2. Assign the app (Service Principal) with the Azure Event Hubs Data Sender role.
60+
1. In Azure Event Hubs, navigate to Access control (IAM).
61+
2. Assign the Azure Event Hubs data sender role to the application (service principal).
6262
63-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\assign-azure-event-hubs-data-sender-role.png" alt-text="Screenshot showing assign azure event hubs data sender role.":::
63+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\assign-azure-event-hubs-data-sender-role.png" alt-text="Screenshot showing assign Azure event hubs data sender role.":::
6464
65-
## Step 5. Create a Linked Service in Synapse
65+
## Step 5. Create a linked service in Synapse
6666
67-
1. In Synapse Analytics workspace, go to **Manage** -> **Linked service**.
68-
2. Create a new **Linked Service** in Synapse to connect to **Key Vault**.
67+
1. In Synapse Analytics workspace, go to **Manage** -> **linked service**.
68+
2. Create a new **linked Service** in Synapse to connect to **Key Vault**.
6969
70-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\create-a-linked-service-in-synapse.png" alt-text="Screenshot showing create a linked service in synapse.":::
70+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\create-a-linked-service-in-synapse.png" alt-text="Screenshot showing create a linked service in synapse.":::
7171
72-
## Step 6. Assign Reader Role to Linked Service in Key Vault
72+
## Step 6. Assign reader role to linked service in Key Vault
7373
74-
1. Get the workspace managed identity ID from the linked service. The **managed identity name** and **object ID** for the linked service is under **Edit Linked Service**.
74+
1. Get the workspace managed identity ID from the linked service. The **managed identity name** and **object ID** for the linked service is under **Edit linked service**.
7575
76-
:::image type="content" source="media\how-to-use-certsp-emit-log-to-eventhub\managed-identity-name-and-object-id.png" alt-text="Screenshot showing managed identity name and object id are in edit linked service.":::
76+
:::image type="content" source="media\how-to-use-certificate-with-service-principalp-emit-log-event-hubs\managed-identity-name-and-object-id.png" alt-text="Screenshot showing managed identity name and object ID are in edit linked service.":::
7777
7878
2. In **Key Vault**, assign the linked service a **Reader** role.
7979
@@ -84,10 +84,10 @@ Gather the following values and add to the Apache Spark configuration.
8484
- **<EMITTER_NAME>**: The name for the emmiter.
8585
- **<CERTIFICATE_NAME>**: The certificate name that you generated in the key vault.
8686
- **<LINKED_SERVICE_NAME>**: The Azure Key vault linked service name.
87-
- **<EVENT_HUB_HOST_NAME>**: The Event Hub host name, you can find it in Event Hubs Namespace -> Overview -> Host name.
88-
- **<SERVICE_PRINCIPAL_TENANT_ID>**: The service principal tenant id, you can find it in App registrations -> your app name -> Overview -> Directory (tenant) ID
89-
- **<SERVICE_PRINCIPAL_CLIENT_ID>**: The service principal client id, you can find it in registrations -> your app name -> Overview -> Application(client) ID
90-
- **<EVENT_HUB_ENTITY_PATH>**: The Event Hub entity path, you can find it in Event Hubs Namespace -> Overview -> Host name.
87+
- **<EVENT_HUB_HOST_NAME>**: The Azure Event Hubs host name, you can find it in Azure Event Hubs Namespace -> Overview -> Host name.
88+
- **<SERVICE_PRINCIPAL_TENANT_ID>**: The service principal tenant ID, you can find it in App registrations -> your app name -> Overview -> Directory (tenant) ID
89+
- **<SERVICE_PRINCIPAL_CLIENT_ID>**: The service principal client ID, you can find it in registrations -> your app name -> Overview -> Application(client) ID
90+
- **<EVENT_HUB_ENTITY_PATH>**: The Azure Event Hubs entity path, you can find it in Azure Event Hubs Namespace -> Overview -> Host name.
9191
9292
```
9393
"spark.synapse.diagnostic.emitters": <EMITTER_NAME>,

articles/synapse-analytics/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@ items:
817817
- name: Collect Apache Spark applications logs and metrics with Azure Event Hubs
818818
href: ./spark/azure-synapse-diagnostic-emitters-azure-eventhub.md
819819
- name: Collect Apache Spark applications logs and metrics by certificate and service principal
820-
href: ./spark/how-to-use-certsp-emit-log-to-eventhub.md
820+
href: ./spark/how-to-use-certificate-with-service-principalp-emit-log-event-hubs.md
821821
- name: Manage Apache Spark configuration
822822
href: ./spark/apache-spark-azure-create-spark-configuration.md
823823
- name: Apache Spark Advisor

0 commit comments

Comments
 (0)