(PureBasic) Azure Storage: List Blobs

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkXml.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkDtObj.pb"

Procedure ChilkatExample()

    ; 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.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Azure Storage Blob Service
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; In this example, the storage account name is "chilkat".
    success.i = CkRest::ckConnect(rest,"chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide Azure Cloud credentials for the REST call.
    azAuth.i = CkAuthAzureStorage::ckCreate()
    If azAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureStorage::setCkAccessKey(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::setCkAccount(azAuth, "chilkat")
    CkAuthAzureStorage::setCkScheme(azAuth, "SharedKey")
    CkAuthAzureStorage::setCkService(azAuth, "Blob")
    ; This causes the "x-ms-version: 2020-08-04" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2020-08-04")
    success = CkRest::ckSetAuthAzureStorage(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".
    responseStr.s = CkRest::ckFullRequestNoBody(rest,"GET","/mycontainer?restype=container&comp=list")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        ProcedureReturn
    EndIf

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

    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        ProcedureReturn
    EndIf

    ; Load the XML response for parsing.
    ; An example of the response XML is shown below.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkXml::ckLoadXml(xml,responseStr)

    Debug CkXml::ckGetXml(xml)

    ; Let's iterate over the blobs...

    lastMod.i = CkDateTime::ckCreate()
    If lastMod.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    numBlobs.i = CkXml::ckNumChildrenAt(xml,"Blobs")
    i.i = 0
    While i < numBlobs
        Debug "---- Blob " + Str(i) + " ----"
        CkXml::setCkI(xml, i)
        Debug "Name: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Name")
        Debug "Content-Length: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|Content-Length")
        Debug "Content-Type: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|Content-Type")
        Debug "Content-MD5: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|Content-MD5")
        Debug "BlobType: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|BlobType")
        Debug "LeaseStatus: " + CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|LeaseStatus")
        CkDateTime::ckSetFromRfc822(lastMod,CkXml::ckGetChildContent(xml,"Blobs|Blob[i]|Properties|Last-Modified"))
        dt.i = CkDateTime::ckGetDtObj(lastMod,1)
        Debug "Last-Modified YMD: " + Str(CkDtObj::ckYear(dt)) + "," + Str(CkDtObj::ckMonth(dt)) + "," + Str(CkDtObj::ckDay(dt))
        CkDtObj::ckDispose(dt)

        i = i + 1
    Wend

    Debug "-------------------------"

    ; 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.s = CkXml::ckChilkatPath(xml,"/C/Name,helloWorld.txt|..|Properties|Last-Modified|*")
    Debug "helloWorld.txt Last-Modified: " + lastModStr

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


    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkXml::ckDispose(xml)
    CkDateTime::ckDispose(lastMod)


    ProcedureReturn
EndProcedure