azure storage files source Azure Storage File Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Consume files from Azure Storage File Shares.

Configuration Options

The following table summarizes the configuration options available for the azure-storage-files-source Kamelet:

Property Name Description Type Default Example

accountName

Account Name

Required The Azure Storage File Share account name.

string

shareName

Share Name

Required The Azure Storage File Share share name.

string

credentialType

Credential Type

Determines the credential strategy to adopt.

Enum values:

* SHARED_ACCOUNT_KEY * AZURE_IDENTITY * SHARED_KEY_CREDENTIAL * AZURE_SAS

string

SHARED_ACCOUNT_KEY

delay

Delay

The number of milliseconds before the next poll of the selected blob.

integer

500

deleteAfterRead

Auto-delete Blob

Specifies to delete blobs after consuming them.

boolean

false

directoryName

Directory Name

The directory from where the consumer will start reading files.

string

.

recursive

Recursive Mode

If a directory, the consumer will look for files in all the sub-directories as well.

boolean

false

sharedKey

Shared Access Key

The Azure Storage Blob access key.

string

Dependencies

At runtime, the azure-storage-files-source Kamelet relies upon the presence of the following dependencies:

  • camel:azure-files

  • camel:kamelet

  • camel:core

  • camel:timer

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the azure-storage-files-source.

Knative source

You can use the azure-storage-files-source Kamelet as a Knative source by binding it to a Knative object.

azure-storage-files-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: azure-storage-files-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: azure-storage-files-source
    properties:
      accountName: The Account Name
      shareName: The Share Name
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the azure-storage-files-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f azure-storage-files-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.accountName=The Account Name" -p "source.shareName=The Share Name" azure-storage-files-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the azure-storage-files-source Kamelet as a Kafka source by binding it to a Kafka topic.

azure-storage-files-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: azure-storage-files-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: azure-storage-files-source
    properties:
      accountName: The Account Name
      shareName: The Share Name
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the azure-storage-files-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f azure-storage-files-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.accountName=The Account Name" -p "source.shareName=The Share Name" azure-storage-files-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/azure-storage-files-source.kamelet.yaml

Back to top