Data.Cloud.AzureAPI.TAzureBlobService.ListBlobs

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function ListBlobs(ContainerName: string; OptionalParams: TStrings = nil;
ResponseInfo: TCloudResponseInfo = nil): TList<TAzureBlob>; overload; deprecated 'Use overloaded method instead';
function ListBlobs(ContainerName: string; out NextMarker: string; OptionalParams: TStrings = nil;
ResponseInfo: TCloudResponseInfo = nil): TList<TAzureBlob>; overload; deprecated 'Use overloaded method instead';
function ListBlobs(const AContainerName: string; const APrefix: string; const ADelimiter: string;
const AMarker: string; AMaxResult: Integer; ADatasets: TAzureBlobDatasets; out ANextMarker: string;
out ABlobPrefix: TArray<string>; out AResponseXML: string;
const AResponseInfo: TCloudResponseInfo): TArray<TAzureBlobItem>; overload;

C++

System::Generics::Collections::TList__1<TAzureBlob*>* __fastcall ListBlobs _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::Generics::Collections::TList__1<TAzureBlob*>* __fastcall ListBlobs _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, /* out */ System::UnicodeString &NextMarker, System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::DynamicArray<TAzureBlobItem> __fastcall ListBlobs(const System::UnicodeString AContainerName, const System::UnicodeString APrefix, const System::UnicodeString ADelimiter, const System::UnicodeString AMarker, int AMaxResult, TAzureBlobDatasets ADatasets, /* out */ System::UnicodeString &ANextMarker, /* out */ System::DynamicArray<System::UnicodeString> &ABlobPrefix, /* out */ System::UnicodeString &AResponseXML, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;

プロパティ

種類 可視性 ソース ユニット
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureBlobService


説明

指定されたコンテナの blob のリストを返します。

ListBlobs は、コンテナの blob のリストを返すために使用されます。

ListBlobs にはオーバーロード メソッドが 2 つあります。 次の表では、パラメータを説明しています:

パラメータ 説明

ContainerName

blob を取得するコンテナ、またはルート コンテナの場合には $root。

NextMarker

blob がすべて返されなかった場合の継続トークン。

OptionalParams

省略可能パラメータの名前/値ペア。

ResponseInfo

レスポンス情報を格納する任意のクラス。

次の省略可能パラメータがサポートされています: prefixdelimitermarkermaxresultsinclude={snapshots,metadata,uncommittedblobs}

prefix が指定されている場合、指定された接頭辞から始まる名前の blob のみが表示されます。

delimiter が指定されている場合、区切り文字列が含まれた(接頭辞文字列の後に)名前の blob が、適宜、'BlobPrefix' ノードにグループ化されます。このグループ化によって、blob を、仮想のディレクトリ構造で表示させることができ、そこから、返された 'BlobPrefix' 名前ノードの値を取得したり、続く呼び出しで、それらを接頭辞の値として使用することができます。

marker が指定されている場合、すべての blob が返されなかった際に、前の呼び出しで残してしまった blob をさらに取得するための継続トークンとしてこれを使用することができます。

maxresults が指定されている場合、これを、返す blob の最大数を表す整数として扱うことができます。デフォルト(そして最大値)は、5000 です。maxresults が許容する数より多くの blob がある場合、XML 内の NextMarker が設定され、これを続く呼び出しでの marker の値として使用することができます。

include が指定されている場合、これは、次の 1 つまたは複数のカンマ区切りの値(CSV)の文字列を保持することができます。

  • snapshots — レスポンスに blob スナップショットを含む(古い~新しいの順)。
  • metadata — レスポンスに各 blob のメタデータを含む。
  • uncommittedblobs — レスポンスに未コミットのセクションを持つ blob を含む。

警告: $root コンテナ下の blob は、名前にスラッシュ(/)をいれられない点に注意してください。

関連項目