PureBasic

Azure Storage: Lease Container

See more Azure Cloud Storage Examples

Azure Storage Blob Service REST API: Sample code to establishes a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite. PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ; Azure Blob Service Example: Lease Container
    ; See also: https://msdn.microsoft.com/en-us/library/azure/jj159103.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 = 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 lease ID needs to be a GUID.  (UUID and GUID are synonymous)
    crypt.i = CkCrypt2::ckCreate()
    If crypt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    guid.s = CkCrypt2::ckGenerateUuid(crypt)
    Debug "Lease ID: " + guid
    success = CkRest::ckAddHeader(rest,"x-ms-lease-id",guid)

    ; The action can be "acquire", "renew", "change", "release", or "break".
    ; See https://msdn.microsoft.com/en-us/library/azure/jj159103.aspx
    success = CkRest::ckAddHeader(rest,"x-ms-lease-action","acquire")

    ; The lease duration..
    success = CkRest::ckAddHeader(rest,"x-ms-lease-duration","15")

    ; In this example, we are acquiring a lease for the container named "mycontainer".
    responseStr.s = CkRest::ckFullRequestNoBody(rest,"PUT","/mycontainer?restype=container&comp=lease")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkCrypt2::ckDispose(crypt)
        ProcedureReturn
    EndIf

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

    ; The status code depends on the operation:
    ;    Acquire: A successful operation returns status code 201 (Created).
    ;    Renew: A successful operation returns status code 200 (OK).
    ;    Change: A successful operation returns status code 200 (OK).
    ;    Release: A successful operation returns status code 200 (OK).
    ;    Break: A successful operation returns status code 202 (Accepted).

    If (CkRest::ckResponseStatusCode(rest) < 200) OR (CkRest::ckResponseStatusCode(rest) > 202)
        ; 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)
        CkCrypt2::ckDispose(crypt)
        ProcedureReturn
    EndIf

    Debug "Success: Lease acquired."


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


    ProcedureReturn
EndProcedure