Objective-C

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

#import <CkoRest.h>
#import <CkoAuthAzureStorage.h>
#import <NSString.h>
#import <CkoXml.h>
#import <CkoDateTime.h>
#import <CkoDtObj.h>

BOOL success = NO;

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

CkoRest *rest = [[CkoRest alloc] init];

// Connect to the Azure Storage Blob Service
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
// In this example, the storage account name is "chilkat".
success = [rest Connect: @"chilkat.file.core.windows.net" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

// Provide Azure Cloud credentials for the REST call.
CkoAuthAzureStorage *azAuth = [[CkoAuthAzureStorage alloc] init];
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";
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.
NSString *responseStr = [rest FullRequestNoBody: @"GET" uriPath: @"/?comp=list"];
if (rest.LastMethodSuccess == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

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

if ([rest.ResponseStatusCode intValue] != 200) {
    // Examine the request/response to see what happened.
    NSLog(@"%@%d",@"response status code = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"response status text = ",rest.ResponseStatusText);
    NSLog(@"%@%@",@"response header: ",rest.ResponseHeader);
    NSLog(@"%@%@",@"response body (if any): ",responseStr);
    NSLog(@"%@",@"---");
    NSLog(@"%@%@",@"LastRequestStartLine: ",rest.LastRequestStartLine);
    NSLog(@"%@%@",@"LastRequestHeader: ",rest.LastRequestHeader);
    return;
}

// Load the XML response for parsing.
// An example of the response XML is shown below.
CkoXml *xml = [[CkoXml alloc] init];
success = [xml LoadXml: responseStr];

NSLog(@"%@",[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
CkoDateTime *lastMod = [[CkoDateTime alloc] init];

int numShares = [[xml NumChildrenAt: @"Shares"] intValue];
int i = 0;
CkoDtObj *dt = [[CkoDtObj alloc] init];
while (i < numShares) {
    NSLog(@"%@%d%@",@"---- Share ",i,@" ----");
    xml.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"Name: ",[xml GetChildContent: @"Shares|Share[i]|Name"]);
    [lastMod SetFromRfc822: [xml GetChildContent: @"Shares|Share[i]|Properties|Last-Modified"]];
    [lastMod ToDtObj: YES dtObj: dt];

    NSLog(@"%@%d%@%d%@%d",@"Last-Modified YMD: ",[dt.Year intValue],@",",[dt.Month intValue],@",",[dt.Day intValue]);
    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
// 

NSLog(@"%@",@"Success.");