Azure ServiceBus

Send and receive messages to/from Azure Service Bus.

Metadata

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

Maven Dependency

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

Endpoint Properties

Name	Type	Required	Default	Description
`topicOrQueueName`	string			Selected topic name or the queue name, that is depending on serviceBusType config. For example if serviceBusType=queue, then this will be the queue name and if serviceBusType=topic, this will be the topic name.
`amqpRetryOptions`	object			Sets the retry options for Service Bus clients. If not specified, the default retry options are used.
`amqpTransportType`	object		`AMQP`	Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AMQP.
`clientOptions`	object			Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information.
`headerFilterStrategy`	object			To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers.
`proxyOptions`	object			Sets the proxy configuration to use for ServiceBusSenderClient. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type.
`serviceBusType`	object	✓	`queue`	The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model.
`enableDeadLettering`	boolean		`false`	Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set.
`maxAutoLockRenewDuration`	object		`5m`	Sets the amount of time to continue auto-renewing the lock. Setting ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled.
`maxConcurrentCalls`	integer		`1`	Sets maximum number of concurrent calls
`prefetchCount`	integer			Sets the prefetch count of the receiver. For both PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off.
`processorClient`	object			Sets the processorClient in order to consume messages by the consumer
`serviceBusReceiveMode`	object		`PEEK_LOCK`	Sets the receive mode for the receiver.
`sessionEnabled`	boolean		`false`	Enable session support
`subQueue`	object			Sets the type of the SubQueue to connect to.
`subscriptionName`	string			Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. This property is required if serviceBusType=topic and the consumer is in use.
`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.
`binary`	boolean		`false`	Set binary mode. If true, message body will be sent as byte. By default, it is false.
`producerOperation`	object		`sendMessages`	Sets the desired operation to be used in the producer
`scheduledEnqueueTime`	object			Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.
`senderClient`	object			Sets senderClient to be used in the producer.
`serviceBusTransactionContext`	object			Represents transaction in service. This object just contains transaction id.
`sessionId`	string			Session ID for session-enabled queues or topics.
`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			Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
`credentialType`	object		`CONNECTION_STRING`	Determines the credential strategy to adopt
`fullyQualifiedNamespace`	string			Fully Qualified Namespace of the service bus
`tokenCredential`	object			A TokenCredential for Azure AD authentication.