Azure Storage Queue Service

Stores and retrieves messages to/from Azure Storage Queue.

Metadata

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

Maven Dependency

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

Endpoint Properties

Name	Type	Default	Description
`accountName`	string		Azure account name to be used for authentication with azure queue services
`queueName`	string		The queue resource name
`credentialType`	object	`SHARED_ACCOUNT_KEY`	Determines the credential strategy to adopt
`serviceClient`	object		Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account.
`sendEmptyMessageWhenIdle`	boolean	`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`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.
`pollStrategy`	object		A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`createQueue`	boolean	`false`	When is set to true, the queue will be automatically created when sending messages to the queue.
`operation`	object		Queue service operation hint to the 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.
`maxMessages`	integer	`1`	Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.
`messageId`	string		The ID of the message to be deleted or updated.
`popReceipt`	string		Unique identifier that must match for the message to be deleted or updated.
`timeout`	object		An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown.
`timeToLive`	object		How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.
`visibilityTimeout`	object		The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.
`backoffErrorThreshold`	integer		The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer		The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer		To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
`delay`	integer	`500`	Milliseconds before the next poll.
`greedy`	boolean	`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer	`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer	`0`	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
`runLoggingLevel`	object	`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object		Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
`scheduler`	object	`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object		To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean	`true`	Whether the scheduler should be auto started.
`timeUnit`	object	`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean	`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`accessKey`	string		Access key for the associated azure account name to be used for authentication with azure queue services
`credentials`	object		StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information