Merge pull request #266753 from enkrumah/patch-55

Update stream-analytics-define-kafka-input.md

Author: prmerger-automator[bot]

articles/stream-analytics/kafka-output.md

@@ -5,14 +5,28 @@ author: enkrumah
 ms.author: ebnkruma
 ms.service: stream-analytics
 ms.topic: conceptual
-ms.date: 01/18/2024
+ms.date: 02/20/2024
 ---
 
 # Kafka output from Azure Stream Analytics (Preview)
 
 Azure Stream Analytics allows you to connect directly to Kafka clusters as a producer to output data. The solution is low code and entirely managed by the Azure Stream Analytics team at Microsoft, allowing it to meet business compliance standards. The ASA Kafka output is backward compatible and supports all versions with the latest client release starting from version 0.10. Users can connect to Kafka clusters inside a VNET and Kafka clusters with a public endpoint, depending on the configurations. The configuration relies on existing Kafka configuration conventions.
 Supported compression types are None, Gzip, Snappy, LZ4, and Zstd.
 
+## Steps
+This article shows how to set up Kafka as an output from Azure Stream Analytics. There are six steps:
+
+1. Create an Azure Stream Analytics job.
+2. Configure your Azure Stream Analytics job to use managed identity if you are using mTLS or SASL_SSl security protocols.
+3. Configure Azure Key vault if you are using mTLS or SASL_SSl security protocols.
+4. Upload certificates as secrets into Azure Key vault.
+5. Grant Azure Stream Analytics permissions to access the uploaded certificate.
+6. Configure Kafka output in your Azure Stream Analytics job.
+
+> [!NOTE]
+> Depending on how your Kafka cluster is configured and the type of Kafka cluster you are using, some of the above steps may not apply to you. Examples are: if you are using confluent cloud Kafka, you will not need to upload a certificate to use the Kafka connector. If your Kafka cluster is inside a virtual network (VNET) or behind a firewall, you may have to configure your Azure Stream Analytics job to access your Kafka topic using a private link or a dedicated networking configuration.
+
+
 ## Configuration
 The following table lists the property names and their description for creating a Kafka output: 
 
@@ -26,6 +40,9 @@ The following table lists the property names and their description for creating
 | Partition key                | Azure Stream Analytics assigns partitions using round partitioning.                                                     |
 | Kafka event compression type | The compression type used for outgoing data streams, such as Gzip, Snappy, Lz4, Zstd, or None.                            | 
 
+:::image type="content" source="./media/kafka/kafka-output.png" alt-text="Screenshot showing how to configure kafka output for a stream analytics job." lightbox="./media/kafka/kafka-output.png" :::
+
+
 ## Authentication and encryption
 
 You can use four types of security protocols to connect to your Kafka clusters:

articles/stream-analytics/stream-analytics-define-kafka-input.md

@@ -5,7 +5,7 @@ author: enkrumah
 ms.author: ebnkruma
 ms.service: stream-analytics
 ms.topic: conceptual
-ms.date: 01/18/2024
+ms.date: 02/20/2024
 ---
 
 # Stream data from Kafka into Azure Stream Analytics (Preview)
@@ -21,6 +21,21 @@ The following are the major use cases:
 
 Azure Stream Analytics lets you connect directly to Kafka clusters to ingest data. The solution is low code and entirely managed by the Azure Stream Analytics team at Microsoft, allowing it to meet business compliance standards. The ASA Kafka input is backward compatible and supports all versions with the latest client release starting from version 0.10. Users can connect to Kafka clusters inside a VNET and Kafka clusters with a public endpoint, depending on the configurations. The configuration relies on existing Kafka configuration conventions. Supported compression types are None, Gzip, Snappy, LZ4, and Zstd.
 
+
+## Steps
+This article shows how to set up Kafka as an input source for Azure Stream Analytics. There are six steps:
+
+1. Create an Azure Stream Analytics job.
+2. Configure your Azure Stream Analytics job to use managed identity if you are using mTLS or SASL_SSl security protocols.
+3. Configure Azure Key vault if you are using mTLS or SASL_SSl security protocols.
+4. Upload certificates as secrets into Azure Key vault.
+5. Grant Azure Stream Analytics permissions to access the uploaded certificate.
+6. Configure Kafka input in your Azure Stream Analytics job.
+
+> [!NOTE]
+> Depending on how your Kafka cluster is configured and the type of Kafka cluster you are using, some of the above steps may not apply to you. Examples are: if you are using confluent cloud Kafka, you will not need to upload a certificate to use the Kafka connector. If your Kafka cluster is inside a virtual network (VNET) or behind a firewall, you may have to configure your Azure Stream Analytics job to access your Kafka topic using a private link or a dedicated networking configuration.
+
+
 ## Configuration
 The following table lists the property names and their description for creating a Kafka Input: 
 
@@ -36,6 +51,8 @@ The following table lists the property names and their description for creating
 | Security Protocol            | How you want to connect to your Kafka cluster. Azure Stream Analytics supports mTLS, SASL_SSL, SASL_PLAINTEXT or None. |
 | Event Serialization format   | The serialization format (JSON, CSV, Avro, Parquet, Protobuf) of the incoming data stream.                              |
 
+:::image type="content" source="./media/kafka/kafka-input.png" alt-text="Screenshot showing how to configure kafka input for a stream analytics job." lightbox="./media/kafka/kafka-input.png" :::
+
 
 ## Authentication and encryption
 
@@ -157,7 +174,7 @@ Use the following steps to grant special permissions to your stream analytics jo
 
 ### VNET integration
 
-If your Kafka is inside a virtual network (VNET) or behind a firewall, you must configure your Azure Stream Analytics job to access your Kafka topic.
+If your Kafka cluster is inside a virtual network (VNET) or behind a firewall, you may have to configure your Azure Stream Analytics job to access your Kafka topic using a private link or a dedicated networking configuration.
 Visit the [Run your Azure Stream Analytics job in an Azure Virtual Network documentation](../stream-analytics/run-job-in-virtual-network.md) for more information.