writeToAzureBlobStorage

Processor that writes payloads to an Azure Blob Storage container.

The name of the object is set to the internal message ID by default. This behaviour can be overridden by using the standard fileName exchange property.

Properties

Name Summary

Name	Summary
`forwardProperty()`	Adds a name to a list of exchange properties that are stored as metadata alongside the payload.
`blobContainerName`	The Azure Blob Storage container name under which the payload is stored. Required.
`endpoint`	The Azure Blob Storage endpoint under which the payload is stored. Optional but must be set if service principal authentication is used. Must not be set if connection string authentication is used.
`authenticationConfigKey`	A secret key that the server uses to look up the credentials needed to perform the Azure authentication. Required.
`retainPayload`	Whether to retain the payload after writing it to Azure Blob Storage, making it available for processing in downstream processors. Defaults to `false` (i.e., the payload is removed after it is written to Azure).
`defaultContentType`	Default content MIME type (e.g., `application/json; charset=utf-8`) to associate with the payload. Content type can also be defined dynamically by setting the standard `contentType` exchange property. Optional.
`connectionTimeoutMillis`	The timeout of the HTTP client socket connection. Optional.
`receiveTimeoutMillis`	The socket timeout to wait for the first byte of response from the server. Optional.
`name`	Optional, descriptive name for the processor.
`id`	Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern `[a-zA-Z][a-zA-Z0-9_-]{2,29}`.
`exchangeProperties`	Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.
`retainPayloadOnFailure`	Whether the incoming payload is available for error processing on failure. Defaults to `false`.

forwardProperty()

Adds a name to a list of exchange properties that are stored as metadata alongside the payload.

blobContainerName

The Azure Blob Storage container name under which the payload is stored. Required.

endpoint

The Azure Blob Storage endpoint under which the payload is stored. Optional but must be set if service principal authentication is used. Must not be set if connection string authentication is used.

authenticationConfigKey

A secret key that the server uses to look up the credentials needed to perform the Azure authentication. Required.

retainPayload

Whether to retain the payload after writing it to Azure Blob Storage, making it available for processing in downstream processors. Defaults to false (i.e., the payload is removed after it is written to Azure).

defaultContentType

Default content MIME type (e.g., application/json; charset=utf-8) to associate with the payload. Content type can also be defined dynamically by setting the standard contentType exchange property. Optional.

connectionTimeoutMillis

The timeout of the HTTP client socket connection. Optional.

receiveTimeoutMillis

The socket timeout to wait for the first byte of response from the server. Optional.

name

Optional, descriptive name for the processor.

id

Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.

exchangeProperties

Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.

retainPayloadOnFailure

Whether the incoming payload is available for error processing on failure. Defaults to false.

Sub-builders

Name	Summary
externalSystemDetails	Strategy for describing the external system integration. Optional.
circuitBreakerStrategy	Strategy for configuring the processor’s circuit breaker. Optional.
messageLoggingStrategy	Strategy for describing how a processor’s message is logged on the server.
payloadArchivingStrategy	Strategy for archiving payloads.
inboundTransformationStrategy	Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Name

Summary

externalSystemDetails

Strategy for describing the external system integration. Optional.

circuitBreakerStrategy

Strategy for configuring the processor’s circuit breaker. Optional.

messageLoggingStrategy

Strategy for describing how a processor’s message is logged on the server.

payloadArchivingStrategy

Strategy for archiving payloads.

inboundTransformationStrategy

Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Details

Authentication

The authenticationConfigKey property supports secrets of type AzureConnectionString and AzureClientCertificate. See the Secret Types documentation for formatting details.

Was this page helpful?