Azure Blob Storage

Micro-Integration Flows using Azure Blob Storage can be configured as a source only.

To configure the connection details for Azure Blob Storage in your Micro-Integration, see Azure Blob Storage Connection Parameters

You must also define at least one Micro-Integration Flow that specifies:

the endpoints where data is consumed from and published to. For more information, see Micro-Integration Flow Parameters.
how the header and payload fields should be mapped. For more information, see Mapping Headers and Payloads

For a listing of available message headers, see Azure Blob Storage Message Headers.

Azure Blob Storage Connection Parameters

These parameters are configured at the Micro-Integration level and are shared across all Micro-Integration Flows using this Micro-Integration.

Field	Description
Delete After Read	Select to delete the file after reading.
Checkpoint Queue	The name of the Last Value Queue to use as checkpoint storage.
Auto Create Checkpoint Queue	Select to automatically create the checkpoint queue if it does not exist.

Micro-Integration Flow Parameters

You must configure the endpoint parameters for each Flow. Each Flow can have different settings, but they all share the connection details of the parent Micro-Integration.

Azure Blob Storage Source Parameters

The following table describes the parameters for configuring Azure Blob Storage as a source.

Field	Description
Azure Storage Blob Service URI	The URI of the Azure Blob Storage data source, including the account and container name. Format: `azure-storage-blob://accountName[/containerName]`
Azure Account Access key	An access key for the associated Azure account name to be used for authentication with Azure Blob Storage services. Format: `RAW(yourAccessKeyHere)`
File Format	The format of the files coming from the Azure Blob Storage service: Delimited—Events and fields in the file are separated by specific characters. For configuration related to Delimited files, see Delimited File Configuration Properties. JSON—Events in the file are JSON-encoded. For configuration related to JSON files, see JSON File Configuration Properties. XML—Events in the file are encoded as XML. For configuration related to XML files, see XML File Configuration Properties.
Additional Properties	Additional properties for the Azure Blob Storage service. For example, `blobName` to define blob for download. For more information, see Additional Properties.

Delimited File Configuration Properties

Field Description

Field	Description
Event Delimiter	The delimiter used to separate the events in the file. The default value is `\n`.
Field Delimiter	The delimiter used to separate the fields in each event. The default value is `,`.

Event Delimiter

The delimiter used to separate the events in the file.

The default value is \n.

Field Delimiter

The delimiter used to separate the fields in each event.

The default value is ,.

JSON File Configuration Properties

Field Description

Field	Description
JSON Path Filter Expression	The JSON Path expression to filter or split the JSON file. The default value is `$` (no split).

JSON Path Filter Expression

The JSON Path expression to filter or split the JSON file.

The default value is $ (no split).

XML File Configuration Properties

Field Description

Field	Description
XPath Filter Expression	The XPath expression to filter or split the XML file. The default value is `/` (no split).

XPath Filter Expression

The XPath expression to filter or split the XML file.

The default value is / (no split).

Additional Properties

Option	Type	Default	Description
blobName	String	None	The name of the blob to consume from a container. On the producer, this parameter is required only for blob-level operations.
blobOffset	long	`0`	The blob offset for upload or download operations.
closeStreamAfterRead	boolean	`true`	When true, indicates that the stream closes after a read operation.
dataCount	Long	None	The number of bytes to include in the range. This value must be greater than or equal to 0 if you specify it.
fileDir	String	None	The file directory where downloaded blobs are saved. You can use this parameter in both producer and consumer configurations.
maxResultsPerPage	Integer	None	The maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify `maxResultsPerPage` or specifies a value greater than 5,000, the server returns up to 5,000 items.
maxRetryRequests	int	`0`	The maximum number of additional HTTP Get requests that are made while reading data from a response body.
prefix	String	None	A filter that returns only blobs whose names begin with the specified prefix. This parameter can be null to return all blobs.
regex	String	None	A filter that returns only blobs whose names match the specified regular expression. This parameter can be null to return all blobs. If you set both `prefix` and `regex`, `regex` takes priority and `prefix` is ignored.
sasToken	String	None	A Shared Access Signature (SAS) token for authentication with Azure Blob Storage.
blobSequenceNumber	Long	`0`	A user-controlled value that you can use to track requests. The sequence number value must be between 0 and 2⁶³ - 1.
closeStreamAfterWrite	boolean	`true`	When true, indicates that the stream closes after a write operation.
commitBlockListLater	boolean	`true`	When true, indicates that staged blocks are not committed directly.
createAppendBlob	boolean	`true`	When true, indicates that append blocks are created when committing append blocks.
createPageBlob	boolean	`true`	When true, indicates that the page blob is created when uploading a page blob.
downloadLinkExpiration	Long	None	The expiration time in milliseconds that overrides the default expiration for the URL download link.
pageBlobSize	Long	`512`	The maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.
backoffErrorThreshold	int	None	The number of subsequent error polls that must occur before the `backoffMultiplier` activates. Error polls are polls that fail because of an error.
backoffIdleThreshold	int	None	The number of subsequent idle polls that must occur before the `backoffMultiplier` activates.
backoffMultiplier	int	None	A multiplier that allows the scheduled polling consumer to back off if there has been a number of subsequent idle polls or errors in a row. The multiplier represents the number of polls that are skipped before the next actual attempt occurs. When you use this option, you must also configure `backoffIdleThreshold` and/or `backoffErrorThreshold`.
delay	long	`500`	The number of milliseconds before the next poll.
greedy	boolean	`false`	When true, indicates that the ScheduledPollConsumer runs immediately again if the previous run polled one or more messages.
initialDelay	long	`1000`	The number of milliseconds before the first poll starts.
repeatCount	long	`0`	The maximum number of times the scheduler fires. For example, if you set this parameter to 1, the scheduler fires only once. If you set it to 5, the scheduler fires five times. A value of zero or a negative value means the scheduler fires indefinitely.
useFixedDelay	boolean	`true`	When true, indicates that fixed delay is used rather than fixed rate. See ScheduledExecutorService in the JDK for details.
sourceBlobAccessKey	String	None	The access key for the source blob in a copy blob operation. Because passing an access key as a header is unsafe, you can set it as a parameter instead.
credentials	Object	None	Credentials object for authentication with Azure Blob Storage.
credentialType	String	None	The type of credential to use for authentication (e.g., AZURE_IDENTITY, AZURE_SAS, SHARED_ACCOUNT_KEY).

Provide feedback