camel-azure-queue-kafka-connector source configuration

When using camel-azure-queue-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-azure-queue-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.azurequeue.CamelAzurequeueSourceConnector

The camel-azure-queue source connector supports 19 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.containerAndQueueUri	Container Queue compact Uri	null	true	HIGH
camel.source.endpoint.azureQueueClient	The queue service client	null	false	MEDIUM
camel.source.endpoint.credentials	Set the storage credentials, required in most cases	null	false	MEDIUM
camel.source.endpoint.validateClientURI	Whether to validate the Azure client URI	true	false	MEDIUM
camel.source.endpoint.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	false	MEDIUM
camel.source.endpoint.exceptionHandler	To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.	null	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	false	MEDIUM
camel.source.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.source.endpoint.credentialsAccountKey	Set the storage account key used during authentication phase	null	false	MEDIUM
camel.source.endpoint.credentialsAccountName	Set the storage account name used during authentication phase	null	false	MEDIUM
camel.component.azure-queue.azureQueueClient	The queue service client	null	false	MEDIUM
camel.component.azure-queue.credentials	Set the storage credentials, required in most cases	null	false	MEDIUM
camel.component.azure-queue.validateClientURI	Whether to validate the Azure client URI	true	false	MEDIUM
camel.component.azure-queue.bridgeErrorHandler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	false	MEDIUM
camel.component.azure-queue.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.azure-queue.configuration	The Queue Service configuration	null	false	MEDIUM
camel.component.azure-queue.credentialsAccountKey	Set the storage account key used during authentication phase	null	false	MEDIUM
camel.component.azure-queue.credentialsAccountName	Set the storage account name used during authentication phase	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.containerAndQueueUri

Container Queue compact Uri

null

true

HIGH

camel.source.endpoint.azureQueueClient

The queue service client

null

false

MEDIUM

camel.source.endpoint.credentials

Set the storage credentials, required in most cases

null

false

MEDIUM

camel.source.endpoint.validateClientURI

Whether to validate the Azure client URI

true

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.credentialsAccountKey

Set the storage account key used during authentication phase

null

false

MEDIUM

camel.source.endpoint.credentialsAccountName

Set the storage account name used during authentication phase

null

false

MEDIUM

camel.component.azure-queue.azureQueueClient

The queue service client

null

false

MEDIUM

camel.component.azure-queue.credentials

Set the storage credentials, required in most cases

null

false

MEDIUM

camel.component.azure-queue.validateClientURI

Whether to validate the Azure client URI

true

false

MEDIUM

camel.component.azure-queue.bridgeErrorHandler

false

MEDIUM

camel.component.azure-queue.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

camel.component.azure-queue.configuration

The Queue Service configuration

null

false

MEDIUM

camel.component.azure-queue.credentialsAccountKey

Set the storage account key used during authentication phase

null

false

MEDIUM

camel.component.azure-queue.credentialsAccountName

Set the storage account name used during authentication phase

null

false

MEDIUM

The camel-azure-queue sink connector has no converters out of the box.

The camel-azure-queue sink connector has no transforms out of the box.

The camel-azure-queue sink connector has no aggregation strategies out of the box.