.NET を使用して BLOB を一覧表示する

[アーティクル]
08/05/2024

この記事では、.NET 用の Azure Storage クライアントライブラリを使用して BLOB を一覧表示する方法について説明します。

前提条件

Azure サブスクリプション - 無料アカウントを作成する
Azure Storage アカウント - ストレージアカウントの作成
使用するオペレーティングシステム用の最新の .NET SDK。ランタイムではなく、必ず SDK を入手してください。

環境を設定する

既存のプロジェクトがない場合、このセクションでは、.NET 用 Azure Blob Storage クライアントライブラリを使用するようにプロジェクトを設定する方法について説明します。このステップには、パッケージのインストール、usingディレクティブの追加、承認されたクライアントオブジェクトの作成が含まれます。詳細については、「Azure Blob Storage と .NET の概要」に関するページを参照してください。

パッケージをインストールする

プロジェクトディレクトリから、dotnet add package コマンドを使用して、Azure Blob Storage と Azure ID のクライアントライブラリのパッケージをインストールします。 Azure サービスへのパスワードレス接続には、Azure.Identity パッケージが必要です。

dotnet add package Azure.Storage.Blobs
dotnet add package Azure.Identity

`using` ディレクティブを追加します

次の using ディレクティブをコードファイルの先頭に追加します。

using Azure.Identity;
using Azure.Storage.Blobs;
using Azure.Storage.Blobs.Models;
using Azure.Storage.Blobs.Specialized;

この記事の一部のコード例では、追加のusing ディレクティブが必要な場合があります。

クライアントオブジェクトの作成

アプリを Blob Storage に接続するには、 BlobServiceClientのインスタンスを作成します。次の例では、認可のために DefaultAzureCredential を使用してクライアントオブジェクトを作成する方法を示します。

public BlobServiceClient GetBlobServiceClient(string accountName)
{
    BlobServiceClient client = new(
        new Uri($"https://{accountName}.blob.core.windows.net"),
        new DefaultAzureCredential());

    return client;
}

.NET アプリに依存関係の挿入用のサービスクライアントを登録できます。

また、特定のコンテナーまたは BLOB 用のクライアントオブジェクトを作成することもできます。クライアントオブジェクトの作成と管理の詳細については、「データリソースを操作するクライアントオブジェクトを作成および管理する」を参照してください。

承認

認可メカニズムには、BLOB を一覧表示するために必要なアクセス許可が必要です。 Microsoft Entra ID を使用した認可 (推奨) には、Azure RBAC 組み込みロールの Storage BLOB データ閲覧者以上が必要です。詳細については、List Blobs (REST API) の「認可」のガイダンスを参照してください。

BLOB の一覧表示オプションについて

BLOB をコードから一覧表示する際には、Azure Storage からの結果の取得方法を管理するためのオプションをいくつか指定できます。各結果セットで返す結果の数を指定し、後続のセットを取得できます。名前がその文字または文字列から始まる BLOB を返すようにプレフィックスを指定できます。また、フラットリスト構造 (階層) で BLOB を一覧表示できます。階層リストでは、フォルダーに整理されたかのように BLOB が返されます。

ストレージアカウント内の BLOB を一覧表示するには、次のいずれかのメソッドを呼び出します。

返される結果の数を管理する

既定では、一覧表示操作から一度に最大 5,000 件の結果が返されますが、各一覧表示操作で返される結果の数は指定できます。この記事の例は、結果をページに返す方法を示しています。改ページの概念の詳細については、「Azure SDK for .NET を使用した改ページ」を参照してください。

プレフィックスを使用して結果をフィルター処理する

BLOB の一覧をフィルター処理するには、prefix パラメーターの文字列を指定します。プレフィックス文字列には、1 つ以上の文字を含めることができます。 Azure Storage は、名前がそのプレフィックスで始まる BLOB だけを返します。

メタデータを返す

結果を含む BLOB メタデータを返すには、BlobTraits 列挙型のメタデータ値を指定します。

フラットな一覧表示と階層的な一覧表示

Azure Storage の BLOB は、(従来のファイルシステムのような) 階層的なパラダイムではなく、フラットなパラダイムで組織化されます。ただし、フォルダー構造を模倣するために、BLOB を仮想ディレクトリに組織化することができます。仮想ディレクトリは BLOB 名の一部を形成し、区切り文字によって示されます。

