DSAzure.TAzureBlobService.LeaseBlob

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function LeaseBlob(const ContainerName: String; const BlobName: String; const LeaseAction: String = 'acquire';  const LeaseId: String = ''): String;

C++

System::UnicodeString __fastcall LeaseBlob(const System::UnicodeString ContainerName, const System::UnicodeString BlobName, const System::UnicodeString LeaseAction = L"acquire", const System::UnicodeString LeaseId = System::UnicodeString());

Properties

Type Visibility Source Unit Parent
function public
DSAzure.pas
DSAzure.hpp
DSAzure TAzureBlobService

Description

Acquires a lock on the given blob for write access.

LeaseBlob acquires a one-minute lock on the given blob, if the LeaseAction parameter has the acquire value (by default).


Other available actions for LeaseAction are:

Value Meaning

acquire

Acquires a one minute lock.

renew

Extends the lock for an additional minute.

release

Immediately releases the lock.

break

Releases the lock after the end of its minute, so that anyone can call it with no LeaseId.

Note: renew and release both require a LeaseId to perform.

Note: After break is called, until the lock is released and a new lease is acquired, renew cannot be called on the blob.


See Also