Skip to main content

Azure Blob Storage Component

Manage files and folders within Azure Blob Storage

Component key: azure-blob

Description#

Azure Blob Storage is a cloud solution for storing unstructured data, like large binary or text files. It's often used to store blob data for web applications that don't store nicely in a relational database.

This component allows you to list, create and delete Azure containers, and create and modify blobs (files) within those Azure containers.

Information about Azure Blob Storage can be found on their documentation site.

Authorization Notes#

Azure components use storageSharedKeyCredential authentication, which involves an account / key pair. You can obtain an account name / account key pair through the Azure Portal. Enter the account name as your Username, and account key as your Password.

Actions#

Append to Append Blob#

Append blocks to an existing append blob | key: appendToAppendBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

File Contents

data
/ Required
fileContentsThe contents to write to a blob. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.My File Contents

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Create Append Blob#

Create an empty append blob object (use "Append to Append Blob" to add blocks) | key: createAppendBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Create Container#

Create a container | key: createContainer

InputKeyNotesExample

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Create Page Blob#

Create a page blob with a specific size (must be a multiple of 512 bytes) | key: createPageBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Page Blob Size

string
/ Required
pageBlobSizeSpace can be reserved in Azure Blob Store in 512-byte chunks. This must be a multiple of 512 (e.g. 1024, 1536, 2048, etc.).4096

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Delete Blob#

Delete a blob | key: deleteBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Delete Container#

Delete a container | key: deleteContainer

InputKeyNotesExample

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Download Blob#

Download a blob | key: downloadBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "type": "Buffer",    "data": [      69,      120,      97,      109,      112,      108,      101    ]  },  "contentType": "application/octet"}

List Blobs#

Get a list of blobs in a container | key: listBlobs

InputKeyNotesExample

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Prefix

string
prefixList only blobs prefixed with this string. For example, if you only want blobs in a directory called 'unprocessed', you can enter 'unprocessed/'. If this is left blank, all files in the selected bucket will be listed.path/to/files/

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": [    {      "name": "Example",      "deleted": false,      "snapshot": "",      "properties": {        "lastModified": "2020-01-01T00:00:00.000Z",        "etag": "Example Tag"      }    }  ]}

List Containers#

Get a list of containers available in the account | key: listContainers

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": [    {      "name": "Example",      "properties": {        "lastModified": "2020-01-01T00:00:00.000Z",        "etag": "Example Tag"      }    }  ]}

Resize Page Blob#

Resize an existing page blob (must be a multiple of 512 bytes) | key: resizePageBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

Page Blob Size

string
/ Required
pageBlobSizeSpace can be reserved in Azure Blob Store in 512-byte chunks. This must be a multiple of 512 (e.g. 1024, 1536, 2048, etc.).4096

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Upload Block Blob#

Upload file data to a block blob object | key: uploadBlockBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

File Contents

data
/ Required
fileContentsThe contents to write to a blob. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.My File Contents

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}

Upload to Page Blob#

Upload to an existing page blob (both data size and offset must be a multiple of 512) | key: uploadToPageBlob

InputKeyNotesExample

Blob Name

string
/ Required
blobNameA blob is a file that is saved in a 'container'. This represents the blob's key (file path). Include a leading /./path/to/file.txt

Container Name

string
/ Required
containerNameAzure blob 'continer' stores files. You can create a container within the Azure console. Container names contain only letters, numbers, and dashes.my-azure-blob-container

File Contents

data
/ Required
fileContentsThe contents to write to a blob. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.My File Contents

Page Blob Offset

string
/ Required
pageBlobOffsetYou can begin to write to an Azure blob starting at a particular block. This value must be a multiple of 512 (e.g. 1024, 1536, 2048, etc.).2048

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "_response": {      "parsedHeaders": {},      "status": 200,      "headers": {},      "request": {        "url": "www.prismatic.io",        "method": "POST",        "withCredentials": false,        "timeout": 500,        "requestId": "exampleID"      }    }  }}