BlobContainerClient.GetBlobsByHierarchy メソッド

  • リファレンス

定義

名前空間:
Azure.Storage.Blobs
アセンブリ:
Azure.Storage.Blobs.dll
パッケージ:
Azure.Storage.Blobs v12.20.0
パッケージ:
Azure.Storage.Blobs v12.21.0-beta.1
ソース:
BlobContainerClient.cs
ソース:
BlobContainerClient.cs

この操作は GetBlobsByHierarchy(BlobTraits, BlobStates, String, String, CancellationToken) 、このコンテナー内の BLOB の非同期コレクションを返します。 BLOB を列挙すると、すべての値をフェッチするときに、サービスに対して複数の要求が行われる場合があります。 BLOB は、名前によって辞書順に並べ替えされます。 を delimiter 使用して、BLOB の仮想階層をファイル システムのように走査できます。

詳細については、「 BLOB を一覧表示します。

public virtual Azure.Pageable<Azure.Storage.Blobs.Models.BlobHierarchyItem> GetBlobsByHierarchy (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string delimiter = default, string prefix = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetBlobsByHierarchy : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>
override this.GetBlobsByHierarchy : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>
Public Overridable Function GetBlobsByHierarchy (Optional traits As BlobTraits = Azure.Storage.Blobs.Models.BlobTraits.None, Optional states As BlobStates = Azure.Storage.Blobs.Models.BlobStates.None, Optional delimiter As String = Nothing, Optional prefix As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of BlobHierarchyItem)

パラメーター

traits
BlobTraits

BLOB を整形するための特性オプションを指定します。

states
BlobStates

BLOB をフィルター処理するための状態オプションを指定します。

delimiter
String

delimiter BLOB の仮想階層を、ファイル システムのように走査するために使用できる 。 区切り記号には単一文字または文字列を使用できます。 Prefix は、名前が区切り文字の外観まで同じ部分文字列で始まるすべての BLOB の代わりに返されます。 プレフィックスの値は substring+ delimiter です。ここで、substring は 1 つ以上の BLOB 名を開始する共通の部分文字列で、区切り記号は の delimiter値です。 プレフィックスの値を使用すると、プレフィックスの値を指定することで、このプレフィックスで始まる BLOB を一覧表示する後続の呼び出しを prefix行うことができます。

返される各 BlobPrefix 要素は、各 Blob 要素と同様に、最大結果にカウントされることに注意してください。

prefix
String

指定した で始まる名前の BLOB のみを返すように結果をフィルター処理する文字列を指定します prefix。

cancellationToken
CancellationToken

操作を取り消す必要があることを示す通知を伝達する場合は省略可能 CancellationToken です。

戻り値

Pageable<BlobHierarchyItem>

Pageable<T>コンテナー内の BlobHierarchyItem BLOB を記述する の 。

注釈

RequestFailedExceptionエラーが発生すると、 がスローされます。

適用対象