(Node.js) Azure File Service: List Shares

Sample code to list the file shares in an Azure storage account.

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: List all the file shares in a storage account.
    // See also: https://docs.microsoft.com/en-us/rest/api/storageservices/list-shares

    // 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;
    }

    // Provide Azure Cloud credentials for the REST call.
    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.

    // Send the GET request to list the shares.
    var responseStr = rest.FullRequestNoBody("GET","/?comp=list");
    if (rest.LastMethodSuccess !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // When successful, the Azure Storage service will respond with a 200 response status code,
    // with an XML response body.

    if (rest.ResponseStatusCode !== 200) {
        // 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;
    }

    // Load the XML response for parsing.
    // An example of the response XML is shown below.
    var xml = new chilkat.Xml();
    success = xml.LoadXml(responseStr);

    console.log(xml.GetXml());

    // Here's a sample response:

    // <?xml version="1.0" encoding="utf-8" ?>
    // <EnumerationResults ServiceEndpoint="https://chilkat.file.core.windows.net/">
    //     <Shares>
    //         <Share>
    //             <Name>beardie</Name>
    //             <Properties>
    //                 <Last-Modified>Mon, 26 Jun 2017 21:24:57 GMT</Last-Modified>
    //                 <Etag>"0x8D4BCD9CBD872E5"</Etag>
    //                 <Quota>5120</Quota>
    //             </Properties>
    //         </Share>
    //         <Share>
    //             <Name>pip</Name>
    //             <Properties>
    //                 <Last-Modified>Mon, 26 Jun 2017 21:24:44 GMT</Last-Modified>
    //                 <Etag>"0x8D4BCD9C3D823D1"</Etag>
    //                 <Quota>5120</Quota>
    //             </Properties>
    //         </Share>
    //     </Shares>
    //     <NextMarker />
    // </EnumerationResults>

    // Let's iterate over the file shares
    var lastMod = new chilkat.CkDateTime();

    var numShares = xml.NumChildrenAt("Shares");
    var i = 0;
    while (i < numShares) {
        console.log("---- Share " + i + " ----");
        xml.I = i;
        console.log("Name: " + xml.GetChildContent("Shares|Share[i]|Name"));
        lastMod.SetFromRfc822(xml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"));
        // dt: DtObj
        var dt = lastMod.GetDtObj(true);
        console.log("Last-Modified YMD: " + dt.Year + "," + dt.Month + "," + dt.Day);

        i = i+1;
    }

    // Output for the above loop:

    // ---- Share 0 ----
    // Name: beardie
    // Last-Modified YMD: 2017,6,26
    // ---- Share 1 ----
    // Name: pip
    // Last-Modified YMD: 2017,6,26
    // 

    console.log("Success.");

}

chilkatExample();