blob: f18575caef92ec73fc3d075676ac0e2c3f180837 [file] [log] [blame]
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/azure-storage-queue-sink.svg[] Azure Storage Queue Sink
*Provided by: "Apache Software Foundation"*
Send Messages to Azure Storage queues.
The Kamelet is able to understand the following headers to be set:
- `expiration` / `ce-expiration`: as the time to live of the message in the queue.
If the header won't be set the default of 7 days will be used.
The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S — parses as 20.345 seconds, P2D — parses as 2 days.
== Configuration Options
The following table summarizes the configuration options available for the `azure-storage-queue-sink` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *accessKey {empty}* *| Access Key| The Azure Storage Queue access Key.| string| |
| *accountName {empty}* *| Account Name| The Azure Storage Queue account name.| string| |
| *queueName {empty}* *| Queue Name| The Azure Storage Queue container name.| string| |
|===
NOTE: Fields marked with ({empty}*) are mandatory.
== Usage
This section summarizes how the `azure-storage-queue-sink` can be used in various contexts.
=== Knative Sink
The `azure-storage-queue-sink` Kamelet can be used as Knative sink by binding it to a Knative object.
.azure-storage-queue-sink-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: azure-storage-queue-sink-binding
spec:
source:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: azure-storage-queue-sink
properties:
accessKey: "The Access Key"
accountName: "The Account Name"
queueName: "The Queue Name"
----
Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
Save the `azure-storage-queue-sink-binding.yaml` file into your hard drive, then configure it according to your needs.
You can run the sink using the following command:
[source,shell]
----
kubectl apply -f azure-storage-queue-sink-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT