Azure Event Hubs

Send and receive events to/from Azure Event Hubs using AMQP protocol.

Metadata

Property	Value
Scheme	`azure-eventhubs`
Support Level	Stable
Labels	cloud,messaging
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-azure-eventhubs</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Default	Description
`namespace`	string		EventHubs namespace created in Azure Portal.
`eventHubName`	string		EventHubs name under a specific namespace.
`amqpRetryOptions`	object		Sets the retry policy for EventHubProducerAsyncClient. If not specified, the default retry options are used.
`amqpTransportType`	object	`AMQP`	Sets the transport type by which all the communication with Azure Event Hubs occurs.
`blobAccessKey`	string		In case you chose the default BlobCheckpointStore, this sets access key for the associated azure account name to be used for authentication with azure blob services.
`blobAccountName`	string		In case you chose the default BlobCheckpointStore, this sets Azure account name to be used for authentication with azure blob services.
`blobContainerName`	string		In case you chose the default BlobCheckpointStore, this sets the blob container that shall be used by the BlobCheckpointStore to store the checkpoint offsets.
`blobStorageSharedKeyCredential`	object		In case you chose the default BlobCheckpointStore, StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
`checkpointBatchSize`	integer	`500`	Sets the batch size between each checkpoint update. Works jointly with checkpointBatchTimeout.
`checkpointBatchTimeout`	integer	`5000`	Sets the batch timeout between each checkpoint update. Works jointly with checkpointBatchSize.
`checkpointStore`	object	`BlobCheckpointStore`	Sets the CheckpointStore the EventProcessorClient will use for storing partition ownership and checkpoint information. Users can, optionally, provide their own implementation of CheckpointStore which will store ownership and checkpoint information. By default, it's set to use com.azure.messaging.eventhubs.checkpointstore.blob.BlobCheckpointStore which stores all checkpoint offsets into Azure Blob Storage.
`consumerGroupName`	string	`$Default`	Sets the name of the consumer group this consumer is associated with. Events are read in the context of this group. The name of the consumer group that is created by default is $Default.
`eventPosition`	object		Sets the map containing the event position to use for each partition if a checkpoint for the partition does not exist in CheckpointStore. This map is keyed off of the partition id. If there is no checkpoint in CheckpointStore and there is no entry in this map, the processing of the partition will start from EventPosition#latest() position.
`prefetchCount`	integer	`500`	Sets the count used by the receiver to control the number of events the Event Hub consumer will actively receive and queue locally without regard to whether a receive operation is currently active.
`bridgeErrorHandler`	boolean	`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object		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.
`exchangePattern`	object		Sets the exchange pattern when the consumer creates an exchange.
`partitionId`	string		Sets the identifier of the Event Hub partition that the EventData events will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition.
`partitionKey`	string		Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. The selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition. This should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the identifier of the position be specified directly when sending the batch.
`producerAsyncClient`	object		Sets the EventHubProducerAsyncClient.An asynchronous producer responsible for transmitting EventData to a specific Event Hub, grouped together in batches. Depending on the com.azure.messaging.eventhubs.models.CreateBatchOptions options specified when creating an com.azure.messaging.eventhubs.EventDataBatch, the events may be automatically routed to an available partition or specific to a partition. Use by this component to produce the data in camel producer.
`lazyStartProducer`	boolean	`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`connectionString`	string		Instead of supplying namespace, sharedAccessKey, sharedAccessName, etc. you can supply the connection string for your eventHub. The connection string for EventHubs already includes all the necessary information to connect to your EventHub. To learn how to generate the connection string, take a look at this documentation: https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string
`credentialType`	object	`CONNECTION_STRING`	Determines the credential strategy to adopt
`sharedAccessKey`	string		The generated value for the SharedAccessName.
`sharedAccessName`	string		The name you chose for your EventHubs SAS keys.
`tokenCredential`	object		Provide custom authentication credentials using an implementation of TokenCredential.