(PureBasic) Get Container Metadata

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"

Procedure ChilkatExample()

    ; 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.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Azure Storage Blob Service
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; In this example, the storage account name is "chilkat".
    success.i = CkRest::ckConnect(rest,"chilkat.blob.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Provide Azure Cloud credentials for the REST call.
    azAuth.i = CkAuthAzureStorage::ckCreate()
    If azAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAzureStorage::setCkAccessKey(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::setCkAccount(azAuth, "chilkat")
    CkAuthAzureStorage::setCkScheme(azAuth, "SharedKey")
    CkAuthAzureStorage::setCkService(azAuth, "Blob")
    ; This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    CkAuthAzureStorage::setCkXMsVersion(azAuth, "2021-08-06")
    success = CkRest::ckSetAuthAzureStorage(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.

    ; 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.s = CkRest::ckFullRequestNoBody(rest,"GET","/mycontainer?restype=container&comp=metadata")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        ProcedureReturn
    EndIf

    ; When successful, the Azure Storage service will respond with a 200 response status code,
    ; with no response body.

    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        ProcedureReturn
    EndIf

    ; The user-defined metadata is located in the response header.
    ; The full response header can be obtained like this:
    Debug "response header: " + CkRest::ckResponseHeader(rest)
    Debug "--"

    ; Metadata headers begin with "x-ms-meta-"
    ; Individual response header fields can be retrieved like this:
    Debug "x-ms-meta-Category: " + CkRest::ckResponseHdrByName(rest,"x-ms-meta-Category")
    Debug "x-ms-meta-Resolution: " + CkRest::ckResponseHdrByName(rest,"x-ms-meta-Resolution")

    Debug "Success."


    CkRest::ckDispose(rest)
    CkAuthAzureStorage::ckDispose(azAuth)


    ProcedureReturn
EndProcedure