Dart

Azure Storage: Lease Container

See more Azure Cloud Storage Examples

Azure Storage Blob Service REST API: Sample code to establishes a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Azure Blob Service Example: Lease Container
  // See also: https://msdn.microsoft.com/en-us/library/azure/jj159103.aspx

  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final rest = CkRest();

  // Connect to the Azure Storage Blob Service
  final bTls = true;
  final port = 443;
  final bAutoReconnect = true;
  // In this example, the storage account name is "chilkat".
  try {
    rest.connect('chilkat.blob.core.windows.net', port, bTls, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Provide Azure Cloud credentials for the REST call.
  final azAuth = CkAuthAzureStorage();
  azAuth.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.account = 'chilkat';
  azAuth.scheme = 'SharedKey';
  azAuth.service = 'Blob';
  // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
  azAuth.xMsVersion = '2021-08-06';
  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.

  // The lease ID needs to be a GUID.  (UUID and GUID are synonymous)
  final crypt = CkCrypt2();
  final guid = crypt.generateUuid();
  print('Lease ID: $guid');
  rest.addHeader('x-ms-lease-id', guid);

  // The action can be "acquire", "renew", "change", "release", or "break".
  // See https://msdn.microsoft.com/en-us/library/azure/jj159103.aspx
  rest.addHeader('x-ms-lease-action', 'acquire');

  // The lease duration..
  rest.addHeader('x-ms-lease-duration', '15');

  // In this example, we are acquiring a lease for the container named "mycontainer".
  final String responseStr;
  try {
    responseStr = rest.fullRequestNoBody('PUT', '/mycontainer?restype=container&comp=lease');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // When successful, the Azure Storage service will respond with a 200, 201, or 202 response status code,
  // with no response body.

  // The status code depends on the operation:
  //    Acquire: A successful operation returns status code 201 (Created).
  //    Renew: A successful operation returns status code 200 (OK).
  //    Change: A successful operation returns status code 200 (OK).
  //    Release: A successful operation returns status code 200 (OK).
  //    Break: A successful operation returns status code 202 (Accepted).

  if ((rest.responseStatusCode < 200) || (rest.responseStatusCode > 202)) {
    // Examine the request/response to see what happened.
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response body (if any): $responseStr');
    print('---');
    print('LastRequestStartLine: ${rest.lastRequestStartLine}');
    print('LastRequestHeader: ${rest.lastRequestHeader}');
    return;
  }

  print('Success: Lease acquired.');
}