PureBasic

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

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

Procedure ChilkatExample()

    success.i = 0

    ; 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.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 = CkRest::ckConnect(rest,"chilkat.file.core.windows.net",port,bTls,bAutoReconnect)
    If success = 0
        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, "File")
    ; This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2021-08-06")
    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.

    ; Send the GET request to list the shares.
    responseStr.s = CkRest::ckFullRequestNoBody(rest,"GET","/?comp=list")
    If CkRest::ckLastMethodSuccess(rest) = 0
        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)

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

    numShares.i = CkXml::ckNumChildrenAt(xml,"Shares")
    i.i = 0
    dt.i = CkDtObj::ckCreate()
    If dt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    While i < numShares
        Debug "---- Share " + Str(i) + " ----"
        CkXml::setCkI(xml, i)
        Debug "Name: " + CkXml::ckGetChildContent(xml,"Shares|Share[i]|Name")
        CkDateTime::ckSetFromRfc822(lastMod,CkXml::ckGetChildContent(xml,"Shares|Share[i]|Properties|Last-Modified"))
        CkDateTime::ckToDtObj(lastMod,1,dt)

        Debug "Last-Modified YMD: " + Str(CkDtObj::ckYear(dt)) + "," + Str(CkDtObj::ckMonth(dt)) + "," + Str(CkDtObj::ckDay(dt))
        i = i + 1
    Wend

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

    Debug "Success."


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


    ProcedureReturn
EndProcedure