MuleSoft Anypoint Azure Storage Connector

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Access Key Azure Connection
Parameters
Name Type Description Default Value Required

Account Name

String

x 

Account Key

String

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Pooling Profile

Characteristics of the connection pool

 

Sas Token Azure Connection
Parameters
Name Type Description Default Value Required

Account Name

String

x 

Sas Token

String

x 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy

 

Pooling Profile

Characteristics of the connection pool

 

Operations

Add Entity

<azure-storage:add-entity>

Adds entity to the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Add Message To Queue

<azure-storage:add-message-to-queue>

Uploads message to the Queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Message

Message object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Batch Insert Or Merge Entity

<azure-storage:batch-insert-or-merge-entity>

Insert or Merge multiple entities to the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entities

Array of Entity

List of Entity objects Entity object

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Batch Insert Or Replace Entity

<azure-storage:batch-insert-or-replace-entity>

Insert or Replaces entity in the given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entities

Array of Entity

List of Entity objects Entity object

#[payload]

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Create Container

<azure-storage:create-container>

Creates a container with the provided name in the storage account. Note that the container name must be lowercase.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Container Name

String

Name of the Container

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Create Directory

<azure-storage:create-directory>

Create directory in the Share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory

Directory object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Create Queue

<azure-storage:create-queue>

Creates Queue in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

Name of the Queue to be created.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Create Share

<azure-storage:create-share>

Creates Share in the storage account. A File storage share is an SMB file share in Azure. All directories and files must be created in a parent share. An account can contain an unlimited number of shares, and a share can store an unlimited number of files, up to the 5 TB total capacity of the file share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Share Name

String

Name of the Share to be created.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Create Table

<azure-storage:create-table>

Creates a Table in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Name

String

Name of the table to be created

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Blob

<azure-storage:delete-blob>

Deletes the container in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Blob

Blob object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Container

<azure-storage:delete-container>

Deletes container from the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Container Name

String

Name of the container to be deleted

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Directory

<azure-storage:delete-directory>

Deletes the directory from the Share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory

Directory object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Entity

<azure-storage:delete-entity>

Deletes the entity from the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Entity Definition

EntityDefinition object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete File

<azure-storage:delete-file>

Deletes file from the directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory File

DirectoryFile object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Queue

<azure-storage:delete-queue>

Deletes the Queue from the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

Name of the Queue.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Share

<azure-storage:delete-share>

Deletes the Share from the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Share Name

String

Name of the Share to be deleted

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Delete Table

<azure-storage:delete-table>

Deletes the table from the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Name

String

Name of the table

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Dequeue Message

<azure-storage:dequeue-message>

Retrieves single message from the Queue and deletes it from the Queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

Name of the Queue.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Dequeue Messages

<azure-storage:dequeue-messages>

Gets list of messages from the Queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Messages

DequeueMessages object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Queue Message

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Download Blob

<azure-storage:download-blob>

Downloads the Blob from the container.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Blob

Blob object

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Download Blob Using Reg Ex

<azure-storage:download-blob-using-reg-ex>

Downloads the Blob based on the RegEx.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Blob Reg Ex

String

String

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Download File

<azure-storage:download-file>

Downloads the file from the directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory File

DirectoryFile object

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Binary

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Download File From Root Directory

<azure-storage:download-file-from-root-directory>

Downloads the file from the root directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Root File

RootFile object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Get All Entities

<azure-storage:get-all-entities>

Get all entities of the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Entity Definition

EntityDefinition object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Get List Of Queues

<azure-storage:get-list-of-queues>

Gets list of Queues in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Azure Queue

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Get Queue Length

<azure-storage:get-queue-length>

Gets the length of the Queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

Name of the Queue.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Get Share

<azure-storage:get-share>

Get Share details in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Share Name

String

azure storage share name

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Get Single Entity

<azure-storage:get-single-entity>

Retrieves single entity of the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Entity Definition

EntityDefinition object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Insert Or Merge Entity

<azure-storage:insert-or-merge-entity>

Insert or Merge entity to the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Insert Or Replace Entity

<azure-storage:insert-or-replace-entity>

Insert or Replaces entity in the given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Is Blob Exists

<azure-storage:is-blob-exists>

Checks the presence of given Blob in a container.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Container Name

String

Name of the container.

x 

Blob Name

String

Name of the Blob

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

List All Containers

<azure-storage:list-all-containers>

Gets the list of all the containers in the storage account. A container provides a grouping of a set of blobs. All blobs must be in a container. An account can contain an unlimited number of containers. A container can store an unlimited number of blobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Blob Container

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

List Blobs In Container

<azure-storage:list-blobs-in-container>

Gets the list of Blobs in a container.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Container Name

String

Name of the container.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Blob Item

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

List Filesand Directory In Directory

<azure-storage:list-filesand-directory-in-directory>

Gets the list of Files and Directories in the specified Directory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Directory

Directory object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of File Item

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

List Filesand Directory In Share

