(PHP Extension) Azure Storage: List Blobs

Azure Storage Blob Service REST API: Sample code to fetch the list of blobs in the specified container.

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: List the blobs in a specified container.
// See also: https://msdn.microsoft.com/en-us/library/azure/dd135734.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 expected success response is a 200 response status code with an XML response body.
// In this example, we are listing the blobs in the container named "mycontainer".
$responseStr = $rest->fullRequestNoBody('GET','/mycontainer?restype=container&comp=list');
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

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

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

// Load the XML response for parsing.
// An example of the response XML is shown below.
$xml = new CkXml();
$success = $xml->LoadXml($responseStr);

print $xml->getXml() . "\n";

// Let's iterate over the blobs...

$lastMod = new CkDateTime();

$numBlobs = $xml->NumChildrenAt('Blobs');
$i = 0;
while ($i < $numBlobs) {
    print '---- Blob ' . $i . ' ----' . "\n";
    $xml->put_I($i);
    print 'Name: ' . $xml->getChildContent('Blobs|Blob[i]|Name') . "\n";
    print 'Content-Length: ' . $xml->getChildContent('Blobs|Blob[i]|Properties|Content-Length') . "\n";
    print 'Content-Type: ' . $xml->getChildContent('Blobs|Blob[i]|Properties|Content-Type') . "\n";
    print 'Content-MD5: ' . $xml->getChildContent('Blobs|Blob[i]|Properties|Content-MD5') . "\n";
    print 'BlobType: ' . $xml->getChildContent('Blobs|Blob[i]|Properties|BlobType') . "\n";
    print 'LeaseStatus: ' . $xml->getChildContent('Blobs|Blob[i]|Properties|LeaseStatus') . "\n";
    $lastMod->SetFromRfc822($xml->getChildContent('Blobs|Blob[i]|Properties|Last-Modified'));
    // dt is a CkDtObj
    $dt = $lastMod->GetDtObj(true);
    print 'Last-Modified YMD: ' . $dt->get_Year() . ',' . $dt->get_Month() . ',' . $dt->get_Day() . "\n";

    $i = $i + 1;
}

print '-------------------------' . "\n";

// Use the ChilkatPath method to get information for a specific blob:

// For example, let's say we want the Last-Modified date/time for
// the blob named "helloWorld.txt"
$lastModStr = $xml->chilkatPath('/C/Name,helloWorld.txt|..|Properties|Last-Modified|*');
print 'helloWorld.txt Last-Modified: ' . $lastModStr . "\n";

print 'Success.' . "\n";

// <?xml version="1.0" encoding="utf-8" ?>
// <EnumerationResults ServiceEndpoint="https://chilkat.blob.core.windows.net/" ContainerName="test">
//     <Blobs>
//         <Blob>
//             <Name>hamletC.xml</Name>
//             <Properties>
//                 <Last-Modified>Mon, 02 May 2016 23:50:30 GMT</Last-Modified>
//                 <Etag>0x8D372E48B6D323A</Etag>
//                 <Content-Length>279658</Content-Length>
//                 <Content-Type>application/octet-stream</Content-Type>
//                 <Content-Encoding />
//                 <Content-Language />
//                 <Content-MD5>4E6prI9haw81xadSLeEj3Q==</Content-MD5>
//                 <Cache-Control />
//                 <Content-Disposition>attachment; filename="hamletC.xml"</Content-Disposition>
//                 <BlobType>BlockBlob</BlobType>
//                 <LeaseStatus>unlocked</LeaseStatus>
//                 <LeaseState>available</LeaseState>
//             </Properties>
//         </Blob>
//         <Blob>
//             <Name>helloWorld.txt</Name>
//             <Properties>
//                 <Last-Modified>Mon, 02 May 2016 15:21:55 GMT</Last-Modified>
//                 <Etag>0x8D3729D7EE38299</Etag>
//                 <Content-Length>12</Content-Length>
//                 <Content-Type>application/octet-stream</Content-Type>
//                 <Content-Encoding />
//                 <Content-Language />
//                 <Content-MD5>7Qdih1MuhjZehB6Sv8UNjA==</Content-MD5>
//                 <Cache-Control />
//                 <Content-Disposition>attachment; filename="helloWorld.txt"</Content-Disposition>
//                 <BlobType>BlockBlob</BlobType>
//                 <LeaseStatus>unlocked</LeaseStatus>
//                 <LeaseState>available</LeaseState>
//             </Properties>
//         </Blob>
//         <Blob>
//             <Name>thisIsATest.txt</Name>
//             <Properties>
//                 <Last-Modified>Tue, 03 May 2016 00:22:13 GMT</Last-Modified>
//                 <Etag>0x8D372E8F9B2A62E</Etag>
//                 <Content-Length>1600</Content-Length>
//                 <Content-Type>application/octet-stream</Content-Type>
//                 <Content-Encoding />
//                 <Content-Language />
//                 <Content-MD5>FhgUXYfePg2ItsraPmz0Xg==</Content-MD5>
//                 <Cache-Control />
//                 <Content-Disposition>attachment; filename="thisIsATest.txt"</Content-Disposition>
//                 <BlobType>BlockBlob</BlobType>
//                 <LeaseStatus>unlocked</LeaseStatus>
//                 <LeaseState>available</LeaseState>
//             </Properties>
//         </Blob>
//     </Blobs>
//     <NextMarker />
// </EnumerationResults>
// 

?>