(Excel) Azure File Service: List Shares

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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' 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.file.core.windows.net",port,bTls,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' Provide Azure Cloud credentials for the REST call.
Dim azAuth As Chilkat.AuthAzureStorage
Set azAuth = Chilkat.NewAuthAzureStorage
azAuth.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.Account = "chilkat"
azAuth.Scheme = "SharedKey"
azAuth.Service = "File"
' This causes the "x-ms-version: 2020-08-04" header to be automatically added.
azAuth.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.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

If (rest.ResponseStatusCode <> 200) Then
    ' Examine the request/response to see what happened.
    Debug.Print "response status code = "; rest.ResponseStatusCode
    Debug.Print "response status text = "; rest.ResponseStatusText
    Debug.Print "response header: "; rest.ResponseHeader
    Debug.Print "response body (if any): "; responseStr
    Debug.Print "---"
    Debug.Print "LastRequestStartLine: "; rest.LastRequestStartLine
    Debug.Print "LastRequestHeader: "; rest.LastRequestHeader
    Exit Sub
End If

' Load the XML response for parsing.
' An example of the response XML is shown below.
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
success = xml.LoadXml(responseStr)

Debug.Print xml.GetXml()

' 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
Dim lastMod As Chilkat.CkDateTime
Set lastMod = Chilkat.NewCkDateTime


numShares = xml.NumChildrenAt("Shares")

i = 0
Do While i < numShares
    Debug.Print "---- Share "; i; " ----"
    xml.I = i
    Debug.Print "Name: "; xml.GetChildContent("Shares|Share[i]|Name")
    Dim success As Boolean
    success = lastMod.SetFromRfc822(xml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"))

    Set dt = lastMod.GetDtObj(True)
    Debug.Print "Last-Modified YMD: "; dt.Year; ","; dt.Month; ","; dt.Day

    i = i + 1
Loop

' 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.Print "Success."