(Node.js) Azure File Service: Upload File

Sample code to upload a file to a directory in a share in the Azure File Service. A file is uploaded by first creating the file in the Azure share and then writes a range of bytes to the file. Azure imposes a 4MB limit for each PUT to write a range. Files larger than 4MB need to be uploaded by making multiple "Put Range" calls. This example uploads a file small enough for a single "Put Range" call.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // Azure File Service Example: Upload a file.  
    // See:  https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
    // also see: https://docs.microsoft.com/en-us/rest/api/storageservices/put-range

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();

    // Connect to the Azure Storage Blob Service
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    // In this example, the storage account name is "chilkat".
    var success = rest.Connect("chilkat.file.core.windows.net",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // This example will upload a relatively small file (760K), so it may as well 
    // just be load it into memory..
    var jpgData = new chilkat.BinData();
    jpgData.LoadFile("qa_data/jpg/penguins.jpg");

    // Provide Azure Cloud credentials for the REST calls.
    var azAuth = new chilkat.AuthAzureStorage();
    azAuth.AccessKey = "AZURE_ACCESS_KEY";
    // The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    azAuth.Account = "chilkat";
    azAuth.Scheme = "SharedKey";
    azAuth.Service = "File";
    // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    azAuth.XMsVersion = "2021-08-06";
    success = rest.SetAuthAzureStorage(azAuth);

    // Note: The application does not need to explicitly set the following
    // headers: x-ms-date, Authorization.  These headers
    // are automatically set by Chilkat.

    // However, a few additional headers are required for the "Create File" operation:
    rest.AddHeader("x-ms-type","file");

    // This required header specifies the final size of the file (or the maximum size it can be).
    var sbFileSize = new chilkat.StringBuilder();
    sbFileSize.AppendInt(jpgData.NumBytes);
    rest.AddHeader("x-ms-content-length",sbFileSize.GetAsString());

    // Send a PUT request to create the file (or replace the file if it already exists).
    // This will initialize the file in the Azure file storage.  To upload content, we'll need
    // to do the "Put Range" operation one or more times.

    // The following will create the file "penguins.jpg" in the share "pip", in the directory "/wildlife/antarctic"
    var responseStr = rest.FullRequestNoBody("PUT","/pip/wildlife/antarctic/penguins.jpg");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // When successful, the Azure File Service will respond with a 201 (Created) response status code,
    // with no XML response body.  If an error response is returned, there will be an XML response body.

    if (rest.ResponseStatusCode !== 201) {
        // Examine the request/response to see what happened.
        console.log("response status code = " + rest.ResponseStatusCode);
        console.log("response status text = " + rest.ResponseStatusText);
        console.log("response header: " + rest.ResponseHeader);
        console.log("response body (if any): " + responseStr);
        console.log("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
        return;
    }

    console.log("Successfully created penguins.jpg");

    // --------------------------------------------------------------------------------
    // Upload the file data...

    // Make sure the headers from the "Create File" operation are removed.
    rest.ClearAllHeaders();

    // The only tricky part here is to correctly add the x-ms-range header.
    // It will be formatted like this:
    // x-ms-range: bytes=0-759623

    var sbRange = new chilkat.StringBuilder();
    sbRange.Append("bytes=0-");
    sbRange.AppendInt(jpgData.NumBytes - 1);

    rest.AddHeader("x-ms-range",sbRange.GetAsString());

    // The x-ms-write header is also required:
    rest.AddHeader("x-ms-write","update");

    var sbResponseBody = new chilkat.StringBuilder();
    // IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
    success = rest.FullRequestBd("PUT","/pip/wildlife/antarctic/penguins.jpg?comp=range",jpgData,sbResponseBody);
    if (success !== true) {
        // This would indicate a failure where no response was received.
        console.log(rest.LastErrorText);
        return;
    }

    // A 201 response indicates the data was uploaded.
    if (rest.ResponseStatusCode !== 201) {
        // Examine the request/response to see what happened.
        console.log("response status code = " + rest.ResponseStatusCode);
        console.log("response status text = " + rest.ResponseStatusText);
        console.log("response header: " + rest.ResponseHeader);
        console.log("response body (if any): " + responseStr);
        console.log("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
        return;
    }

    console.log("Successfully uploaded data into penguins.jpg");

}

chilkatExample();