Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL loJpgData
LOCAL loAzAuth
LOCAL loSbFileSize
LOCAL lcResponseStr
LOCAL loSbRange
LOCAL loSbResponseBody

lnSuccess = 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.

loRest = CreateObject('Chilkat.Rest')

* Connect to the Azure Storage Blob Service
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
* In this example, the storage account name is "chilkat".
lnSuccess = loRest.Connect("chilkat.file.core.windows.net",lnPort,lnBTls,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

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

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

* 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:
loRest.AddHeader("x-ms-type","file")

* This required header specifies the final size of the file (or the maximum size it can be).
loSbFileSize = CreateObject('Chilkat.StringBuilder')
loSbFileSize.AppendInt(loJpgData.NumBytes)
loRest.AddHeader("x-ms-content-length",loSbFileSize.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"
lcResponseStr = loRest.FullRequestNoBody("PUT","/pip/wildlife/antarctic/penguins.jpg")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loJpgData
    RELEASE loAzAuth
    RELEASE loSbFileSize
    CANCEL
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 (loRest.ResponseStatusCode <> 201) THEN
    * Examine the request/response to see what happened.
    ? "response status code = " + STR(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseStr
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    RELEASE loRest
    RELEASE loJpgData
    RELEASE loAzAuth
    RELEASE loSbFileSize
    CANCEL
ENDIF

? "Successfully created penguins.jpg"

* --------------------------------------------------------------------------------
* Upload the file data...

* Make sure the headers from the "Create File" operation are removed.
loRest.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

loSbRange = CreateObject('Chilkat.StringBuilder')
loSbRange.Append("bytes=0-")
loSbRange.AppendInt(loJpgData.NumBytes - 1)

loRest.AddHeader("x-ms-range",loSbRange.GetAsString())

* The x-ms-write header is also required:
loRest.AddHeader("x-ms-write","update")

loSbResponseBody = CreateObject('Chilkat.StringBuilder')
* IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
lnSuccess = loRest.FullRequestBd("PUT","/pip/wildlife/antarctic/penguins.jpg?comp=range",loJpgData,loSbResponseBody)
IF (lnSuccess <> 1) THEN
    * This would indicate a failure where no response was received.
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loJpgData
    RELEASE loAzAuth
    RELEASE loSbFileSize
    RELEASE loSbRange
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* A 201 response indicates the data was uploaded.
IF (loRest.ResponseStatusCode <> 201) THEN
    * Examine the request/response to see what happened.
    ? "response status code = " + STR(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseStr
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    RELEASE loRest
    RELEASE loJpgData
    RELEASE loAzAuth
    RELEASE loSbFileSize
    RELEASE loSbRange
    RELEASE loSbResponseBody
    CANCEL
ENDIF

? "Successfully uploaded data into penguins.jpg"

RELEASE loRest
RELEASE loJpgData
RELEASE loAzAuth
RELEASE loSbFileSize
RELEASE loSbRange
RELEASE loSbResponseBody