(Perl) Azure File Service: Upload File

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.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# 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 = chilkat::CkRest->new();

# Connect to the Azure Storage Blob Service
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
# In this example, the storage account name is "chilkat".
$success = $rest->Connect("chilkat.file.core.windows.net",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# This example will upload a relatively small file (760K), so it may as well 
# just be load it into memory..
$jpgData = chilkat::CkBinData->new();
$jpgData->LoadFile("qa_data/jpg/penguins.jpg");

# Provide Azure Cloud credentials for the REST calls.
$azAuth = chilkat::CkAuthAzureStorage->new();
$azAuth->put_AccessKey("AZURE_ACCESS_KEY");
# The account name used here should match the 1st part of the domain passed in the call to Connect (above).
$azAuth->put_Account("chilkat");
$azAuth->put_Scheme("SharedKey");
$azAuth->put_Service("File");
# This causes the "x-ms-version: 2021-08-06" header to be automatically added.
$azAuth->put_XMsVersion("2021-08-06");
$success = $rest->SetAuthAzureStorage($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:
$rest->AddHeader("x-ms-type","file");

# This required header specifies the final size of the file (or the maximum size it can be).
$sbFileSize = chilkat::CkStringBuilder->new();
$sbFileSize->AppendInt($jpgData->get_NumBytes());
$rest->AddHeader("x-ms-content-length",$sbFileSize->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"
$responseStr = $rest->fullRequestNoBody("PUT","/pip/wildlife/antarctic/penguins.jpg");
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# 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 ($rest->get_ResponseStatusCode() != 201) {
    # Examine the request/response to see what happened.
    print "response status code = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "response status text = " . $rest->responseStatusText() . "\r\n";
    print "response header: " . $rest->responseHeader() . "\r\n";
    print "response body (if any): " . $responseStr . "\r\n";
    print "---" . "\r\n";
    print "LastRequestStartLine: " . $rest->lastRequestStartLine() . "\r\n";
    print "LastRequestHeader: " . $rest->lastRequestHeader() . "\r\n";
    exit;
}

print "Successfully created penguins.jpg" . "\r\n";

# --------------------------------------------------------------------------------
# Upload the file data...

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

$sbRange = chilkat::CkStringBuilder->new();
$sbRange->Append("bytes=0-");
$sbRange->AppendInt($jpgData->get_NumBytes() - 1);

$rest->AddHeader("x-ms-range",$sbRange->getAsString());

# The x-ms-write header is also required:
$rest->AddHeader("x-ms-write","update");

$sbResponseBody = chilkat::CkStringBuilder->new();
# IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
$success = $rest->FullRequestBd("PUT","/pip/wildlife/antarctic/penguins.jpg?comp=range",$jpgData,$sbResponseBody);
if ($success != 1) {
    # This would indicate a failure where no response was received.
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# A 201 response indicates the data was uploaded.
if ($rest->get_ResponseStatusCode() != 201) {
    # Examine the request/response to see what happened.
    print "response status code = " . $rest->get_ResponseStatusCode() . "\r\n";
    print "response status text = " . $rest->responseStatusText() . "\r\n";
    print "response header: " . $rest->responseHeader() . "\r\n";
    print "response body (if any): " . $responseStr . "\r\n";
    print "---" . "\r\n";
    print "LastRequestStartLine: " . $rest->lastRequestStartLine() . "\r\n";
    print "LastRequestHeader: " . $rest->lastRequestHeader() . "\r\n";
    exit;
}

print "Successfully uploaded data into penguins.jpg" . "\r\n";