Xojo Plugin

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

Dim success As Boolean
success = False

// 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 New Chilkat.Rest

// Connect to the Azure Storage Blob Service
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
bAutoReconnect = True
// In this example, the storage account name is "chilkat".
success = rest.Connect("chilkat.file.core.windows.net",port,bTls,bAutoReconnect)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// Provide Azure Cloud credentials for the REST call.
Dim azAuth As New Chilkat.AuthAzureStorage
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: 2021-08-06" header to be automatically added.
azAuth.XMsVersion = "2021-08-06"
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.
Dim responseStr As String
responseStr = rest.FullRequestNoBody("GET","/?comp=list")
If (rest.LastMethodSuccess = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
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.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body (if any): " + responseStr)
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
    Return
End If

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

System.DebugLog(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 New Chilkat.CkDateTime

Dim numShares As Int32
numShares = xml.NumChildrenAt("Shares")
Dim i As Int32
i = 0
Dim dt As New Chilkat.DtObj
While i < numShares
    System.DebugLog("---- Share " + Str(i) + " ----")
    xml.I = i
    System.DebugLog("Name: " + xml.GetChildContent("Shares|Share[i]|Name"))
    success = lastMod.SetFromRfc822(xml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"))
    lastMod.ToDtObj True,dt

    System.DebugLog("Last-Modified YMD: " + Str(dt.Year) + "," + Str(dt.Month) + "," + Str(dt.Day))
    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
// 

System.DebugLog("Success.")