n8n-nodes-azure-blob

n8n-nodes-azure-blob

This is an n8n community node that allows you to interact with Azure Blob Storage in your n8n workflows.

Features

Operations supported:

File Operations

• Upload: Upload files to Azure Blob Storage containers
• Download: Download files from Azure Blob Storage
• List: List blobs in a container with optional filtering
• Delete: Delete blobs from containers

Authentication Methods

• Account Key: Use storage account name and access key
• Connection String: Use complete connection string
• SAS Token: Use Shared Access Signature token

Installation

To install this node in your n8n instance:

Option 1: Install via npm (when published)

npm install n8n-nodes-azure-blob

Option 2: Manual installation

• Clone this repository
• Install dependencies: npm install (or pnpm install)
• Build the node: npm run build (or pnpm build)
• Link to your n8n installation

Option 3: Docker environment variable

Add to your n8n Docker environment:

N8N_EXTERNAL_STORAGE=n8n-nodes-azure-blob

Configuration

Credentials Setup

• Go to Settings → Credentials in your n8n instance
• Click Add credential and select Azure Blob Storage API
• Choose your authentication method and fill in the required fields:

Account Key Method

• Account Name: Your Azure Storage account name
• Account Key: Your storage account access key

Connection String Method

• Connection String: Complete connection string from Azure portal

SAS Token Method

• Account Name: Your Azure Storage account name
• SAS Token: Shared Access Signature token

Usage Examples

Upload a File

• Add the Azure Blob Storage node to your workflow
• Select Upload operation
• Set the Container Name
• Configure the Binary Property (usually 'data')
• Optionally set a custom Blob Name
• Set Content Type if needed

Download a File

• Add the Azure Blob Storage node
• Select Download operation
• Set the Container Name
• Specify the Blob Name to download
• Set the Binary Property Name for the output

List Blobs

• Add the Azure Blob Storage node
• Select List operation
• Set the Container Name
• Optionally set a Prefix to filter results
• Set Max Results limit

Delete a Blob

• Add the Azure Blob Storage node
• Select Delete operation
• Set the Container Name
• Specify the Blob Name to delete

Advanced Options

Upload Options

• Metadata: Add custom metadata key-value pairs
• Tags: Add blob index tags for searching and filtering
• Overwrite: Control whether to overwrite existing blobs
• Content Type: Set custom MIME type

Security Features

• Support for all Azure authentication methods
• Secure credential storage
• Connection testing capabilities

Error Handling

The node includes comprehensive error handling:

• Invalid credentials detection
• Missing container/blob validation
• Network connectivity issues
• Permission-related errors

Enable Continue on Fail in node settings to handle errors gracefully in your workflows.

Development

Prerequisites

• Node.js 18.10 or higher
• npm 8.0 or higher (or pnpm 8.9+ if preferred)

Setup

# Clone the repository
git clone https://github.com/pokash/n8n-nodes-azure-blob.git
cd n8n-nodes-azure-blob

# Install dependencies
npm install
# or with pnpm: pnpm install

# Build the project
npm run build
# or with pnpm: pnpm build

# Run linting
npm run lint
# or with pnpm: pnpm lint

# Format code
npm run format
# or with pnpm: pnpm format

Project Structure

├── credentials/
│   └── AzureBlobStorageApi.credentials.ts
├── nodes/
│   └── AzureBlobStorage/
│       ├── AzureBlobStorage.node.ts
│       └── azureBlob.svg
├── dist/                 # Built files
├── package.json
├── tsconfig.json
└── README.md

API Reference

Node Parameters

Resource: File

Upload Operation

• containerName (string, required): Target container name
• binaryPropertyName (string): Binary data property name (default: 'data')
• blobName (string): Custom blob name (optional)
• contentType (string): MIME type (auto-detected if not provided)

Download Operation

• containerName (string, required): Source container name
• downloadBlobName (string, required): Blob name to download
• downloadBinaryPropertyName (string): Output binary property name

List Operation

• containerName (string, required): Container to list
• prefix (string): Filter by prefix (optional)
• maxResults (number): Maximum results to return

Delete Operation

• containerName (string, required): Container name
• deleteBlobName (string, required): Blob name to delete

Output Data

Upload Response

{
  "blobName": "example.pdf",
  "containerName": "documents",
  "contentType": "application/pdf",
  "size": 12345,
  "etag": "\"0x8D9..\"",
  "lastModified": "2024-01-15T10:30:00.000Z",
  "url": "https://account.blob.core.windows.net/container/blob"
}

Download Response

{
  "blobName": "example.pdf",
  "containerName": "documents",
  "size": 12345,
  "contentType": "application/pdf",
  "lastModified": "2024-01-15T10:30:00.000Z",
  "etag": "\"0x8D9..\"",
  "url": "https://account.blob.core.windows.net/container/blob"
}

List Response

{
  "containerName": "documents",
  "blobs": [
    {
      "name": "file1.pdf",
      "size": 12345,
      "contentType": "application/pdf",
      "lastModified": "2024-01-15T10:30:00.000Z",
      "etag": "\"0x8D9..\"",
      "url": "https://account.blob.core.windows.net/container/file1.pdf"
    }
  ],
  "totalCount": 1
}

Troubleshooting

Common Issues

Authentication Errors

• Verify your credentials are correct
• Check that your storage account is accessible
• Ensure SAS tokens have appropriate permissions

Container Not Found

• Verify the container name exists
• Check container permissions
• Ensure your credentials have access to the container

Upload Failures

• Check if binary data property exists
• Verify container has write permissions
• Ensure blob name doesn't contain invalid characters

Download Failures

• Verify blob exists in the container
• Check read permissions
• Ensure blob name is spelled correctly

Debug Tips

• Enable Continue on Fail to see detailed error messages
• Test credentials using the credential test feature
• Check Azure Storage logs for detailed error information
• Verify container and blob names in Azure portal

Support

For issues and questions:

• GitHub Issues: Create an issue
• Email: [e-mail]

License

MIT License - see LICENSE file for details.

Contributing

• Fork the repository
• Create a feature branch
• Make your changes
• Add tests if applicable
• Run pnpm lint and pnpm build
• Submit a pull request

Changelog

Version 1.0.0

• Initial release
• Upload, Download, List, and Delete operations
• Support for Account Key, Connection String, and SAS Token authentication
• Comprehensive error handling
• Metadata and tags support for uploads
• Binary data handling for file operations