(PowerShell) Get Container Metadata

Azure Storage Blob Service REST API: Sample code to get the user-defined metadata of a container.

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# Azure Blob Service Example: Get Container User-Defined Metadata
# See also: https://msdn.microsoft.com/en-us/library/azure/ee691976.aspx

# 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.blob.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 = "Blob"
# 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.

# The expected success response is a 200 response status code with no response body.
# In this example, we are getting the metadata of the container named "mycontainer".
$responseStr = $rest.FullRequestNoBody("GET","/mycontainer?restype=container&comp=metadata")
if ($rest.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

# When successful, the Azure Storage service will respond with a 200 response status code,
# with no 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
}

# The user-defined metadata is located in the response header.
# The full response header can be obtained like this:
$("response header: " + $rest.ResponseHeader)
$("--")

# Metadata headers begin with "x-ms-meta-"
# Individual response header fields can be retrieved like this:
$("x-ms-meta-Category: " + $rest.ResponseHdrByName("x-ms-meta-Category"))
$("x-ms-meta-Resolution: " + $rest.ResponseHdrByName("x-ms-meta-Resolution"))

$("Success.")