Azure Storage List

List blobs on a Microsoft Azure Storage.

Json

Example

You can use a connection string, or a shared key or a sas token. See examples below:

"Connection string"

{
  "name": "azure-storage-blob-list",
  "taskReferenceName": "azure_list",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "authenticationMode": "CONNECTION_STRING",
    "connectionString": "your-connection-string",
    "container": "your-container"
  }
}

Shared key

{
  "name": "azure-storage-blob-list",
  "taskReferenceName": "azure_list",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "authenticationMode": "SHARED_KEY",
    "sharedKey": "your-shared-key",
    "account": "your-account",
    "container": "your-container"
  }
}

Sas token

{
  "name": "azure-storage-blob-list",
  "taskReferenceName": "azure_list",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "authenticationMode": "SAS_TOKEN",
    "sasToken": "your-sas-token",
    "account": "your-account",
    "container": "your-container"
  }
}

Definition

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SUB_WORKFLOW.
			true: the job continues if there is an error on this task. false: the job fails.
			Input parameters of the task. See below

Inputs

Property	Description
authenticationMode	The authentication mode. Must be CONNECTION_STRING or SHARED_KEY or SAS_TOKEN.
connectionString	The connection string
sharedKey	The shared key.
sasToken	The sas token
account	The account.
container	The container.
prefix	Optional Allows you to filter files whose full name (including the path to access it) begins with this prefix.

Outputs

Property	Type	Description
listing		An XML file containing the path of available files on the server.

Output listing

Example

<Azure-Storage-Blob-List>
    <Account>mystorage</Account>
    <Container>my-container</Container>
    <Url>https://mystorage.blob.core.windows.net/my-container</Url>
    <Files>
        <File>
            <Name>img/products-1.jpg</Name>
            <Deleted/>
            <Metadata/>
            <Properties>
                <Created-On>2021-06-12T20:06:12</Created-On>
                <Last-Modified>2021-06-12T20:06:12</Last-Modified>
                <Content-Length>211326</Content-Length>
                <Content-Type>application/octet-stream</Content-Type>
                <Content-MD5>c802e1bd9b5f2b0d244bbc982f5082b3</Content-MD5>
            </Properties>
        </File>
        <File>
            <Name>img/products-2.jpg</Name>
            <Deleted/>
            <Metadata/>
            <Properties>
                <Created-On>2021-06-12T20:06:12</Created-On>
                <Last-Modified>2021-06-12T20:06:12</Last-Modified>
                <Content-Length>206634</Content-Length>
                <Content-Type>application/octet-stream</Content-Type>
                <Content-MD5>8747e564eb53cb2f1dcb9aae0779c2aa</Content-MD5>
            </Properties>
        </File>
    </Files>
</Azure-Storage-Blob-List>

Definition

XPath	Description	Occurs
Azure-Storage-Blob-List	The root element.	1
./Account	Azure account	1
./Container	The container	1
./Url	The url	1
./Files	Files	1
../File	For each file	0..*
../File/Name	The name of the file	1
../File/Deleted	If you are using the soft delete, the value is true	1
../File/Metadata	Metadata	0..*
../File/Properties	Additional properties	1
../Created-On	The creation time	1
..../Last-Modified	The last modified date	1
..../Content-Length	Content length	1
..../Content-Type	Content type	1
..../Content-MD5	MD5 of the file	1

Limits and additional notes

• 5 000 files by container