Blob Storage (Azure)

The Digibee Integration Platform provides many options for file storage. The Documentation Portal helps users identify the best solution for them. This article covers Blob Storage (Azure).

Blob Storage (Azure) allows you to work with files stored in Azure Blob Storage containers.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Account	The 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. Public key is used if you want to authenticate via SAS token; use the public-key in the "key" field, then pass the SAS token generated by Azure. Read the Accounts documentation to learn more about these and other existing account types.	N/A	String
Operation	Defines which operation will the component perform (List, Download, Upload, and Delete). Completion of this field is mandatory.	Upload	String
Container Name	Name of the Blob Storage container (Azure) that will handle the files. Completion of this field is mandatory.	container	String
Container Account	Azure account name that Blob Storage uses. Completion of this field is mandatory.	N/A	String
Remote File Name `(DB)`	Destination name of your file, the same name that the file will have in Blob Storage (Azure). Completion of this field is mandatory only when Upload, Download or Delete operations are selected.	test.csv	String
File Name `(DB)`	Name of the file you want to upload to your Blob Storage (Azure). Completion of this field is mandatory.	file.csv	String
Generate a Download Link	If the option is enabled, you will be able to generate a file download link. This parameter is shown only when the Upload operation is selected.	True	Boolean
Page Size `(DB)`	Number of records you want to bring per page. This parameter is shown only when the List operation is selected.	N/A	Integer
Prefix	Filters the results to return only blobs whose names begin with the specified prefix. This parameter is shown only when the List operation is selected.	N/A	String
Next Page Token `(DB)`	NextToken that will be used to bring the records from the next page. This parameter is shown only when the List operation is selected.	N/A	String
Next Token Type `(DB)`	Type of the next record that will be listed on the next page. This parameter is shown only when the List operation is selected.	N/A	String
Overwrite File on Upload	Overwrite the file at the time of upload. This parameter is shown only when the Upload operation is selected.	True	Boolean
Snapshot	If the option is activated, it will include snapshots on the blobs' response. Available only for the List operation.	False	Boolean
Metadata	If the option is activated, it will include metadata on the blobs' response. Available only for the List operation.	False	Boolean
Uncommited	If the option is activated, it will include uncommited blobs on response. Available only for the List operation.	False	Boolean
Copy	If the option is activated, it will include copy blobs on response. Available only for the List operation.	False	Boolean
Delete	If the option is activated, it will include delete blobs on response. Available only for the List operation.	False	Boolean
Fail On Error	If the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.	False	Boolean

Account

The 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. Public key is used if you want to authenticate via SAS token; use the public-key in the "key" field, then pass the SAS token generated by Azure. Read the Accounts documentation to learn more about these and other existing account types.

N/A

String

Operation

Defines which operation will the component perform (List, Download, Upload, and Delete). Completion of this field is mandatory.

Upload

String

Container Name

Name of the Blob Storage container (Azure) that will handle the files. Completion of this field is mandatory.

container

String

Container Account

Azure account name that Blob Storage uses. Completion of this field is mandatory.

N/A

String

Remote File Name (DB)

Destination name of your file, the same name that the file will have in Blob Storage (Azure). Completion of this field is mandatory only when Upload, Download or Delete operations are selected.

test.csv

String

File Name (DB)

Name of the file you want to upload to your Blob Storage (Azure). Completion of this field is mandatory.

file.csv

String

Generate a Download Link

If the option is enabled, you will be able to generate a file download link. This parameter is shown only when the Upload operation is selected.

True

Boolean

Page Size (DB)

Number of records you want to bring per page. This parameter is shown only when the List operation is selected.

N/A

Integer

Prefix

Filters the results to return only blobs whose names begin with the specified prefix. This parameter is shown only when the List operation is selected.

N/A

String

Next Page Token (DB)

NextToken that will be used to bring the records from the next page. This parameter is shown only when the List operation is selected.

N/A

String

Next Token Type (DB)

Type of the next record that will be listed on the next page. This parameter is shown only when the List operation is selected.

N/A

String

Overwrite File on Upload

Overwrite the file at the time of upload. This parameter is shown only when the Upload operation is selected.

True

Boolean

Snapshot

If the option is activated, it will include snapshots on the blobs' response. Available only for the List operation.

False

Boolean

Metadata

If the option is activated, it will include metadata on the blobs' response. Available only for the List operation.

False

Boolean

Uncommited

If the option is activated, it will include uncommited blobs on response. Available only for the List operation.

False

Boolean

Copy

If the option is activated, it will include copy blobs on response. Available only for the List operation.

False

Boolean

Delete

If the option is activated, it will include delete blobs on response. Available only for the List operation.

False

Boolean

Fail On Error

If the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

False

Boolean

Messages flow

Operation 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"
}

Operation Upload

{
"success": true,
"fileName": "teste-upload.jpeg",
"containerName": "teste",
"remoteFileName": "teste-upload.jpeg",
"urlGenerated": "
https://digibeeblobstorage.blob.core.windows.net/teste/teste-upload.jpeg
"
}

Operation Download

Important: Use the File Reader component to handle the base64 returned.

Operation Delete

{
"success": true,
"containerName": "newcontainer",
"remoteFileName": "teste-upload.jpeg"
}

PreviousFile storage NextDigibee Storage

Last updated 1 year ago