PureBasic

Azure File Service: Upload File

See more Azure Cloud Storage Examples

Sample code to upload a file to a directory in a share in the Azure File Service. A file is uploaded by first creating the file in the Azure share and then writes a range of bytes to the file. Azure imposes a 4MB limit for each PUT to write a range. Files larger than 4MB need to be uploaded by making multiple "Put Range" calls. This example uploads a file small enough for a single "Put Range" call. PureBasic

IncludeFile "CkBinData.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAzureStorage.pb"

Procedure ChilkatExample()

    success.i = 0

    ; Azure File Service Example: Upload a file.  
    ; See:  https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
    ; also see: https://docs.microsoft.com/en-us/rest/api/storageservices/put-range

    ; 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.file.core.windows.net",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; This example will upload a relatively small file (760K), so it may as well 
    ; just be load it into memory..
    jpgData.i = CkBinData::ckCreate()
    If jpgData.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkBinData::ckLoadFile(jpgData,"qa_data/jpg/penguins.jpg")

    ; Provide Azure Cloud credentials for the REST calls.
    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, "File")
    ; 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.

    ; However, a few additional headers are required for the "Create File" operation:
    CkRest::ckAddHeader(rest,"x-ms-type","file")

    ; This required header specifies the final size of the file (or the maximum size it can be).
    sbFileSize.i = CkStringBuilder::ckCreate()
    If sbFileSize.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppendInt(sbFileSize,CkBinData::ckNumBytes(jpgData))
    CkRest::ckAddHeader(rest,"x-ms-content-length",CkStringBuilder::ckGetAsString(sbFileSize))

    ; Send a PUT request to create the file (or replace the file if it already exists).
    ; This will initialize the file in the Azure file storage.  To upload content, we'll need
    ; to do the "Put Range" operation one or more times.

    ; The following will create the file "penguins.jpg" in the share "pip", in the directory "/wildlife/antarctic"
    responseStr.s = CkRest::ckFullRequestNoBody(rest,"PUT","/pip/wildlife/antarctic/penguins.jpg")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(jpgData)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileSize)
        ProcedureReturn
    EndIf

    ; When successful, the Azure File Service will respond with a 201 (Created) response status code,
    ; with no XML response body.  If an error response is returned, there will be an XML response body.

    If CkRest::ckResponseStatusCode(rest) <> 201
        ; 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)
        CkBinData::ckDispose(jpgData)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileSize)
        ProcedureReturn
    EndIf

    Debug "Successfully created penguins.jpg"

    ; --------------------------------------------------------------------------------
    ; Upload the file data...

    ; Make sure the headers from the "Create File" operation are removed.
    CkRest::ckClearAllHeaders(rest)

    ; The only tricky part here is to correctly add the x-ms-range header.
    ; It will be formatted like this:
    ; x-ms-range: bytes=0-759623

    sbRange.i = CkStringBuilder::ckCreate()
    If sbRange.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbRange,"bytes=0-")
    CkStringBuilder::ckAppendInt(sbRange,CkBinData::ckNumBytes(jpgData) - 1)

    CkRest::ckAddHeader(rest,"x-ms-range",CkStringBuilder::ckGetAsString(sbRange))

    ; The x-ms-write header is also required:
    CkRest::ckAddHeader(rest,"x-ms-write","update")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
    success = CkRest::ckFullRequestBd(rest,"PUT","/pip/wildlife/antarctic/penguins.jpg?comp=range",jpgData,sbResponseBody)
    If success <> 1
        ; This would indicate a failure where no response was received.
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(jpgData)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileSize)
        CkStringBuilder::ckDispose(sbRange)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; A 201 response indicates the data was uploaded.
    If CkRest::ckResponseStatusCode(rest) <> 201
        ; 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)
        CkBinData::ckDispose(jpgData)
        CkAuthAzureStorage::ckDispose(azAuth)
        CkStringBuilder::ckDispose(sbFileSize)
        CkStringBuilder::ckDispose(sbRange)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    Debug "Successfully uploaded data into penguins.jpg"


    CkRest::ckDispose(rest)
    CkBinData::ckDispose(jpgData)
    CkAuthAzureStorage::ckDispose(azAuth)
    CkStringBuilder::ckDispose(sbFileSize)
    CkStringBuilder::ckDispose(sbRange)
    CkStringBuilder::ckDispose(sbResponseBody)


    ProcedureReturn
EndProcedure