azure storage queue source Azure Storage Queue Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive events from Azure Storage queues.

One header will be duplicated with different names for clarity at sink level, CamelAzureStorageQueueMessageId will be duplicated into azure.storage.queue.message.id

Configuration Options

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

Property Name Description Type Default Example

accessKey

Access Key

Required The Azure Storage Queue access key.

string

accountName

Account Name

Required The Azure Storage Queue account name.

string

queueName

Queue Name

Required The Azure Storage Queue container name.

string

credentialType

Credential Type

Determines the credential strategy to adopt.

Enum values:

* SHARED_ACCOUNT_KEY * SHARED_KEY_CREDENTIAL * AZURE_IDENTITY

string

SHARED_ACCOUNT_KEY

maxMessages

Maximum Messages

The maximum number of messages to get. You can specify a value between 1 and 32. The default is 1 (one message). If there are fewer than the maximum number of messages in the queue, then all the messages are returned.

integer

1

Dependencies

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

  • camel:azure-storage-queue

  • camel:kamelet

  • mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.4.4-SNAPSHOT

  • camel:core

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-queue-source.

Knative source

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

azure-storage-queue-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: azure-storage-queue-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: azure-storage-queue-source
    properties:
      accessKey: The Access Key
      accountName: The Account Name
      queueName: The Queue 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-queue-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-queue-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.accessKey=The Access Key" -p "source.accountName=The Account Name" -p "source.queueName=The Queue Name" azure-storage-queue-source

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

Kafka source

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

azure-storage-queue-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: azure-storage-queue-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: azure-storage-queue-source
    properties:
      accessKey: The Access Key
      accountName: The Account Name
      queueName: The Queue 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-queue-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-queue-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.accessKey=The Access Key" -p "source.accountName=The Account Name" -p "source.queueName=The Queue Name" azure-storage-queue-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-queue-source.kamelet.yaml

Back to top