Azure
The Camel Components for Windows Azure Services provide connectivity to Azure services from Camel.
Azure components
See the following for usage of each component:
- Azure Storage Blob Service
-
Store and retrieve blobs from Azure Storage Blob Service using SDK v12.
- Azure Storage Blob Service (Deprecated)
-
Store and retrieve blobs from Azure Storage Blob Service.
- Azure Storage Queue Service
-
The azure-storage-queue component is used for storing and retrieving the messages to/from Azure Storage Queue using Azure SDK v12.
- Azure Storage Queue Service (Deprecated)
-
Store and retrieve messages from Azure Storage Queue Service.
Spring Boot Auto-Configuration
When using azure with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-azure-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 37 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.azure-blob.azure-blob-client |
The blob service client. The option is a com.microsoft.azure.storage.blob.CloudBlob type. |
String |
|
camel.component.azure-blob.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.azure-blob.blob-metadata |
Set the blob meta-data |
Map |
|
camel.component.azure-blob.blob-offset |
Set the blob offset for the upload or download operations, default is 0 |
0 |
Long |
camel.component.azure-blob.blob-prefix |
Set a prefix which can be used for listing the blobs |
String |
|
camel.component.azure-blob.blob-type |
Set a blob type, 'blockblob' is default |
BlobType |
|
camel.component.azure-blob.bridge-error-handler |
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 |
Boolean |
camel.component.azure-blob.close-stream-after-read |
Close the stream after read or keep it open, default is true |
true |
Boolean |
camel.component.azure-blob.close-stream-after-write |
Close the stream after write or keep it open, default is true |
true |
Boolean |
camel.component.azure-blob.configuration |
The Blob Service configuration. The option is a org.apache.camel.component.azure.blob.BlobServiceConfiguration type. |
String |
|
camel.component.azure-blob.credentials |
Set the storage credentials, required in most cases. The option is a com.microsoft.azure.storage.StorageCredentials type. |
String |
|
camel.component.azure-blob.credentials-account-key |
Set the storage account key used during authentication phase |
String |
|
camel.component.azure-blob.credentials-account-name |
Set the storage account name used during authentication phase |
String |
|
camel.component.azure-blob.data-length |
Set the data length for the download or page blob upload operations |
Long |
|
camel.component.azure-blob.enabled |
Whether to enable auto configuration of the azure-blob component. This is enabled by default. |
Boolean |
|
camel.component.azure-blob.file-dir |
Set the file directory where the downloaded blobs will be saved to |
String |
|
camel.component.azure-blob.lazy-start-producer |
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. |
false |
Boolean |
camel.component.azure-blob.operation |
Blob service operation hint to the producer |
BlobServiceOperations |
|
camel.component.azure-blob.public-for-read |
Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set |
false |
Boolean |
camel.component.azure-blob.stream-read-size |
Set the minimum read size in bytes when reading the blob content |
Integer |
|
camel.component.azure-blob.stream-write-size |
Set the size of the buffer for writing block and page blocks |
Integer |
|
camel.component.azure-blob.use-flat-listing |
Specify if the flat or hierarchical blob listing should be used |
true |
Boolean |
camel.component.azure-blob.validate-client-u-r-i |
Whether to validate the Azure client URI |
true |
Boolean |
camel.component.azure-queue.azure-queue-client |
The queue service client. The option is a com.microsoft.azure.storage.queue.CloudQueue type. |
String |
|
camel.component.azure-queue.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.azure-queue.bridge-error-handler |
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 |
Boolean |
camel.component.azure-queue.configuration |
The Queue Service configuration. The option is a org.apache.camel.component.azure.queue.QueueServiceConfiguration type. |
String |
|
camel.component.azure-queue.credentials |
Set the storage credentials, required in most cases. The option is a com.microsoft.azure.storage.StorageCredentials type. |
String |
|
camel.component.azure-queue.credentials-account-key |
Set the storage account key used during authentication phase |
String |
|
camel.component.azure-queue.credentials-account-name |
Set the storage account name used during authentication phase |
String |
|
camel.component.azure-queue.enabled |
Whether to enable auto configuration of the azure-queue component. This is enabled by default. |
Boolean |
|
camel.component.azure-queue.lazy-start-producer |
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. |
false |
Boolean |
camel.component.azure-queue.message-time-to-live |
Message Time To Live in seconds |
Integer |
|
camel.component.azure-queue.message-visibility-delay |
Message Visibility Delay in seconds |
Integer |
|
camel.component.azure-queue.operation |
Queue service operation hint to the producer |
QueueServiceOperations |
|
camel.component.azure-queue.queue-prefix |
Set a prefix which can be used for listing the queues |
String |
|
camel.component.azure-queue.validate-client-u-r-i |
Whether to validate the Azure client URI |
true |
Boolean |