(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, BinData, Rest, AuthAzureStorage, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
rest: HCkRest;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
success: Boolean;
jpgData: HCkBinData;
azAuth: HCkAuthAzureStorage;
sbFileSize: HCkStringBuilder;
responseStr: PWideChar;
sbRange: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;

begin
// 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 := CkRest_Create();

// Connect to the Azure Storage Blob Service
bTls := True;
port := 443;
bAutoReconnect := True;
// In this example, the storage account name is "chilkat".
success := CkRest_Connect(rest,'chilkat.file.core.windows.net',port,bTls,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// This example will upload a relatively small file (760K), so it may as well 
// just be load it into memory..
jpgData := CkBinData_Create();
CkBinData_LoadFile(jpgData,'qa_data/jpg/penguins.jpg');

// Provide Azure Cloud credentials for the REST calls.
azAuth := CkAuthAzureStorage_Create();
CkAuthAzureStorage_putAccessKey(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_putAccount(azAuth,'chilkat');
CkAuthAzureStorage_putScheme(azAuth,'SharedKey');
CkAuthAzureStorage_putService(azAuth,'File');
// This causes the "x-ms-version: 2021-08-06" header to be automatically added.
CkAuthAzureStorage_putXMsVersion(azAuth,'2021-08-06');
success := CkRest_SetAuthAzureStorage(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_AddHeader(rest,'x-ms-type','file');

// This required header specifies the final size of the file (or the maximum size it can be).
sbFileSize := CkStringBuilder_Create();
CkStringBuilder_AppendInt(sbFileSize,CkBinData_getNumBytes(jpgData));
CkRest_AddHeader(rest,'x-ms-content-length',CkStringBuilder__getAsString(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 := CkRest__fullRequestNoBody(rest,'PUT','/pip/wildlife/antarctic/penguins.jpg');
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// 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_getResponseStatusCode(rest) <> 201) then
  begin
    // Examine the request/response to see what happened.
    Memo1.Lines.Add('response status code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('response status text = ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('response header: ' + CkRest__responseHeader(rest));
    Memo1.Lines.Add('response body (if any): ' + responseStr);
    Memo1.Lines.Add('---');
    Memo1.Lines.Add('LastRequestStartLine: ' + CkRest__lastRequestStartLine(rest));
    Memo1.Lines.Add('LastRequestHeader: ' + CkRest__lastRequestHeader(rest));
    Exit;
  end;

Memo1.Lines.Add('Successfully created penguins.jpg');

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

// Make sure the headers from the "Create File" operation are removed.
CkRest_ClearAllHeaders(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 := CkStringBuilder_Create();
CkStringBuilder_Append(sbRange,'bytes=0-');
CkStringBuilder_AppendInt(sbRange,CkBinData_getNumBytes(jpgData) - 1);

CkRest_AddHeader(rest,'x-ms-range',CkStringBuilder__getAsString(sbRange));

// The x-ms-write header is also required:
CkRest_AddHeader(rest,'x-ms-write','update');

sbResponseBody := CkStringBuilder_Create();
// IMPORTANT:  Don't forget the "?comp=range" at the end of the path passed in the 2nd argument.
success := CkRest_FullRequestBd(rest,'PUT','/pip/wildlife/antarctic/penguins.jpg?comp=range',jpgData,sbResponseBody);
if (success <> True) then
  begin
    // This would indicate a failure where no response was received.
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// A 201 response indicates the data was uploaded.
if (CkRest_getResponseStatusCode(rest) <> 201) then
  begin
    // Examine the request/response to see what happened.
    Memo1.Lines.Add('response status code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('response status text = ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('response header: ' + CkRest__responseHeader(rest));
    Memo1.Lines.Add('response body (if any): ' + responseStr);
    Memo1.Lines.Add('---');
    Memo1.Lines.Add('LastRequestStartLine: ' + CkRest__lastRequestStartLine(rest));
    Memo1.Lines.Add('LastRequestHeader: ' + CkRest__lastRequestHeader(rest));
    Exit;
  end;

Memo1.Lines.Add('Successfully uploaded data into penguins.jpg');

CkRest_Dispose(rest);
CkBinData_Dispose(jpgData);
CkAuthAzureStorage_Dispose(azAuth);
CkStringBuilder_Dispose(sbFileSize);
CkStringBuilder_Dispose(sbRange);
CkStringBuilder_Dispose(sbResponseBody);

end;