Azure Storage SDK for JavaScript - File Services

This documentation provides comprehensive guidance on using the Azure Storage SDK for JavaScript to interact with Azure File Shares. The SDK simplifies common operations like uploading, downloading, listing, and managing files and directories within your file shares.

Getting Started

To begin, ensure you have Node.js installed. Then, install the necessary SDK package:

npm install @azure/storage-file-share

Authentication

You can authenticate with Azure File Shares using a connection string or with Azure Identity credentials.

Using a Connection String

A connection string contains all the information needed to connect to your storage account.

const { ShareServiceClient } = require("@azure/storage-file-share");

const connectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
const shareServiceClient = ShareServiceClient.fromConnectionString(connectionString);
            

Using Azure Identity

For more secure scenarios, especially in production environments, use Azure Identity. Ensure you have authenticated your environment (e.g., via Azure CLI login).

const { ShareServiceClient } = require("@azure/storage-file-share");
const { DefaultAzureCredential } = require("@azure/identity");

const accountName = "YOUR_STORAGE_ACCOUNT_NAME";
const credential = new DefaultAzureCredential();
const shareServiceClient = new ShareServiceClient(`https://${accountName}.file.core.windows.net`, credential);
            

Key Concepts

• ShareServiceClient: The top-level client for interacting with Azure File Shares.
• ShareClient: Represents a specific file share within your storage account.
• ShareDirectoryClient: Represents a directory within a file share.
• ShareFileClient: Represents a file within a directory or file share.

Common Operations

Creating a File Share

async function createShare(shareServiceClient, shareName) {
    try {
        const createShareResponse = await shareServiceClient.createShare(shareName);
        console.log(`Share '${shareName}' created successfully.`);
    } catch (error) {
        console.error("Error creating share:", error.message);
    }
}
            

Listing File Shares

async function listShares(shareServiceClient) {
    console.log("Listing shares:");
    for await (const share of shareServiceClient.listShares()) {
        console.log(`- ${share.name}`);
    }
}
            

Working with Directories

You can create, list, and manage directories within a share.

async function manageDirectory(shareClient) {
    const directoryName = "my-directory";
    const directoryClient = shareClient.getDirectoryClient(directoryName);

    try {
        await directoryClient.create();
        console.log(`Directory '${directoryName}' created.`);

        console.log(`Listing contents of '${directoryName}':`);
        for await (const item of directoryClient.listHandles()) {
            console.log(`- ${item.name}`);
        }
    } catch (error) {
        console.error("Error managing directory:", error.message);
    }
}
            

Working with Files

Upload, download, and manage files.

const { BlobServiceClient } = require("@azure/storage-blob"); // Note: File operations often use Blob SDK concepts/methods

async function manageFile(shareClient) {
    const directoryClient = shareClient.getDirectoryClient("my-directory");
    const fileName = "sample.txt";
    const fileClient = directoryClient.getFileClient(fileName);
    const fileContent = "Hello Azure Files!";

    try {
        // Upload file
        const uploadResponse = await fileClient.upload(fileContent, fileContent.length);
        console.log(`File '${fileName}' uploaded. Upload ID: ${uploadResponse.etag}`);

        // Download file
        const downloadResponse = await fileClient.download();
        const downloadedContent = await downloadResponse.text();
        console.log(`Downloaded content of '${fileName}': "${downloadedContent}"`);

    } catch (error) {
        console.error("Error managing file:", error.message);
    }
}