C++

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

#include <CkRest.h>
#include <CkAuthAzureStorage.h>
#include <CkXml.h>
#include <CkDateTime.h>
#include <CkDtObj.h>

void ChilkatSample(void)
    {
    bool 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.

    CkRest rest;

    // Connect to the Azure Storage Blob Service
    bool bTls = true;
    int port = 443;
    bool 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) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    // Provide Azure Cloud credentials for the REST call.
    CkAuthAzureStorage azAuth;
    azAuth.put_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.put_Account("chilkat");
    azAuth.put_Scheme("SharedKey");
    azAuth.put_Service("File");
    // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    azAuth.put_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.
    const char *responseStr = rest.fullRequestNoBody("GET","/?comp=list");
    if (rest.get_LastMethodSuccess() == false) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

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

    if (rest.get_ResponseStatusCode() != 200) {
        // Examine the request/response to see what happened.
        std::cout << "response status code = " << rest.get_ResponseStatusCode() << "\r\n";
        std::cout << "response status text = " << rest.responseStatusText() << "\r\n";
        std::cout << "response header: " << rest.responseHeader() << "\r\n";
        std::cout << "response body (if any): " << responseStr << "\r\n";
        std::cout << "---" << "\r\n";
        std::cout << "LastRequestStartLine: " << rest.lastRequestStartLine() << "\r\n";
        std::cout << "LastRequestHeader: " << rest.lastRequestHeader() << "\r\n";
        return;
    }

    // Load the XML response for parsing.
    // An example of the response XML is shown below.
    CkXml xml;
    success = xml.LoadXml(responseStr);

    std::cout << xml.getXml() << "\r\n";

    // 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
    CkDateTime lastMod;

    int numShares = xml.NumChildrenAt("Shares");
    int i = 0;
    CkDtObj dt;
    while (i < numShares) {
        std::cout << "---- Share " << i << " ----" << "\r\n";
        xml.put_I(i);
        std::cout << "Name: " << xml.getChildContent("Shares|Share[i]|Name") << "\r\n";
        lastMod.SetFromRfc822(xml.getChildContent("Shares|Share[i]|Properties|Last-Modified"));
        lastMod.ToDtObj(true,dt);

        std::cout << "Last-Modified YMD: " << dt.get_Year() << "," << dt.get_Month() << "," << dt.get_Day() << "\r\n";
        i = i + 1;
    }

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

    std::cout << "Success." << "\r\n";
    }