(Tcl) Azure Storage: List Blobs

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

# Connect to the Azure Storage Blob Service
set bTls 1
set port 443
set bAutoReconnect 1
# In this example, the storage account name is "chilkat".
set success [CkRest_Connect $rest "chilkat.blob.core.windows.net" $port $bTls $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

# Provide Azure Cloud credentials for the REST call.
set azAuth [new_CkAuthAzureStorage]

CkAuthAzureStorage_put_AccessKey $azAuth "AZURE_ACCESS_KEY"
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
CkAuthAzureStorage_put_Account $azAuth "chilkat"
CkAuthAzureStorage_put_Scheme $azAuth "SharedKey"
CkAuthAzureStorage_put_Service $azAuth "Blob"
# This causes the "x-ms-version: 2020-08-04" header to be automatically added.
CkAuthAzureStorage_put_XMsVersion $azAuth "2020-08-04"
set success [CkRest_SetAuthAzureStorage $rest $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".
set responseStr [CkRest_fullRequestNoBody $rest "GET" "/mycontainer?restype=container&comp=list"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAzureStorage $azAuth
    exit
}

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

if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    # Examine the request/response to see what happened.
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body (if any): $responseStr"
    puts "---"
    puts "LastRequestStartLine: [CkRest_lastRequestStartLine $rest]"
    puts "LastRequestHeader: [CkRest_lastRequestHeader $rest]"
    delete_CkRest $rest
    delete_CkAuthAzureStorage $azAuth
    exit
}

# Load the XML response for parsing.
# An example of the response XML is shown below.
set xml [new_CkXml]

set success [CkXml_LoadXml $xml $responseStr]

puts [CkXml_getXml $xml]

# Let's iterate over the blobs...

set lastMod [new_CkDateTime]

set numBlobs [CkXml_NumChildrenAt $xml "Blobs"]
set i 0
while {$i < $numBlobs} {
    puts "---- Blob $i ----"
    CkXml_put_I $xml $i
    puts "Name: [CkXml_getChildContent $xml {Blobs|Blob[i]|Name}]"
    puts "Content-Length: [CkXml_getChildContent $xml {Blobs|Blob[i]|Properties|Content-Length}]"
    puts "Content-Type: [CkXml_getChildContent $xml {Blobs|Blob[i]|Properties|Content-Type}]"
    puts "Content-MD5: [CkXml_getChildContent $xml {Blobs|Blob[i]|Properties|Content-MD5}]"
    puts "BlobType: [CkXml_getChildContent $xml {Blobs|Blob[i]|Properties|BlobType}]"
    puts "LeaseStatus: [CkXml_getChildContent $xml {Blobs|Blob[i]|Properties|LeaseStatus}]"
    CkDateTime_SetFromRfc822 $lastMod [CkXml_getChildContent $xml "Blobs|Blob[i]|Properties|Last-Modified"]
    # dt is a CkDtObj
    set dt [CkDateTime_GetDtObj $lastMod 1]
    puts "Last-Modified YMD: [CkDtObj_get_Year $dt],[CkDtObj_get_Month $dt],[CkDtObj_get_Day $dt]"
    delete_CkDtObj $dt

    set i [expr $i + 1]
}

puts "-------------------------"

# 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"
set lastModStr [CkXml_chilkatPath $xml "/C/Name,helloWorld.txt|..|Properties|Last-Modified|*"]
puts "helloWorld.txt Last-Modified: $lastModStr"

puts "Success."

# <?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>
# 

delete_CkRest $rest
delete_CkAuthAzureStorage $azAuth
delete_CkXml $xml
delete_CkDateTime $lastMod