PowerBuilder

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_AzAuth
string ls_ResponseStr
oleobject loo_Xml
oleobject loo_LastMod
integer li_NumShares
integer i
oleobject loo_Dt

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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Connect to the Azure Storage Blob Service
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
// In this example, the storage account name is "chilkat".
li_Success = loo_Rest.Connect("chilkat.file.core.windows.net",li_Port,li_BTls,li_BAutoReconnect)
if li_Success = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

// Provide Azure Cloud credentials for the REST call.
loo_AzAuth = create oleobject
li_rc = loo_AzAuth.ConnectToNewObject("Chilkat.AuthAzureStorage")

loo_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).
loo_AzAuth.Account = "chilkat"
loo_AzAuth.Scheme = "SharedKey"
loo_AzAuth.Service = "File"
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
loo_AzAuth.XMsVersion = "2021-08-06"
li_Success = loo_Rest.SetAuthAzureStorage(loo_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.
ls_ResponseStr = loo_Rest.FullRequestNoBody("GET","/?comp=list")
if loo_Rest.LastMethodSuccess = 0 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_AzAuth
    return
end if

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

if loo_Rest.ResponseStatusCode <> 200 then
    // Examine the request/response to see what happened.
    Write-Debug "response status code = " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "response status text = " + loo_Rest.ResponseStatusText
    Write-Debug "response header: " + loo_Rest.ResponseHeader
    Write-Debug "response body (if any): " + ls_ResponseStr
    Write-Debug "---"
    Write-Debug "LastRequestStartLine: " + loo_Rest.LastRequestStartLine
    Write-Debug "LastRequestHeader: " + loo_Rest.LastRequestHeader
    destroy loo_Rest
    destroy loo_AzAuth
    return
end if

// Load the XML response for parsing.
// An example of the response XML is shown below.
loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

li_Success = loo_Xml.LoadXml(ls_ResponseStr)

Write-Debug loo_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
loo_LastMod = create oleobject
li_rc = loo_LastMod.ConnectToNewObject("Chilkat.CkDateTime")

li_NumShares = loo_Xml.NumChildrenAt("Shares")
i = 0
loo_Dt = create oleobject
li_rc = loo_Dt.ConnectToNewObject("Chilkat.DtObj")

do while i < li_NumShares
    Write-Debug "---- Share " + string(i) + " ----"
    loo_Xml.I = i
    Write-Debug "Name: " + loo_Xml.GetChildContent("Shares|Share[i]|Name")
    loo_LastMod.SetFromRfc822(loo_Xml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"))
    loo_LastMod.ToDtObj(1,loo_Dt)

    Write-Debug "Last-Modified YMD: " + string(loo_Dt.Year) + "," + string(loo_Dt.Month) + "," + string(loo_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
// 

Write-Debug "Success."


destroy loo_Rest
destroy loo_AzAuth
destroy loo_Xml
destroy loo_LastMod
destroy loo_Dt