(Tcl) Azure File Service: List Shares

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

# Connect to the Azure Storage Blob Service
set bTls 1
set port 443
set bAutoReconnect 1
# In this example, the storage account name is "chilkat".
set success [CkRest_Connect $rest "chilkat.file.core.windows.net" $port $bTls $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

# Provide Azure Cloud credentials for the REST call.
set azAuth [new_CkAuthAzureStorage]

CkAuthAzureStorage_put_AccessKey $azAuth "AZURE_ACCESS_KEY"
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
CkAuthAzureStorage_put_Account $azAuth "chilkat"
CkAuthAzureStorage_put_Scheme $azAuth "SharedKey"
CkAuthAzureStorage_put_Service $azAuth "File"
# This causes the "x-ms-version: 2020-08-04" header to be automatically added.
CkAuthAzureStorage_put_XMsVersion $azAuth "2020-08-04"
set success [CkRest_SetAuthAzureStorage $rest $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.
set responseStr [CkRest_fullRequestNoBody $rest "GET" "/?comp=list"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAzureStorage $azAuth
    exit
}

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

if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    # Examine the request/response to see what happened.
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body (if any): $responseStr"
    puts "---"
    puts "LastRequestStartLine: [CkRest_lastRequestStartLine $rest]"
    puts "LastRequestHeader: [CkRest_lastRequestHeader $rest]"
    delete_CkRest $rest
    delete_CkAuthAzureStorage $azAuth
    exit
}

# Load the XML response for parsing.
# An example of the response XML is shown below.
set xml [new_CkXml]

set success [CkXml_LoadXml $xml $responseStr]

puts [CkXml_getXml $xml]

# 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
set lastMod [new_CkDateTime]

set numShares [CkXml_NumChildrenAt $xml "Shares"]
set i 0
while {$i < $numShares} {
    puts "---- Share $i ----"
    CkXml_put_I $xml $i
    puts "Name: [CkXml_getChildContent $xml {Shares|Share[i]|Name}]"
    CkDateTime_SetFromRfc822 $lastMod [CkXml_getChildContent $xml "Shares|Share[i]|Properties|Last-Modified"]
    # dt is a CkDtObj
    set dt [CkDateTime_GetDtObj $lastMod 1]
    puts "Last-Modified YMD: [CkDtObj_get_Year $dt],[CkDtObj_get_Month $dt],[CkDtObj_get_Day $dt]"
    delete_CkDtObj $dt

    set i [expr $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
# 

puts "Success."

delete_CkRest $rest
delete_CkAuthAzureStorage $azAuth
delete_CkXml $xml
delete_CkDateTime $lastMod