Visual FoxPro

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL loAzAuth
LOCAL lcResponseStr
LOCAL loXml
LOCAL loLastMod
LOCAL lnNumShares
LOCAL i
LOCAL loDt

lnSuccess = 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.

loRest = CreateObject('Chilkat.Rest')

* Connect to the Azure Storage Blob Service
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
* In this example, the storage account name is "chilkat".
lnSuccess = loRest.Connect("chilkat.file.core.windows.net",lnPort,lnBTls,lnBAutoReconnect)
IF (lnSuccess = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

* Provide Azure Cloud credentials for the REST call.
loAzAuth = CreateObject('Chilkat.AuthAzureStorage')
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"
lnSuccess = 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 = 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loAzAuth
    CANCEL
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
    CANCEL
ENDIF

* Load the XML response for parsing.
* An example of the response XML is shown below.
loXml = CreateObject('Chilkat.Xml')
lnSuccess = 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('Chilkat.CkDateTime')

lnNumShares = loXml.NumChildrenAt("Shares")
i = 0
loDt = CreateObject('Chilkat.DtObj')
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(1,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