(PHP Extension) Azure Storage: Download Blob to File

See more Azure Cloud Storage Examples

Sample code to download an Azure blob to a file.

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

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");

// 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: 2021-08-06" header to be automatically added.
$azAuth->put_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.

// Setup a file stream for the download
$fileStream = new CkStream();
$fileStream->put_SinkFile('qa_output/starfish.jpg');

// Indicate that the call to FullRequestNoBody should send the response body
// to fileStream if the response status code is 200.
// If a non-success response status code is received, then nothing
// is streamed to the output file and the error response is returned by FullRequestNoBody.
$expectedStatus = 200;
$rest->SetResponseBodyStream($expectedStatus,true,$fileStream);

// The Azure blob container is "test", the file is "starfish.jpg"
$responseStr = $rest->fullRequestNoBody('GET','/test/starfish.jpg');
if ($rest->get_LastMethodSuccess() != true) {
    // 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.' . "\n";

?>