Data.Cloud.AzureAPI.TAzureBlobService.SnapshotBlob
Delphi
function SnapshotBlob(ContainerName, BlobName: string; out SnapshotId: string; const LeaseId: string = ''; Metadata: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function SnapshotBlob(ContainerName, BlobName: string; SnapshotConditionals: TBlobActionConditional; out SnapshotId: string; const LeaseId: string = ''; Metadata: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function SnapshotBlob(const AContainerName, ABlobName, ALeaseID: string; ASnapshotConditionals: TBlobActionConditional; AMetadata: array of TPair<string, string>; out ASnapshotId: string; const AResponseInfo: TCloudResponseInfo): Boolean; overload;
C++
bool __fastcall SnapshotBlob _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, /* out */ System::UnicodeString &SnapshotId, const System::UnicodeString LeaseId = System::UnicodeString(), System::Classes::TStrings* Metadata = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall SnapshotBlob _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, const TBlobActionConditional &SnapshotConditionals, /* out */ System::UnicodeString &SnapshotId, const System::UnicodeString LeaseId = System::UnicodeString(), System::Classes::TStrings* Metadata = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall SnapshotBlob(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, const System::UnicodeString ALeaseID, const TBlobActionConditional &ASnapshotConditionals, System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> *AMetadata, const int AMetadata_High, /* out */ System::UnicodeString &ASnapshotId, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureBlobService |
Description
Creates a new snapshot of the specified blob.
SnapshotBlob creates a new snapshot of the specified blob.
There are two overloaded SnapshotBlob methods. For the second overloaded method, the snapshot is only created if the conditions specified in SnapshotConditionals are met. Only some of the conditionals of the TBlobActionConditional instance are used. For example, none that have field names beginning with 'IfSource' are used here.
The following table shows the significance of the parameters:
| Parameter | Description |
|---|---|
|
|
The name of the container the blob is in. |
|
|
The name of the blob to create a snapshot for. |
|
|
The conditions to meet in order to create the snapshot. |
|
|
The resulting snapshot ID, if successfully created. |
|
|
The lease ID, required if the blob is locked. |
|
|
The metadata to set onto the snapshot, instead of the blob's. |
|
|
The optional class for storing response info into. |
Set Metadata to nil or to an empty list, unless you want to set the metadata of your choice for the snapshot, instead of setting the metadata that is on the blob that has its snapshot taken.
The method returns True if the operation was successful, False otherwise.