(Node.js) Azure Blob - Get Tags (Check if Blob Exists)

See more Azure Cloud Storage Examples

Gets the user-defined tags for a specified blob. This can also be used as a way to check to see if a blob exists.

For more information, see https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-tags

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() {

    // 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.blob.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 = "Blob";
    // 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: Content-Length, x-ms-date, Authorization.  These headers
    // are automatically set by Chilkat.

    // The Azure blob container is "test", the file is "helloWorld.txt"
    // Add "?comp=tags" to get the user-defined tags instead of the actual blob content.
    var sb = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/test/helloWorldajdfadf.txt?comp=tags",sb);
    if (success == false) {
        // 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("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
        return;
    }

    // A typical blob with no tags will return this:

    // <?xml version="1.0" encoding="utf-8"?>
    // <Tags><TagSet/></Tags>

    // If the blob does not exist, you get this:

    // <?xml version="1.0" encoding="utf-8"?>
    // <Error>
    //     <Code>BlobNotFound</Code>
    //     <Message>The specified blob does not exist.
    // 	RequestId:fcfefdd9-301e-001a-2135-3a23d2000000
    // 	Time:2023-02-06T14:17:00.7805577Z
    //     </Message>
    // </Error>

    console.log(sb.GetAsString());

    // To see if we got Tags or an Error, then examine the XML.
    var xml = new chilkat.Xml();
    xml.LoadSb(sb,true);

    // Examine the tag..
    if (xml.TagEquals("Tags") == true) {
        console.log("Blob exists!");
    }
    else {

        if (xml.ChildContentMatches("Code","BlobNotFound",true) == true) {
            console.log("Blob does not exist.");
        }
        else {
            console.log("Some other error...");
        }

    }

    console.log("Success.");

}

chilkatExample();