AutoIt

Azure File Service: Upload Large File

See more Azure Cloud Storage Examples

Sample code to upload a large 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 writing ranges 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 large file requiring multiple "Put Range" calls. AutoIt

Local $bSuccess = False

; Azure File Service Example: Upload a large 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 = ObjCreate("Chilkat.Rest")

; Connect to the Azure Storage Blob Service
Local $bTls = True
Local $iPort = 443
Local $bAutoReconnect = True
; In this example, the storage account name is "chilkat".
$bSuccess = $oRest.Connect("chilkat.file.core.windows.net",$iPort,$bTls,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; This example will upload a larger file.
Local $sLocalFilePath = "qa_data/zips/somethingBig.zip"
$oFac = ObjCreate("Chilkat.FileAccess")
; Note: The FileSize method returns a signed 32-bit integer.  If the file is potentially larger than 2GB, call FileSizeStr instead to return
; the size of the file as a string, then convert to an integer value.
Local $iSzLocalFile = $oFac.FileSize($sLocalFilePath)
If ($iSzLocalFile < 0) Then
    ConsoleWrite($oFac.LastErrorText & @CRLF)
    Exit
EndIf

; Provide Azure Cloud credentials for the REST calls.
$oAzAuth = ObjCreate("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"
$bSuccess = $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 = ObjCreate("Chilkat.StringBuilder")
$oSbFileSize.AppendInt($iSzLocalFile)
$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 "somethingBig.zip" in the share "pip"
Local $sResponseStr = $oRest.FullRequestNoBody("PUT","/pip/somethingBig.zip")
If ($oRest.LastMethodSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
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) Then
    ; Examine the request/response to see what happened.
    ConsoleWrite("response status code = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("response status text = " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("response header: " & $oRest.ResponseHeader & @CRLF)
    ConsoleWrite("response body (if any): " & $sResponseStr & @CRLF)
    ConsoleWrite("---" & @CRLF)
    ConsoleWrite("LastRequestStartLine: " & $oRest.LastRequestStartLine & @CRLF)
    ConsoleWrite("LastRequestHeader: " & $oRest.LastRequestHeader & @CRLF)
    Exit
EndIf

ConsoleWrite("Successfully created somethingBig.zip" & @CRLF)

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

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

; The x-ms-write header is required for each "Put Range" request.
$oRest.AddHeader("x-ms-write","update")

$oSbRange = ObjCreate("Chilkat.StringBuilder")
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oBdFileData = ObjCreate("Chilkat.BinData")

; Open the file.  We'll be reading and uploading in chunks..
$bSuccess = $oFac.OpenForRead($sLocalFilePath)
If ($bSuccess <> True) Then
    ConsoleWrite($oFac.LastErrorText & @CRLF)
    Exit
EndIf

Local $iNumBytesLeft = $iSzLocalFile
Local $iCurIndex = 0
While $iNumBytesLeft > 0

Local $iChunkSize = $iNumBytesLeft
    ; Azure allows for 4MB max chunks  (4 x 1024 x 1024 = 4194304)
    If ($iChunkSize > 4194304) Then
        $iChunkSize = 4194304
    EndIf

    ; 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.Clear 
    $oSbRange.Append("bytes=")
    $oSbRange.AppendInt($iCurIndex)
    $oSbRange.Append("-")
    $oSbRange.AppendInt($iCurIndex + $iChunkSize - 1)

    ; This replaces the header if it already exists..
    $oRest.AddHeader("x-ms-range",$oSbRange.GetAsString())

    ; Read the next chunk from the local file.
    $oBdFileData.Clear()
    $bSuccess = $oFac.FileReadBd($iChunkSize,$oBdFileData)

    $bSuccess = $oRest.FullRequestBd("PUT","/pip/somethingBig.zip?comp=range",$oBdFileData,$oSbResponseBody)
    If ($bSuccess <> True) Then
        ; This would indicate a failure where no response was received.
        ConsoleWrite($oRest.LastErrorText & @CRLF)
        Exit
    EndIf

    ; A 201 response indicates the chunk was uploaded.
    If ($oRest.ResponseStatusCode <> 201) Then
        ; Examine the request/response to see what happened.
        ConsoleWrite("response status code = " & $oRest.ResponseStatusCode & @CRLF)
        ConsoleWrite("response status text = " & $oRest.ResponseStatusText & @CRLF)
        ConsoleWrite("response header: " & $oRest.ResponseHeader & @CRLF)
        ConsoleWrite("response body (if any): " & $sResponseStr & @CRLF)
        ConsoleWrite("---" & @CRLF)
        ConsoleWrite("LastRequestStartLine: " & $oRest.LastRequestStartLine & @CRLF)
        ConsoleWrite("LastRequestHeader: " & $oRest.LastRequestHeader & @CRLF)
        Exit
    EndIf

    ConsoleWrite("Uploaded chunk from " & $iCurIndex & " to " & ($iCurIndex + $iChunkSize - 1) & @CRLF)

    $iCurIndex = $iCurIndex + $iChunkSize
    $iNumBytesLeft = $iNumBytesLeft - $iChunkSize
Wend

$oFac.FileClose 

ConsoleWrite("success." & @CRLF)