Azure Files Component

Manage files and folders within Azure Files

Component key: azure-files

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 lets you manage 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.

Azure Files Connections

Connection String

You can also grant limited access to your Azure Storage Resources using Shared Access Signatures (SAS) authentication, which involves an access token. You can obtain a connection string containing an SAS token from the Azure Portal. Keep in mind this token will eventually expire. Make sure to configure an expiration date you will remember, so you can manually refresh the token at a later date.

Input	Notes	Example
Input Connection String string / Required connectionString	Notes Provide the connection string for your active directory account.	Example 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

Azure Files can use storageSharedKeyCredential authentication, which involves an account / key pair. You can obtain an account name / account key pair through the Azure Portal.

Input	Notes	Example
Input Account Key string / Required accountKey	Notes Provide the key for your active directory account.	Example exampleKey
Input Account Name string / Required accountName	Notes Provide the name for your active directory account.	Example exampleName

Actions

Copy File

Copy a file | key: copyFile

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input From Path string / Required fromPath	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the source object's file path. Do not include a leading /	Example path/to/source/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share
Input To Path string / Required toPath	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the destination object's file path. Do not include a leading /	Example path/to/destination/file.txt

Output Example Payload

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

---

Create Folder

Create a folder under an existing path | key: createFolder

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---

Create Share

Create a file share | key: createShare

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

{  "data": {    "lastModified": "2021-11-30T00:00:00.000Z",    "requestId": "example-request-id",    "version": "2019-07-07",    "date": "2021-11-30T00:00:00.000Z",    "errorCode": null,    "_response": {      "parsedHeaders": {}    }  }}

---

Delete File

Delete a file | key: deleteFile

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---

Delete Folder

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

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---

Delete Share

Delete a file share | key: deleteShare

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---

Download File

Download a file | key: downloadFile

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---

List Folder

List files and folders in a folder | key: listFolder

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

{  "data": [    {      "_response": {        "parsedHeaders": {},        "status": 200,        "request": {          "url": "www.prismatic.io",          "method": "POST",          "withCredentials": false,          "timeout": 500,          "requestId": "exampleID"        }      },      "shareName": "Example Share",      "serviceEndpoint": "https://example.com",      "directoryPath": "/share/exampleShare",      "continuationToken": "1234abc",      "segment": {        "directoryItems": [],        "fileItems": []      }    }  ]}

---

List Shares

Get a list of file shares available in the account | key: listShares

Input	Notes
Input Connection connection / Required azureConnection	Notes

Output Example Payload

{  "data": [    {      "name": "example",      "snapshot": "snapshot-v1",      "properties": {}    }  ]}

---

Upload File

Upload a file under an existing path | key: uploadFile

Input	Notes	Example
Input Connection connection / Required azureConnection	Notes	Example
Input File Contents data / Required fileContents	Notes The contents to write to a file. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.	Example My File Contents
Input Path string / Required path	Notes An object in Azure Files is a file that is saved in a 'share'. This represents the object's file path. Do not include a leading /	Example path/to/file.txt
Input Share Name string / Required shareName	Notes An Azure Files 'share' is a container where files are stored. You can create a share from within the Azure console. Share names contain only letters, numbers, and dashes.	Example my-file-share

Output Example Payload

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

---