JavaScript

Get Container Metadata

See more Azure Cloud Storage Examples

Azure Storage Blob Service REST API: Sample code to get the user-defined metadata of a container. JavaScript

var success = false;

// Azure Blob Service Example: Get Container User-Defined Metadata
// See also: https://msdn.microsoft.com/en-us/library/azure/ee691976.aspx

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

var rest = new CkRest();

// 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".
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 CkAuthAzureStorage();
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: x-ms-date, Authorization.  These headers
// are automatically set by Chilkat.

// The expected success response is a 200 response status code with no response body.
// In this example, we are getting the metadata of the container named "mycontainer".
var responseStr = rest.FullRequestNoBody("GET","/mycontainer?restype=container&comp=metadata");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// When successful, the Azure Storage service will respond with a 200 response status code,
// with no 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;
}

// The user-defined metadata is located in the response header.
// The full response header can be obtained like this:
console.log("response header: " + rest.ResponseHeader);
console.log("--");

// Metadata headers begin with "x-ms-meta-"
// Individual response header fields can be retrieved like this:
console.log("x-ms-meta-Category: " + rest.ResponseHdrByName("x-ms-meta-Category"));
console.log("x-ms-meta-Resolution: " + rest.ResponseHdrByName("x-ms-meta-Resolution"));

console.log("Success.");