(PHP Extension) 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.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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.

$rest = new CkRest();

// Connect to the Azure Storage Blob Service
$bTls = true;
$port = 443;
$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) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// Provide Azure Cloud credentials for the REST call.
$azAuth = new CkAuthAzureStorage();
$azAuth->put_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->put_Account('chilkat');
$azAuth->put_Scheme('SharedKey');
$azAuth->put_Service('Blob');
// This causes the "x-ms-version: 2020-08-04" header to be automatically added.
$azAuth->put_XMsVersion('2020-08-04');
$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)
$crypt = new CkCrypt2();
$guid = $crypt->generateUuid();
print 'Lease ID: ' . $guid . "\n";
$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".
$responseStr = $rest->fullRequestNoBody('PUT','/mycontainer?restype=container&comp=lease');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// 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->get_ResponseStatusCode() < 200) or ($rest->get_ResponseStatusCode() > 202)) {
    // Examine the request/response to see what happened.
    print 'response status code = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'response status text = ' . $rest->responseStatusText() . "\n";
    print 'response header: ' . $rest->responseHeader() . "\n";
    print 'response body (if any): ' . $responseStr . "\n";
    print '---' . "\n";
    print 'LastRequestStartLine: ' . $rest->lastRequestStartLine() . "\n";
    print 'LastRequestHeader: ' . $rest->lastRequestHeader() . "\n";
    exit;
}

print 'Success: Lease acquired.' . "\n";

?>