Ruby

Azure Blob Service - List all Containers in a Storage Account

See more Azure Cloud Storage Examples

Azure Storage Blob Service REST API: Lists all the containers in a storage account. Ruby

require 'chilkat'

success = false

# Azure Blob Service Example: List all of the containers in an account.

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

# Connect to the Azure Storage Blob Service
bTls = true
port = 443
bAutoReconnect = true
# In this example, the storage account name is "chilkat".
success = rest.Connect("chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide Azure Cloud credentials for the REST call.
azAuth = Chilkat::CkAuthAzureStorage.new()
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("Blob")
# This causes the "x-ms-version: 2021-08-06" header to be automatically added.
azAuth.put_XMsVersion("2021-08-06")
success = rest.SetAuthAzureStorage(azAuth)

# URI parameters, such as "maxresults", are added by calling AddQueryParam
success = rest.AddQueryParam("maxresults","1000")

# Note: The application does not need to explicitly set the following
# headers: x-ms-date, Authorization.  These headers
# are automatically set by Chilkat.

responseStr = rest.fullRequestNoBody("GET","/?comp=list")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# When successful, the Azure Storage service will respond with a 200 response code,
# with an XML body.  
if (rest.get_ResponseStatusCode() != 200)
    # Examine the request/response to see what happened.
    print "response status code = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "response status text = " + rest.responseStatusText() + "\n";
    print "response header: " + rest.responseHeader() + "\n";
    print "response body (if any): " + responseStr + "\n";
    print "---" + "\n";
    print "LastRequestStartLine: " + rest.lastRequestStartLine() + "\n";
    print "LastRequestHeader: " + rest.lastRequestHeader() + "\n";
    exit
end

# Load the XML response for parsing.
# A sample XML response containing 2 containers is shown below.
xml = Chilkat::CkXml.new()
success = xml.LoadXml(responseStr)

print xml.getXml() + "\n";

# Iterate over the containers, listing some information about each.
success = xml.FindChild2("Containers")
numContainers = xml.get_NumChildren()
i = 0
while (i < numContainers)
    success = xml.GetChild2(i)
    print "Container Name: " + xml.getChildContent("Name") + "\n";
    lastModDateStr = xml.chilkatPath("Properties|Last-Modified|*")
    print "Last Modified: " + lastModDateStr + "\n";
    # The date/time string can be loaded into a CkDateTime object for conversion to other date formats..
    dateTime = Chilkat::CkDateTime.new()
    success = dateTime.SetFromRfc822(lastModDateStr)

    leaseState = xml.chilkatPath("Properties|LeaseState|*")
    print "Lease State: " + leaseState + "\n";

    success = xml.GetParent2()
    i = i + 1
end
success = xml.GetParent2()

# Sample XML response:

# 	<?xml version="1.0" encoding="utf-8" ?>
# 	<EnumerationResults ServiceEndpoint="https://chilkat.blob.core.windows.net/">
# 	    <MaxResults>1000</MaxResults>
# 	    <Containers>
# 	        <Container>
# 	            <Name>test</Name>
# 	            <Properties>
# 	                <Last-Modified>Wed, 20 Apr 2016 01:02:25 GMT</Last-Modified>
# 	                <Etag>"0x8D368B77024C583"</Etag>
# 	                <LeaseStatus>unlocked</LeaseStatus>
# 	                <LeaseState>available</LeaseState>
# 	            </Properties>
# 	        </Container>
# 	        <Container>
# 	            <Name>test2</Name>
# 	            <Properties>
# 	                <Last-Modified>Tue, 03 May 2016 17:13:01 GMT</Last-Modified>
# 	                <Etag>"0x8D373762EB6AC85"</Etag>
# 	                <LeaseStatus>unlocked</LeaseStatus>
# 	                <LeaseState>available</LeaseState>
# 	            </Properties>
# 	        </Container>
# 	    </Containers>
# 	    <NextMarker />
# 	</EnumerationResults>