IMPORTANT: This documentation has been discontinued. Read the updated Azure Blob Storage documentation on our new documentation portal.
Blob Storage (Azure)+ allows you to work with files stored in Azure Blob Storage containers.
Configuration parameters
Take a look at the configuration options for the component:
Account: account to be used by the component (list the accounts supported by the component). Supported accounts are: basic and public key. Basic is used to connect via ConnectionString, the storage account name must be passed in the user field and key1 in the password field. The public key is used if you want to authenticate via SAS token, use the public-key in the key field, pass the SAS token generated by Azure. To learn more about these accounts and the other existing types, click on the button.
Step Name: Name of the step in which the component is configured.
Operation: What operation will the component perform, list, download, upload and delete (completion of this field is mandatory).
Container Name: Name of the Blob Storage container (Azure) that will handle the files (completion of this field is mandatory).
Container Account: Azure account name that Blob Storage uses (completion of this field is mandatory).
Remote File Name: Destination name of your file, the name that the file will have in Blob Storage (Azure) (completion of this field is mandatory only in upload, download and delete operations). This parameter accepts Double Braces.
File Name: Name of the file you want to upload to your Blob Storage (Azure) (completion of this field is mandatory). This parameter accepts Double Braces.
Show File Link: Generates a file download link when it is set to true and the operation is upload.
Fail On Error: If the parameter is set to true, it throws the exception forward.
Page Size: Number of records you want to bring per page (only when the operation is List) This parameter accepts Double Braces.
Next Page Token: NextToken that will be used to bring the records from the next page (only when the operation is List). This parameter accepts Double Braces.
Next Page Type: Type of the next record that will be listed on the next page (only when the operation is List).
Overwrite File on Upload: Overwrite the file at the time of upload (only when the operation is Upload). This parameter accepts Double Braces.
Some of the above parameters accept Double Braces. To better understand how this language works, read our article by clicking.
Messages flow
Return example when operation is list:
{
"success": true,
"content": [
{
"fileName": "my-remote-file.txt",
"containerName": "newcontainer",
"properties": {
"createdDate": "Fri May 20 13:41:12 UTC 2022",
"lastUpdated": "Wed May 25 14:59:26 UTC 2022",
"contentType": "application/octet-stream",
"length": 23
}
},
{
"fileName": "testeOverwrite.txt",
"containerName": "newcontainer",
"properties": {
"createdDate": "Tue Jun 14 18:11:35 UTC 2022",
"lastUpdated": "Tue Jun 14 18:11:47 UTC 2022",
"contentType": "application/octet-stream",
"length": 76952
}
}
],
"count": 2,
"containerName": "newcontainer"
}
Important: New fields have been added in the component to make it possible to filter by prefix, and we now have the option to include some file types in the return, such as deleted for example:
Prefix: Filters the results to return only blobs whose names begin with the specified prefix on list operation: Allow Double Braces
Snapshot: Include Snapshots on blobs response for list operation
Metadata: Include Metadata on blobs response for list operation
Uncommited: Include Uncommited blobs on response for list operation
Copy: Include Copy blobs on response for list operation
Delete: Include Delete blobs on response for list operation
Return example when operation is upload:
{
"success": true,
"fileName": "teste-upload.jpeg",
"containerName": "teste",
"remoteFileName": "teste-upload.jpeg",
"urlGenerated": "https://digibeeblobstorage.blob.core.windows.net/teste/teste-upload.jpeg"
}
Return example when operation is download:
Important: Use the File Reader component to handle the base64 returned.
Return example when operation is delete:
{
"success": true,
"containerName": "newcontainer",
"remoteFileName": "teste-upload.jpeg"
}