Skip to content

Commit 68efc26

Browse files
Copilotsaragluna
andcommitted
Clarify OAuth2 strategy is for Microsoft Entra ID, not connection strings
Update documentation to distinguish between OAuth2/Entra ID authentication (handled by KafkaOAuth2AuthenticationStrategy) and connection string-based authentication (handled by AzureEventHubsKafkaAutoConfiguration). Co-authored-by: saragluna <[email protected]>
1 parent 2e329ee commit 68efc26

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/kafka/authentication/KafkaOAuth2AuthenticationStrategy.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,15 @@
2929
import static org.springframework.util.StringUtils.delimitedListToStringArray;
3030

3131
/**
32-
* OAuth2 authentication strategy for Azure Event Hubs Kafka.
33-
* This strategy configures SASL/OAUTHBEARER authentication using Microsoft Entra ID.
32+
* OAuth2 authentication strategy for Azure Event Hubs Kafka using Microsoft Entra ID.
33+
* <p>
34+
* This strategy configures SASL/OAUTHBEARER authentication for Azure Event Hubs Kafka clients
35+
* using Microsoft Entra ID credentials (formerly Azure Active Directory).
36+
* </p>
37+
* <p>
38+
* Note: This is different from connection string-based authentication which is handled by
39+
* AzureEventHubsKafkaAutoConfiguration.
40+
* </p>
3441
*
3542
* @since 6.1.0
3643
*/

sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/kafka/authentication/package-info.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,11 @@
2121
*
2222
* <h3>OAuth2 Authentication (Microsoft Entra ID)</h3>
2323
* The {@code KafkaOAuth2AuthenticationStrategy} configures SASL/OAUTHBEARER authentication
24-
* for connecting to Azure Event Hubs using Microsoft Entra ID credentials.
24+
* for connecting to Azure Event Hubs using Microsoft Entra ID credentials (formerly Azure Active Directory).
25+
* <p>
26+
* Note: This package only contains OAuth2/OAUTHBEARER authentication. Connection string-based
27+
* authentication for Event Hubs is handled separately by {@code AzureEventHubsKafkaAutoConfiguration}.
28+
* </p>
2529
*
2630
* <p><b>Configuration Requirements:</b></p>
2731
* <ul>

0 commit comments

Comments
 (0)