Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL oJpgData
LOCAL oAzAuth
LOCAL oSbFileSize
LOCAL cResponseStr
LOCAL oSbRange
LOCAL oSbResponseBody

nSuccess := 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.

oRest := CreateObject("Chilkat.Rest")

//  Connect to the Azure Storage Blob Service
nBTls := 1
nPort := 443
nBAutoReconnect := 1
//  In this example, the storage account name is "chilkat".
nSuccess := oRest:Connect("chilkat.file.core.windows.net", nPort, nBTls, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

//  This example will upload a relatively small file (760K), so it may as well 
//  just be load it into memory..
oJpgData := CreateObject("Chilkat.BinData")
oJpgData:LoadFile("qa_data/jpg/penguins.jpg")

//  Provide Azure Cloud credentials for the REST calls.
oAzAuth := CreateObject("Chilkat.AuthAzureStorage")
oAzAuth:AccessKey := "AZURE_ACCESS_KEY"
//  The account name used here should match the 1st part of the domain passed in the call to Connect (above).
oAzAuth:Account := "chilkat"
oAzAuth:Scheme := "SharedKey"
oAzAuth:Service := "File"
//  This causes the "x-ms-version: 2021-08-06" header to be automatically added.
oAzAuth:XMsVersion := "2021-08-06"
nSuccess := oRest:SetAuthAzureStorage(oAzAuth)

//  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:
oRest:AddHeader("x-ms-type", "file")

//  This required header specifies the final size of the file (or the maximum size it can be).
oSbFileSize := CreateObject("Chilkat.StringBuilder")
oSbFileSize:AppendInt(oJpgData:NumBytes)
oRest:AddHeader("x-ms-content-length", oSbFileSize:GetAsString())

//  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"
cResponseStr := oRest:FullRequestNoBody("PUT", "/pip/wildlife/antarctic/penguins.jpg")
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    oJpgData:destroy()
    oAzAuth:destroy()
    oSbFileSize:destroy()
    RETURN
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 (oRest:ResponseStatusCode != 201)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body (if any): " + cResponseStr
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
    oRest:destroy()
    oJpgData:destroy()
    oAzAuth:destroy()
    oSbFileSize:destroy()
    RETURN
ENDIF

? "Successfully created penguins.jpg"

//  --------------------------------------------------------------------------------
//  Upload the file data...

//  Make sure the headers from the "Create File" operation are removed.
oRest:ClearAllHeaders()

//  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

oSbRange := CreateObject("Chilkat.StringBuilder")
oSbRange:Append("bytes=0-")
oSbRange:AppendInt(oJpgData:NumBytes - 1)

oRest:AddHeader("x-ms-range", oSbRange:GetAsString())

//  The x-ms-write header is also required:
oRest:AddHeader("x-ms-write", "update")

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
//  IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
nSuccess := oRest:FullRequestBd("PUT", "/pip/wildlife/antarctic/penguins.jpg?comp=range", oJpgData, oSbResponseBody)
IF (nSuccess != 1)
    //  This would indicate a failure where no response was received.
    ? oRest:LastErrorText
    oRest:destroy()
    oJpgData:destroy()
    oAzAuth:destroy()
    oSbFileSize:destroy()
    oSbRange:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

//  A 201 response indicates the data was uploaded.
IF (oRest:ResponseStatusCode != 201)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body (if any): " + cResponseStr
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
    oRest:destroy()
    oJpgData:destroy()
    oAzAuth:destroy()
    oSbFileSize:destroy()
    oSbRange:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

? "Successfully uploaded data into penguins.jpg"

oRest:destroy()
oJpgData:destroy()
oAzAuth:destroy()
oSbFileSize:destroy()
oSbRange:destroy()
oSbResponseBody:destroy()