(JavaScript) Azure Storage: Lease Container

Azure Storage Blob Service REST API: Sample code to establishes a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// Azure Blob Service Example: Lease Container
// See also: https://msdn.microsoft.com/en-us/library/azure/jj159103.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 lease ID needs to be a GUID.  (UUID and GUID are synonymous)
var crypt = new CkCrypt2();
var guid = crypt.GenerateUuid();
console.log("Lease ID: " + guid);
success = rest.AddHeader("x-ms-lease-id",guid);

// The action can be "acquire", "renew", "change", "release", or "break".
// See https://msdn.microsoft.com/en-us/library/azure/jj159103.aspx
success = rest.AddHeader("x-ms-lease-action","acquire");

// The lease duration..
success = rest.AddHeader("x-ms-lease-duration","15");

// In this example, we are acquiring a lease for the container named "mycontainer".
var responseStr = rest.FullRequestNoBody("PUT","/mycontainer?restype=container&comp=lease");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// When successful, the Azure Storage service will respond with a 200, 201, or 202 response status code,
// with no response body.

// The status code depends on the operation:
//    Acquire: A successful operation returns status code 201 (Created).
//    Renew: A successful operation returns status code 200 (OK).
//    Change: A successful operation returns status code 200 (OK).
//    Release: A successful operation returns status code 200 (OK).
//    Break: A successful operation returns status code 202 (Accepted).

if ((rest.ResponseStatusCode < 200) || (rest.ResponseStatusCode > 202)) {
    // 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("Success: Lease acquired.");