// kafka-connector options: START
[[camel-azure-storage-blob-kafka-connector-source]]
= camel-azure-storage-blob-kafka-connector source configuration

When using camel-azure-storage-blob-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-azure-storage-blob-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>
----

To use this Source connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.azurestorageblob.CamelAzurestorageblobSourceConnector
----


The camel-azure-storage-blob source connector supports 40 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.source.path.accountName* | Azure account name to be used for authentication with azure blob services | null | false | MEDIUM
| *camel.source.path.containerName* | The blob container name | null | false | MEDIUM
| *camel.source.endpoint.autoDiscoverClient* | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | false | MEDIUM
| *camel.source.endpoint.blobName* | The blob name, to consume specific blob from a container. However on producer, is only required for the operations on the blob level | null | false | MEDIUM
| *camel.source.endpoint.blobOffset* | Set the blob offset for the upload or download operations, default is 0 | 0L | false | MEDIUM
| *camel.source.endpoint.blobServiceClient* | 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). | null | false | MEDIUM
| *camel.source.endpoint.blobType* | The blob type in order to initiate the appropriate settings for each blob type One of: [blockblob] [appendblob] [pageblob] | "blockblob" | false | MEDIUM
| *camel.source.endpoint.closeStreamAfterRead* | Close the stream after read or keep it open, default is true | true | false | MEDIUM
| *camel.source.endpoint.credentials* | StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information | null | false | MEDIUM
| *camel.source.endpoint.dataCount* | How many bytes to include in the range. Must be greater than or equal to 0 if specified. | null | false | MEDIUM
| *camel.source.endpoint.fileDir* | The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer | null | false | MEDIUM
| *camel.source.endpoint.maxResultsPerPage* | 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. | null | false | MEDIUM
| *camel.source.endpoint.maxRetryRequests* | Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body. | 0 | false | MEDIUM
| *camel.source.endpoint.prefix* | Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs. | null | false | MEDIUM
| *camel.source.endpoint.regex* | 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. | null | false | MEDIUM
| *camel.source.endpoint.serviceClient* | 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). | null | false | MEDIUM
| *camel.source.endpoint.timeout* | An optional timeout value beyond which a RuntimeException will be raised. | null | false | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | 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 | false | MEDIUM
| *camel.source.endpoint.exceptionHandler* | 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. | null | false | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | false | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | false | MEDIUM
| *camel.source.endpoint.accessKey* | Access key for the associated azure account name to be used for authentication with azure blob services | null | false | MEDIUM
| *camel.component.azure-storage-blob.autoDiscover Client* | Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. | true | false | MEDIUM
| *camel.component.azure-storage-blob.blobName* | The blob name, to consume specific blob from a container. However on producer, is only required for the operations on the blob level | null | false | MEDIUM
| *camel.component.azure-storage-blob.blobOffset* | Set the blob offset for the upload or download operations, default is 0 | 0L | false | MEDIUM
| *camel.component.azure-storage-blob.blobType* | The blob type in order to initiate the appropriate settings for each blob type One of: [blockblob] [appendblob] [pageblob] | "blockblob" | false | MEDIUM
| *camel.component.azure-storage-blob.closeStream AfterRead* | Close the stream after read or keep it open, default is true | true | false | MEDIUM
| *camel.component.azure-storage-blob.configuration* | The component configurations | null | false | MEDIUM
| *camel.component.azure-storage-blob.credentials* | StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information | null | false | MEDIUM
| *camel.component.azure-storage-blob.dataCount* | How many bytes to include in the range. Must be greater than or equal to 0 if specified. | null | false | MEDIUM
| *camel.component.azure-storage-blob.fileDir* | The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer | null | false | MEDIUM
| *camel.component.azure-storage-blob.maxResultsPer Page* | 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. | null | false | MEDIUM
| *camel.component.azure-storage-blob.maxRetry Requests* | Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body. | 0 | false | MEDIUM
| *camel.component.azure-storage-blob.prefix* | Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs. | null | false | MEDIUM
| *camel.component.azure-storage-blob.regex* | 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. | null | false | MEDIUM
| *camel.component.azure-storage-blob.serviceClient* | 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). | null | false | MEDIUM
| *camel.component.azure-storage-blob.timeout* | An optional timeout value beyond which a RuntimeException will be raised. | null | false | MEDIUM
| *camel.component.azure-storage-blob.bridgeError 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 | false | MEDIUM
| *camel.component.azure-storage-blob.autowired Enabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | false | MEDIUM
| *camel.component.azure-storage-blob.accessKey* | Access key for the associated azure account name to be used for authentication with azure blob services | null | false | MEDIUM
|===



The camel-azure-storage-blob source connector has no converters out of the box.





The camel-azure-storage-blob source connector has no transforms out of the box.





The camel-azure-storage-blob source connector has no aggregation strategies out of the box.
// kafka-connector options: END
