(camel) 02/04: CAMEL-18590 - Camel-Azure components: Define a unique configuration for authentication - Azure Servicebus - Docs

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch CAMEL-18590-servicebus
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 46d4040316bc680ee3217c3de9c9feacb11acdfd
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Dec 14 14:29:44 2023 +0100

    CAMEL-18590 - Camel-Azure components: Define a unique configuration for authentication - Azure Servicebus - Docs
    
    Signed-off-by: Andrea Cosentino <an...@gmail.com>
---
 .../src/main/docs/azure-servicebus-component.adoc     | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc b/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
index 74d63e78cef..66894983be0 100644
--- a/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
+++ b/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
@@ -61,6 +61,25 @@ This allows camel route to consume and produce events asynchronously without blo
 include::partial$component-endpoint-headers.adoc[]
 // component headers: END
 
+=== Authentication Information
+
+You have three different Credential Types: AZURE_IDENTITY, TOKEN_CREDENTIAL and CONNECTION_STRING. You can also provide a client instance yourself.
+To use this component, you have 3 options in order to provide the required Azure authentication information:
+
+CONNECTION_STRING:
+- Provide `connectionString` string it is the simplest option to get started.
+
+TOKEN_CREDENTIAL:
+- Provide an implementation of `com.azure.core.credential.TokenCredential` into the Camel's Registry, e.g. using the `com.azure.identity.DefaultAzureCredentialBuilder().build();` API.
+See the documentation https://docs.microsoft.com/en-us/azure/active-directory/authentication/overview-authentication[here about Azure-AD authentication].
+
+AZURE_IDENTITY:
+- This will use `com.azure.identity.DefaultAzureCredentialBuilder().build();` instance. This will follow the Default Azure Credential Chain.
+See the documentation https://docs.microsoft.com/en-us/azure/active-directory/authentication/overview-authentication[here about Azure-AD authentication].
+
+Client instance:
+- You can provide a `com.azure.messaging.servicebus.ServiceBusSenderAsyncClient` for sending message and/or `com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient` to receive messages. If you provide the instances they will be autowired.
+
 === Message Body
 In the producer, this component accepts message body of `String`, `byte[]` and `BinaryData` types or `List<String>`, `List<byte[]>` and `List<BinaryData>` to send batch messages.