Ruby

Azure File Service: List Shares

See more Azure Cloud Storage Examples

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

require 'chilkat'

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.

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.file.core.windows.net",port,bTls,bAutoReconnect)
if (success == false)
    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("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.
responseStr = rest.fullRequestNoBody("GET","/?comp=list")
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

# 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.
    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.
# An example of the response XML is shown below.
xml = Chilkat::CkXml.new()
success = xml.LoadXml(responseStr)

print xml.getXml() + "\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
lastMod = Chilkat::CkDateTime.new()

numShares = xml.NumChildrenAt("Shares")
i = 0
dt = Chilkat::CkDtObj.new()
while i < numShares
    print "---- Share " + i.to_s() + " ----" + "\n";
    xml.put_I(i)
    print "Name: " + xml.getChildContent("Shares|Share[i]|Name") + "\n";
    lastMod.SetFromRfc822(xml.getChildContent("Shares|Share[i]|Properties|Last-Modified"))
    lastMod.ToDtObj(true,dt)

    print "Last-Modified YMD: " + dt.get_Year().to_s() + "," + dt.get_Month().to_s() + "," + dt.get_Day().to_s() + "\n";
    i = i + 1
end

# 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." + "\n";