Skip to main content
azure-files icon

Azure Files Connector

SourceAPI DocsAPI ChangelogConnector Changelog

Description

Azure Files is Microsoft's cloud file sharing platform. While similar to Azure Blob Storage, Azure Files is geared towards creating SMB file shares that groups of users (rather than applications) can use. This component allows managing files and shares within Azure Files.

Information about Azure Files can be found on their documentation site.

A common integration pattern involves listing files in a file store, and performing a series of actions on the array of files that are returned. See our looping over files quickstart for information about how to create a loop over an array of files.

Connections

Connection String

key: connectionString

Limited access to Azure Storage resources can also be granted using Shared Access Signatures (SAS) authentication, which involves an access token. A connection string containing an SAS token can be obtained from the Azure Portal.

Prerequisites

  • An Azure Storage account
  • Access to the Azure Portal to generate a connection string with an SAS token

Setup Steps

  1. Sign in to the Azure Portal
  2. Navigate to the Storage account
  3. Under Security + networking, select Shared access signature
  4. Configure the allowed services, permissions, and an expiration date, then select Generate SAS and connection string
  5. Copy the generated Connection string

Configure the Connection

  • Enter the Connection String: the connection string for the active directory account
Token Expiration

The SAS token within the connection string will eventually expire. Configure a memorable expiration date so the token can be manually refreshed at a later date.

InputNotesExample
Connection String

The connection string for the active directory account.

BlobEndpoint=https://example.blob.core.windows.net/;QueueEndpoint=https://example.queue.core.windows.net/;FileEndpoint=https://example.file.core.windows.net/;TableEndpoint=https://example.table.core.windows.net/;SharedAccessSignature=sv=example=rwdlacupitfx&se=2024-05-01T03:51:00Z&st=20

Storage Shared Key

key: storageSharedKey

Azure Files can use storageSharedKeyCredential authentication, which involves an account and key pair.

Prerequisites

  • An Azure Storage account
  • Access to the Azure Portal to obtain the account name and account key

Setup Steps

  1. Sign in to the Azure Portal
  2. Navigate to the Storage account
  3. Under Security + networking, select Access keys
  4. Copy the Storage account name and one of the Key values

Configure the Connection

  • Enter the Account Name: the name of the active directory account
  • Enter the Account Key: the access key for the active directory account
InputNotesExample
Account Key

The access key for the active directory account.

exampleKey
Account Name

The name of the active directory account.

exampleName

Data Sources

Select Share

Select an Azure Files share. | key: selectShare | type: picklist

InputNotesExample
Connection

Actions

Copy File

Copy a file from one path to another. | key: copyFile

InputNotesExample
Connection
From Path

The file path of the source object within the share. Do not include a leading slash.

path/to/source/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
To Path

The file path of the destination object within the share. Do not include a leading slash.

path/to/destination/file.txt
Example Payload for Copy File
Loading…

Create Folder

Create a folder under an existing path. | key: createFolder

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Create Folder
Loading…

Create Share

Create a file share. | key: createShare

InputNotesExample
Connection
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Create Share
Loading…

Delete File

Delete a file. | key: deleteFile

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Delete File
Loading…

Delete Folder

Delete an empty folder under an existing path. | key: deleteFolder

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Delete Folder
Loading…

Delete Share

Delete a file share. | key: deleteShare

InputNotesExample
Connection
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Delete Share
Loading…

Download File

Download a file. | key: downloadFile

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Download File
Loading…

List Folder

List files and folders in a folder. | key: listFolder

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for List Folder
Loading…

List Shares

List the file shares available in the account. | key: listShares

InputNotesExample
Connection
Example Payload for List Shares
Loading…

Save From URL

Save a file from a URL to Azure Files. | key: saveFromUrl

InputNotesExample
Connection
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Source URL

The URL where the source file currently resides. This endpoint must be accessible via an unauthenticated HTTP GET request, and the response must return a content-length header.

https://example.com/path/to/file.txt

This action leverages NodeJS Streams to stream an HTTP response directly to Azure Files. This is helpful when working with large files because the entire file is never loaded into memory all at once. Instead, it's uploaded to Azure Files as it is downloaded.

The referenced source URL must be accessible via an unauthenticated HTTP GET request, and the HTTP response must include a content-length header.

Example Payload for Save From URL
Loading…

Upload File

Upload a file under an existing path. | key: uploadFile

InputNotesExample
Connection
File Contents

The contents to write to the file. This can be a string of text or binary data (like an image or PDF) that was generated in a previous step.

My File Contents
Path

The file path of the object within the share. Do not include a leading slash.

path/to/file.txt
Share Name

The name of the Azure Files share, a container where files are stored. A share can be created from within the Azure console. Share names contain only letters, numbers, and dashes.

my-file-share
Example Payload for Upload File
Loading…

Changelog

2026-06-29

Various modernizations and documentation updates

2026-04-30

Updated spectral version