Dart Requires Chilkat v11.0.0+

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.

  final rest = CkRest();

  // Connect to the Azure Storage Blob Service
  final bTls = true;
  final port = 443;
  final bAutoReconnect = true;
  // In this example, the storage account name is "chilkat".
  try {
    rest.connect('chilkat.file.core.windows.net', port, bTls, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Provide Azure Cloud credentials for the REST call.
  final azAuth = CkAuthAzureStorage();
  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';
  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.
  final String responseStr;
  try {
    responseStr = rest.fullRequestNoBody('GET', '/?comp=list');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  if (rest.responseStatusCode != 200) {
    // Examine the request/response to see what happened.
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response body (if any): $responseStr');
    print('---');
    print('LastRequestStartLine: ${rest.lastRequestStartLine}');
    print('LastRequestHeader: ${rest.lastRequestHeader}');
    return;
  }

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

  print(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
  final lastMod = CkDateTime();

  final numShares = xml.numChildrenAt('Shares');
  var i = 0;
  final dt = CkDtObj();
  while (i < numShares) {
    print('---- Share $i ----');
    xml.i = i;
    print('Name: ${xml.getChildContent('Shares|Share[i]|Name')}');
    lastMod.setFromRfc822(xml.getChildContent('Shares|Share[i]|Properties|Last-Modified'));
    lastMod.toDtObj(true, dt);

    print('Last-Modified YMD: ${dt.year},${dt.month},${dt.day}');
    i++;
  }

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

  print('Success.');
}