Data.Cloud.AzureAPI.TAzureBlobService.ListBlobsXML

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

Delphi

function ListBlobsXML(ContainerName: string; OptionalParams: TStrings = nil;
ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated 'Use overloaded method instead';

C++

System::UnicodeString __fastcall ListBlobsXML _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 */;

プロパティ

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

説明

警告: ListBlobsXML は非推奨になっています。

指定されたコンテナに対する blob のリストを XML 表現で返します。

ListBlobsXML は、コンテナの blob のリストを、XML 表現で返すために使用されます。

次の表では、パラメータを説明しています。

パラメータ 説明

ContainerName

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

OptionalParams

任意パラメータの「名前/値」ペアのリスト。

ResponseInfo

レスポンス情報を保管するための、任意のクラス。

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

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

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

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

maxresults が指定される場合、それは返される blob の最大値を表す、整数値として処理されます。 デフォルト(かつ最大値)は 5000 です。 maxresults 以上に blob が存在する場合、XML 内の NextMarker が設定され、これを以降の呼び出しにおいて、marker の値として使用することができます。

include が指定される場合、1 つまたは複数の次の文字列の、カンマ区切りの値(CSV)で構成します:

  • snapshots — レスポンスにスナップショットを含める(古いものから新しいものへソートされている)
  • metadata — レスポンスに各 blob のメタデータを含める
  • uncommittedblobs — レスポンスにコミットされていないセクションを持つ blob を含める

警告: $root コンテナ下の blob は、名前にスラッシュが使えない点に注意してください。

関連項目