Lianja

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

llSuccess = .F.

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

loRest = createobject("CkRest")

// Connect to the Azure Storage Blob Service
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
// In this example, the storage account name is "chilkat".
llSuccess = loRest.Connect("chilkat.file.core.windows.net",lnPort,llBTls,llBAutoReconnect)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

// Provide Azure Cloud credentials for the REST call.
loAzAuth = createobject("CkAuthAzureStorage")
loAzAuth.AccessKey = "AZURE_ACCESS_KEY"
// The account name used here should match the 1st part of the domain passed in the call to Connect (above).
loAzAuth.Account = "chilkat"
loAzAuth.Scheme = "SharedKey"
loAzAuth.Service = "File"
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
loAzAuth.XMsVersion = "2021-08-06"
llSuccess = loRest.SetAuthAzureStorage(loAzAuth)

// 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.
lcResponseStr = loRest.FullRequestNoBody("GET","/?comp=list")
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    release loAzAuth
    return
endif

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

if (loRest.ResponseStatusCode <> 200) then
    // Examine the request/response to see what happened.
    ? "response status code = " + str(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseStr
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    release loRest
    release loAzAuth
    return
endif

// Load the XML response for parsing.
// An example of the response XML is shown below.
loXml = createobject("CkXml")
llSuccess = loXml.LoadXml(lcResponseStr)

? loXml.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
loLastMod = createobject("CkDateTime")

lnNumShares = loXml.NumChildrenAt("Shares")
i = 0
loDt = createobject("CkDtObj")
do while i < lnNumShares
    ? "---- Share " + str(i) + " ----"
    loXml.I = i
    ? "Name: " + loXml.GetChildContent("Shares|Share[i]|Name")
    loLastMod.SetFromRfc822(loXml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"))
    loLastMod.ToDtObj(.T.,loDt)

    ? "Last-Modified YMD: " + str(loDt.Year) + "," + str(loDt.Month) + "," + str(loDt.Day)
    i = i + 1
enddo

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

? "Success."


release loRest
release loAzAuth
release loXml
release loLastMod
release loDt