(PowerShell) Azure File Service: List Shares

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

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.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.

$rest = New-Object Chilkat.Rest

# 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 -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Provide Azure Cloud credentials for the REST call.
$azAuth = New-Object Chilkat.AuthAzureStorage
$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: 2020-08-04" header to be automatically added.
$azAuth.XMsVersion = "2020-08-04"
$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.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

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

if ($rest.ResponseStatusCode -ne 200) {
    # Examine the request/response to see what happened.
    $("response status code = " + $rest.ResponseStatusCode)
    $("response status text = " + $rest.ResponseStatusText)
    $("response header: " + $rest.ResponseHeader)
    $("response body (if any): " + $responseStr)
    $("---")
    $("LastRequestStartLine: " + $rest.LastRequestStartLine)
    $("LastRequestHeader: " + $rest.LastRequestHeader)
    exit
}

# Load the XML response for parsing.
# An example of the response XML is shown below.
$xml = New-Object Chilkat.Xml
$success = $xml.LoadXml($responseStr)

$($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
$lastMod = New-Object Chilkat.CkDateTime

$numShares = $xml.NumChildrenAt("Shares")
$i = 0
while ($i -lt $numShares) {
    $("---- Share " + $i + " ----")
    $xml.I = $i
    $("Name: " + $xml.GetChildContent("Shares|Share[i]|Name"))
    $lastMod.SetFromRfc822($xml.GetChildContent("Shares|Share[i]|Properties|Last-Modified"))
    $dt = $lastMod.GetDtObj($true)
    $("Last-Modified YMD: " + $dt.Year + "," + $dt.Month + "," + $dt.Day)

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

$("Success.")