Azure Storage Blob Service

Store and retrieve blobs from Azure Storage Blob Service.

Metadata

Property	Value
Scheme	`azure-storage-blob`
Support Level	Stable
Labels	cloud,file
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-azure-storage-blob</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Default	Description
`accountName`	string		Azure account name to be used for authentication with azure blob services
`containerName`	string		The blob container name
`blobName`	string		The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level
`blobOffset`	integer	`0`	Set the blob offset for the upload or download operations, default is 0
`blobServiceClient`	object		Client to a storage account. 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. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String).
`blobType`	enum	`blockblob`	The blob type in order to initiate the appropriate settings for each blob type
`closeStreamAfterRead`	boolean	`true`	Close the stream after read or keep it open, default is true
`credentials`	object		StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information
`credentialType`	enum	`AZURE_IDENTITY`	Determines the credential strategy to adopt
`dataCount`	integer		How many bytes to include in the range. Must be greater than or equal to 0 if specified.
`fileDir`	string		The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer
`leaseBlob`	boolean	`false`	Sets whether a lease should be acquired when accessing the blob. When set to true, the component will acquire a lease before performing blob operations that require exclusive access.
`leaseDurationInSeconds`	integer	`60`	Sets the lease duration in seconds. Use -1 for infinite or a value between 15 and 60 for fixed leases.
`maxResultsPerPage`	integer		Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items.
`maxRetryRequests`	integer	`0`	Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body.
`prefix`	string		Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs.
`regex`	string		Filters the results to return only blobs whose names match the specified regular expression. May be null to return all if both prefix and regex are set, regex takes the priority and prefix is ignored.
`sasToken`	string		In case of usage of Shared Access Signature we'll need to set a SAS Token
`serviceClient`	object		Client to a storage account. 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. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String).
`snapshotId`	string		The snapshot identifier used to target a specific blob snapshot on read operations (getBlob, downloadBlobToFile, downloadLink). When set, the read targets the snapshot scoped client instead of the live blob. Can also be provided per-exchange via the CamelAzureStorageBlobSnapshotId header.
`timeout`	duration		An optional timeout value beyond which a RuntimeException will be raised.
`deleteAfterRead`	boolean	`false`	Delete blobs from Azure after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the blob is not deleted. If this option is false, then the same blobs will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the BlobConstants#BLOB_NAME header, or only the blob name.
`destinationBlobPrefix`	string		Define the destination blob prefix to use when a blob must be moved, and moveAfterRead is set to true.
`destinationBlobSuffix`	string		Define the destination blob suffix to use when a blob must be moved, and moveAfterRead is set to true.
`destinationContainer`	string		Define the destination container where a blob must be moved when moveAfterRead is set to true.
`moveAfterRead`	boolean	`false`	Move blobs from the container to a different container after they have been retrieved. To accomplish the operation, the destinationContainer option must be set. The copy blob operation is only performed if the Exchange is committed. If a rollback occurs, the blob is not moved.
`removePrefixOnMove`	boolean	`false`	Remove the contents of the prefix configuration string from the new blob name before moving. For example, if prefix is set to 'notify/' and the destinationBlobPrefix is set to 'archive/', a blob with a name of 'notify/example.txt' will be moved to 'archive/example.txt', rather than the default behavior where the new name is 'archive/notify/example.txt'. Only applicable when moveAfterRead is true.
`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`	enum		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.
`blobSequenceNumber`	integer	`0`	A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1.The default value is 0.
`blockListType`	enum	`COMMITTED`	Specifies which type of blocks to return.
`blockSize`	integer		The block size in bytes to use for chunked uploads with uploadBlockBlobChunked operation. Default is 4MB (4194304). Maximum is 4000MB. Must be greater than 0.
`changeFeedContext`	object		When using getChangeFeed producer operation, this gives additional context that is passed through the Http pipeline during the service call.
`changeFeedEndTime`	object		When using getChangeFeed producer operation, this filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.
`changeFeedStartTime`	object		When using getChangeFeed producer operation, this filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.
`closeStreamAfterWrite`	boolean	`true`	Close the stream after write or keep it open, default is true
`commitBlockListLater`	boolean	`true`	When is set to true, the staged blocks will not be committed directly.
`createAppendBlob`	boolean	`true`	When is set to true, the append blocks will be created when committing append blocks.
`createPageBlob`	boolean	`true`	When is set to true, the page blob will be created when uploading page blob.
`downloadLinkExpiration`	integer		Override the default expiration (millis) of URL download link.
`maxConcurrency`	integer		The maximum number of parallel requests to use during upload with uploadBlockBlobChunked operation. Default is determined by the Azure SDK based on available processors.
`maxSingleUploadSize`	integer		The maximum size in bytes for a single upload request with uploadBlockBlobChunked operation. Files smaller than this will be uploaded in a single request. Files larger will use chunked upload with blocks of size blockSize. Default is 256MB.
`operation`	enum	`listBlobContainers`	The blob operation that can be used with this component on the producer
`pageBlobSize`	integer	`512`	Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.
`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.
`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`	enum	`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. This is a multi-value option with prefix: scheduler.
`startScheduler`	boolean	`true`	Whether the scheduler should be auto started.
`timeUnit`	enum	`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 blob services
`azureClientId`	string		Azure Client ID for authentication with Azure Identity
`azureClientSecret`	string		Azure Client Secret for authentication with Azure Identity
`azureTenantId`	string		Azure Tenant ID for authentication with Azure Identity
`sourceBlobAccessKey`	string		Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key.