Ruby

Get Container Metadata

See more Azure Cloud Storage Examples

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

require 'chilkat'

success = false

# 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 = 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)

# 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.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

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

# The user-defined metadata is located in the response header.
# The full response header can be obtained like this:
print "response header: " + rest.responseHeader() + "\n";
print "--" + "\n";

# Metadata headers begin with "x-ms-meta-"
# Individual response header fields can be retrieved like this:
print "x-ms-meta-Category: " + rest.responseHdrByName("x-ms-meta-Category") + "\n";
print "x-ms-meta-Resolution: " + rest.responseHdrByName("x-ms-meta-Resolution") + "\n";

print "Success." + "\n";