BLOB を仮想ディレクトリに組織化するには、BLOB 名に区切り文字を使用します。既定の区切り文字はスラッシュ (/) ですが、区切り文字として任意の文字を指定できます。

区切り記号を使用して BLOB に名前を付ける場合、BLOB を階層的に一覧表示することを選択できます。階層的な一覧表示操作の場合、Azure Storage は、親オブジェクトの下にあるすべての仮想ディレクトリと BLOB を返します。従来のファイルシステムをプログラムで走査するのと同じような方法で、一覧表示操作を再帰的に呼び出して階層を走査することができます。

フラットな一覧表示を使用する

既定では、一覧表示操作はフラットな一覧表示で BLOB を返します。フラットな一覧表示では、BLOB は仮想ディレクトリによって整理されません。

次の例では、フラットな一覧表示を使用し、オプションのセグメントサイズを指定して、指定されたコンテナー内の BLOB を一覧表示し、BLOB 名をコンソールウィンドウに出力します。

private static async Task ListBlobsFlatListing(BlobContainerClient blobContainerClient, 
                                               int? segmentSize)
{
    try
    {
        // Call the listing operation and return pages of the specified size.
        var resultSegment = blobContainerClient.GetBlobsAsync()
            .AsPages(default, segmentSize);

        // Enumerate the blobs returned for each page.
        await foreach (Page<BlobItem> blobPage in resultSegment)
        {
            foreach (BlobItem blobItem in blobPage.Values)
            {
                Console.WriteLine("Blob name: {0}", blobItem.Name);
            }

            Console.WriteLine();
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

出力例は次のようになります。

Blob name: FolderA/blob1.txt
Blob name: FolderA/blob2.txt
Blob name: FolderA/blob3.txt
Blob name: FolderA/FolderB/blob1.txt
Blob name: FolderA/FolderB/blob2.txt
Blob name: FolderA/FolderB/blob3.txt
Blob name: FolderA/FolderB/FolderC/blob1.txt
Blob name: FolderA/FolderB/FolderC/blob2.txt
Blob name: FolderA/FolderB/FolderC/blob3.txt

Note

次に示すサンプル出力では、フラット型名前空間を持つストレージアカウントがあることを前提としています。ストレージアカウントで階層型名前空間の機能を有効にしている場合、ディレクトリは仮想ではありません。そうではなく、具象の独立したオブジェクトです。その結果、ディレクトリは長さ 0 の BLOB として一覧に表示されます。

階層型名前空間を使って作業する場合の別のリストオプションについては、「ディレクトリの内容を一覧表示する (Azure Data Lake Storage)」を参照してください。

階層的な一覧表示を使用する

一覧表示操作を階層的に呼び出すと、Azure Storage は、階層の最初のレベルに仮想ディレクトリと BLOB を返します。

BLOB を階層的に一覧表示するには、BlobContainerClient.GetBlobsByHierarchy メソッドまたは BlobContainerClient.GetBlobsByHierarchyAsync メソッドを呼び出します。

次の例では、階層型の一覧表示を使用し、オプションのセグメントサイズを指定して、指定したコンテナー内の BLOB を一覧表示し、BLOB 名をコンソールウィンドウに出力します。

private static async Task ListBlobsHierarchicalListing(BlobContainerClient container, 
                                                       string prefix, 
                                                       int? segmentSize)
{
    try
    {
        // Call the listing operation and return pages of the specified size.
        var resultSegment = container.GetBlobsByHierarchyAsync(prefix:prefix, delimiter:"/")
            .AsPages(default, segmentSize);

        // Enumerate the blobs returned for each page.
        await foreach (Page<BlobHierarchyItem> blobPage in resultSegment)
        {
            // A hierarchical listing may return both virtual directories and blobs.
            foreach (BlobHierarchyItem blobhierarchyItem in blobPage.Values)
            {
                if (blobhierarchyItem.IsPrefix)
                {
                    // Write out the prefix of the virtual directory.
                    Console.WriteLine("Virtual directory prefix: {0}", blobhierarchyItem.Prefix);

                    // Call recursively with the prefix to traverse the virtual directory.
                    await ListBlobsHierarchicalListing(container, blobhierarchyItem.Prefix, null);
                }
                else
                {
                    // Write out the name of the blob.
                    Console.WriteLine("Blob name: {0}", blobhierarchyItem.Blob.Name);
                }
            }

            Console.WriteLine();
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

出力例は次のようになります。

Virtual directory prefix: FolderA/
Blob name: FolderA/blob1.txt
Blob name: FolderA/blob2.txt
Blob name: FolderA/blob3.txt

Virtual directory prefix: FolderA/FolderB/
Blob name: FolderA/FolderB/blob1.txt
Blob name: FolderA/FolderB/blob2.txt
Blob name: FolderA/FolderB/blob3.txt

Virtual directory prefix: FolderA/FolderB/FolderC/
Blob name: FolderA/FolderB/FolderC/blob1.txt
Blob name: FolderA/FolderB/FolderC/blob2.txt
Blob name: FolderA/FolderB/FolderC/blob3.txt

Note

BLOB のスナップショットは、階層的な一覧表示操作では一覧表示できません。

BLOB のバージョンまたはスナップショットをリストに表示する

BLOB のバージョンまたはスナップショットを一覧表示するには、[バージョン] または [スナップショット] フィールドで BlobStates パラメーターを指定します。バージョンとスナップショットは、古いものから新しいものの順に列挙されます。

次のコード例は、BLOB のバージョンを一覧表示する方法を示しています。

private static void ListBlobVersions(BlobContainerClient blobContainerClient, 
                                           string blobName)
{
    try
    {
        // Call the listing operation, specifying that blob versions are returned.
        // Use the blob name as the prefix. 
        var blobVersions = blobContainerClient.GetBlobs
            (BlobTraits.None, BlobStates.Version, prefix: blobName)
            .OrderByDescending(version => version.VersionId).Where(blob => blob.Name == blobName);

        // Construct the URI for each blob version.
        foreach (var version in blobVersions)
        {
            BlobUriBuilder blobUriBuilder = new BlobUriBuilder(blobContainerClient.Uri)
            {
                BlobName = version.Name,
                VersionId = version.VersionId
            };

            if ((bool)version.IsLatestVersion.GetValueOrDefault())
            {
                Console.WriteLine("Current version: {0}", blobUriBuilder);
            }
            else
            {
                Console.WriteLine("Previous version: {0}", blobUriBuilder);
            }
        }
    }
    catch (RequestFailedException e)
    {
        Console.WriteLine(e.Message);
        Console.ReadLine();
        throw;
    }
}

リソース

.NET 用 Azure Blob Storage クライアントライブラリを使用して BLOB を一覧表示する方法について詳しくは、次のリソースを参照してください。

REST API の操作

Azure SDK for .NET には Azure REST API に基づいて構築されたライブラリが含まれるため、使い慣れた .NET パラダイムを通じて REST API 操作を利用できます。 BLOB を一覧表示するためのクライアントライブラリメソッドは、次の REST API 操作を使用します。

List Blobs (REST API)

次の方法で共有

.NET を使用して BLOB を一覧表示する

前提条件

環境を設定する

パッケージをインストールする

`using` ディレクティブを追加します

クライアントオブジェクトの作成

承認

BLOB の一覧表示オプションについて

返される結果の数を管理する

プレフィックスを使用して結果をフィルター処理する

メタデータを返す

フラットな一覧表示と階層的な一覧表示

フラットな一覧表示を使用する

階層的な一覧表示を使用する

BLOB のバージョンまたはスナップショットをリストに表示する

リソース

REST API の操作

クライアントライブラリのリソース

関連項目

フィードバック

その他のリソース

次の方法で共有

.NET を使用して BLOB を一覧表示する

前提条件

環境を設定する

パッケージをインストールする

using ディレクティブを追加します

クライアント オブジェクトの作成

承認

BLOB の一覧表示オプションについて

返される結果の数を管理する

プレフィックスを使用して結果をフィルター処理する

メタデータを返す

フラットな一覧表示と階層的な一覧表示

フラットな一覧表示を使用する

階層的な一覧表示を使用する

BLOB のバージョンまたはスナップショットをリストに表示する

リソース

REST API の操作

クライアント ライブラリのリソース

関連項目

関連するコンテンツ

フィードバック

その他のリソース

`using` ディレクティブを追加します

クライアントオブジェクトの作成

クライアントライブラリのリソース