<azure-storage:list-filesand-directory-in-share>

Gets the list of Files and Directories in the specified Share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Share Name

String

Name of the Share

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of File Item

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

List Table

<azure-storage:list-table>

Gets list of Tables in the storage account.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of String

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Merge Entity

<azure-storage:merge-entity>

Merges entity in the given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Peek Message From Queue

<azure-storage:peek-message-from-queue>

Peek at the message in the front of a queue without removing it from the queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Queue Name

String

Name of the Queue.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Replace Entity

<azure-storage:replace-entity>

Replaces entity in the given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Update Entity

<azure-storage:update-entity>

Updates entity in the given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Table Entity

Entity object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Update Message

<azure-storage:update-message>

Change the contents of a queued message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Qmessage

UpdateMessage object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload Blob

<azure-storage:upload-blob>

Uploads the Blob into the storage.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Storblob

BlobByFileStream object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload Blob From Path

<azure-storage:upload-blob-from-path>

Uploads the Blob into the storage from a file path.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Blobpath

BlobByPath object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload File In Directory

<azure-storage:upload-file-in-directory>

An Azure File Storage Share contains at the very least, a root directory where files can reside. Uploads a file from the given path to the specified directory of a share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File Name

DirectoryFileUploadByPath object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload File In Directory With Stream

<azure-storage:upload-file-in-directory-with-stream>

Uploads a file input stream to the specified directory of a share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Filename

DirectoryFileUploadByStream object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload File In Root Directory

<azure-storage:upload-file-in-root-directory>

An Azure File Storage Share contains at the very least, a root directory where files can reside. Uploads a file from the given path to the specified directory of a share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

File

RootFileUploadByPath object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Upload File In Root Directory With Stream

<azure-storage:upload-file-in-root-directory-with-stream>

Uploads a file input stream to the specified directory of a share.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Rootfile

RootFileUploadByStream object

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Value

String

An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Boolean

For Configurations.

Throws

  • AZURE-STORAGE:RETRY_EXHAUSTED  

  • AZURE-STORAGE:EXECUTION  

  • AZURE-STORAGE:CONNECTIVITY  

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Entity

Field Type Description Default Value Required

Partitionkey

String

Properties

Object

Rowkey

String

Table Name

String

Message

Field Type Description Default Value Required

Queue Message

String

Queue Name

String

Directory

Field Type Description Default Value Required

Directory Name

String

Share Name

String

Blob

Field Type Description Default Value Required

Container

String

File Name

String

Entity Definition

Field Type Description Default Value Required

Partitionkey

String

Rowkey

String

Table Name

String

Directory File

Field Type Description Default Value Required

Directory Name

String

File Name

String

Share Name

String

Queue Message

Field Type Description Default Value Required

Dequeue Count

Number

Expiration Time

DateTime

Id

String

Insertion Time

DateTime

Message Content

String

Next Visible Time

DateTime

Pop Receipt

String

Dequeue Messages

Field Type Description Default Value Required

Number Of Messages

Number

Queue Name

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Root File

Field Type Description Default Value Required

File Name

String

Share Name

String

Azure Table Entity

Field Type Description Default Value Required

Etag

String

Partition Key

String

Properties

Object

Row Key

String

Azure Queue

Field Type Description Default Value Required

Approximate Message Count

Number

Message Request Address

Metadata

Object

Name

String

Should Encode Message

Boolean

Storage Uri

Azure Storage URI

Field Type Description Default Value Required

Absolute

Boolean

Primary Uri

Any

Query

String

Secondary Uri

Any

File Share

Field Type Description Default Value Required

Metadata

Object

Name

String

Properties

Storage Uri

File Properties

Field Type Description Default Value Required

Etag

String

Last Modified

Date

Share Quota

Number

Blob Container

Field Type Description Default Value Required

Container Name

String

Container URI

Any

Metadata

Object

Blob Item

Field Type Description Default Value Required

Blob Container

Storage Uri

Uri

Any

File Item

Field Type Description Default Value Required

Parent

Share

Storage Uri

Uri

Any

File Directory

Field Type Description Default Value Required

Metadata

Object

Name

String

Parent

Properties

Share

Storage Uri

Update Message

Field Type Description Default Value Required

Queue Message

String

Queue Name

String

Update Queue Message

String

Blob By File Stream

Field Type Description Default Value Required

Container

String

File Name

String

File Stream

Binary

Blob By Path

Field Type Description Default Value Required

Container

String

File Name

String

Filepath

String

Directory File Upload By Path

Field Type Description Default Value Required

Directory Name

String

File Name

String

Path

String

Share Name

String

Directory File Upload By Stream

Field Type Description Default Value Required

Directory Name

String

File Name

String

File Stream

Binary

Share Name

String

Root File Upload By Path

Field Type Description Default Value Required

File Name

String

Path

String

Share Name

String

Root File Upload By Stream

Field Type Description Default Value Required

File Name

String

File Stream

Binary

Share Name

String