Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 38. Azure Storage Queue Service Component


Available as of Camel version 2.19

The Azure Queue component supports storing and retrieving the messages to/from Azure Storage Queue service.

Prerequisites

You must have a valid Windows Azure Storage account. More information is available at Azure Documentation Portal.

38.1. URI Format

azure-queue://accountName/queueName[?options]
Copy to Clipboard Toggle word wrap

The queue will be created if it does not already exist.
You can append query options to the URI in the following format, ?options=value&option2=value&…​

For example in order to get a message content from the queue messageQueue in the camelazure storage account and, use the following snippet:

from("azure-queue:/camelazure/messageQueue").
to("file://queuedirectory");
Copy to Clipboard Toggle word wrap

38.2. URI Options

The Azure Storage Queue Service component has no options.

The Azure Storage Queue Service endpoint is configured using URI syntax:

azure-queue:containerAndQueueUri
Copy to Clipboard Toggle word wrap

with the following path and query parameters:

38.2.1. Path Parameters (1 parameters):

Expand
NameDescriptionDefaultType

containerAndQueueUri

Required Container Queue compact Uri

 

String

38.2.2. Query Parameters (10 parameters):

Expand
NameDescriptionDefaultType

azureQueueClient (common)

The queue service client

 

CloudQueue

credentials (common)

Set the storage credentials, required in most cases

 

StorageCredentials

bridgeErrorHandler (consumer)

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

boolean

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

 

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

 

ExchangePattern

messageTimeToLive (producer)

Message Time To Live in seconds

 

int

messageVisibilityDelay (producer)

Message Visibility Delay in seconds

 

int

operation (producer)

Queue service operation hint to the producer

listQueues

QueueServiceOperations

queuePrefix (producer)

Set a prefix which can be used for listing the queues

 

String

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

Required Azure Storage Queue Service component options

You have to provide the containerAndQueue URI and the credentials.

38.3. Usage

Expand
HeaderTypeDescription
   
Expand
HeaderTypeDescription
   
Expand
HeaderTypeDescription
   

38.3.4. Azure Queue Service operations

Expand
OperationDescription

listQueues

List the queues.

createQueue

Create the queue.

deleteQueue

Delete the queue.

addMessage

Add a message to the queue.

retrieveMessage

Retrieve a message from the queue.

peekMessage

View the message inside the queue, for example, to determine whether the message arrived at the correct queue.

updateMessage

Update the message in the queue.

deleteMessage

Delete the message in the queue.

38.3.5. Azure Queue Client configuration

If your Camel Application is running behind a firewall or if you need to have more control over the Azure Queue Client configuration, you can create your own instance:

StorageCredentials credentials = new StorageCredentialsAccountAndKey("camelazure", "thekey");

CloudQueue client = new CloudQueue("camelazure", credentials);

registry.bind("azureQueueClient", client);
Copy to Clipboard Toggle word wrap

and refer to it in your Camel azure-queue component configuration:

from("azure-queue:/camelazure/messageQueue?azureQueueClient=#client")
.to("mock:result");
Copy to Clipboard Toggle word wrap

38.4. Dependencies

Maven users will need to add the following dependency to their pom.xml.

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-azure</artifactId>
    <version>${camel-version}</version>
</dependency>
Copy to Clipboard Toggle word wrap

where ${camel-version} must be replaced by the actual version of Camel (2.19.0 or higher).

38.5. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • Azure Component
Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat