(Perl) Azure File Service: List Shares

Sample code to list the file shares in an Azure storage account.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# Azure File Service Example: List all the file shares in a storage account.
# See also: https://docs.microsoft.com/en-us/rest/api/storageservices/list-shares

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

$rest = chilkat::CkRest->new();

# Connect to the Azure Storage Blob Service
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
# In this example, the storage account name is "chilkat".
$success = $rest->Connect("chilkat.file.core.windows.net",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# Provide Azure Cloud credentials for the REST call.
$azAuth = chilkat::CkAuthAzureStorage->new();
$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("File");
# 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.

# Send the GET request to list the shares.
$responseStr = $rest->fullRequestNoBody("GET","/?comp=list");
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\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() . "\r\n";
    print "response status text = " . $rest->responseStatusText() . "\r\n";
    print "response header: " . $rest->responseHeader() . "\r\n";
    print "response body (if any): " . $responseStr . "\r\n";
    print "---" . "\r\n";
    print "LastRequestStartLine: " . $rest->lastRequestStartLine() . "\r\n";
    print "LastRequestHeader: " . $rest->lastRequestHeader() . "\r\n";
    exit;
}

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

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

# Here's a sample response:

# <?xml version="1.0" encoding="utf-8" ?>
# <EnumerationResults ServiceEndpoint="https://chilkat.file.core.windows.net/">
#     <Shares>
#         <Share>
#             <Name>beardie</Name>
#             <Properties>
#                 <Last-Modified>Mon, 26 Jun 2017 21:24:57 GMT</Last-Modified>
#                 <Etag>"0x8D4BCD9CBD872E5"</Etag>
#                 <Quota>5120</Quota>
#             </Properties>
#         </Share>
#         <Share>
#             <Name>pip</Name>
#             <Properties>
#                 <Last-Modified>Mon, 26 Jun 2017 21:24:44 GMT</Last-Modified>
#                 <Etag>"0x8D4BCD9C3D823D1"</Etag>
#                 <Quota>5120</Quota>
#             </Properties>
#         </Share>
#     </Shares>
#     <NextMarker />
# </EnumerationResults>

# Let's iterate over the file shares
$lastMod = chilkat::CkDateTime->new();

$numShares = $xml->NumChildrenAt("Shares");
$i = 0;
while ($i < $numShares) {
    print "---- Share " . $i . " ----" . "\r\n";
    $xml->put_I($i);
    print "Name: " . $xml->getChildContent("Shares|Share[i]|Name") . "\r\n";
    $lastMod->SetFromRfc822($xml->getChildContent("Shares|Share[i]|Properties|Last-Modified"));
    # dt is a DtObj
    $dt = $lastMod->GetDtObj(1);
    print "Last-Modified YMD: " . $dt->get_Year() . "," . $dt->get_Month() . "," . $dt->get_Day() . "\r\n";

    $i = $i + 1;
}

# Output for the above loop:

# ---- Share 0 ----
# Name: beardie
# Last-Modified YMD: 2017,6,26
# ---- Share 1 ----
# Name: pip
# Last-Modified YMD: 2017,6,26
# 

print "Success." . "\r\n";