.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 데이터 읽기 권한자 이상이 필요합니다. 자세한 내용은 Blob 목록(REST API)에 대한 권한 부여 지침을 참조하세요.

Blob 목록 옵션 정보

코드에서 Blob을 나열하는 경우 Azure Storage에서 결과가 반환되는 방식을 관리하는 다양한 옵션을 지정할 수 있습니다. 각 결과 세트에서 반환할 결과 수를 지정하고 후속 세트를 검색할 수 있습니다. 이름이 해당 문자 또는 문자열로 시작하는 Blob을 반환하는 접두사를 지정할 수 있습니다. 플랫 목록 구조나 계층 구조로 Blob을 나열할 수 있습니다. 계층형 목록은 폴더로 구성된 것처럼 Blob을 반환합니다.

스토리지 계정의 Blob을 나열하려면 다음 메서드 중 하나를 호출합니다.

반환되는 결과 수 관리

기본적으로 목록 작업을 통해 반환되는 결과 수는 한 번에 최대 5,000개이지만 각 목록 작업을 통해 반환되도록 할 결과 수를 지정할 수 있습니다. 이 문서에 제공된 예제에서는 결과를 페이지에 반환하는 방법을 보여 줍니다. 페이지 매김 개념에 대한 자세한 내용은 .NET용 Azure SDK를 사용하여 페이지 매김을 참조하세요.

접두사를 사용하여 결과 필터링

BLOB 목록을 필터링하려면 prefix 매개 변수에 대한 문자열을 지정합니다. 접두사 문자열은 하나 이상의 문자를 포함할 수 있습니다. 그러면 Azure Storage는 이름이 해당 접두사로 시작하는 Blob만 반환합니다.

메타데이터 반환

BlobTraits 열거형에 대한 메타데이터 값을 지정하여 결과와 함께 Blob 메타데이터를 반환할 수 있습니다.

단순 목록 및 계층 구조 목록

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

참고 항목

표시된 샘플 출력에서는 단일 구조 네임스페이스가 있는 스토리지 계정이 있다고 가정합니다. 스토리지 계정에서 계층 구조 네임스페이스 기능을 사용한 경우 디렉터리는 가상이 아닙니다. 구체적이고 독립적인 개체입니다. 결과적으로 디렉터리를 목록에 길이가 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

참고 항목

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 작업

.NET용 Azure SDK에는 Azure REST API를 기반으로 빌드되는 라이브러리가 포함되어 있으므로 익숙한 .NET 패러다임을 통해 REST API 작업과 상호 작용할 수 있습니다. Blob을 나열하기 위한 클라이언트 라이브러리 메서드는 다음 REST API 작업을 사용합니다.

Blob 나열(REST API)

클라이언트 라이브러리 리소스

참고 항목

Blob 리소스 열거
Blob 버전 관리

이 문서는 .NET용 Blob Storage 개발자 가이드의 일부입니다. 자세한 내용은 .NET 앱 빌드에서 개발자 가이드 문서의 전체 목록을 참조하세요.

다음을 통해 공유

.NET을 사용하여 Blob 나열

필수 조건

환경 설정

패키지 설치

`using` 지시문 추가

클라이언트 개체 만들기

권한 부여

Blob 목록 옵션 정보

반환되는 결과 수 관리

접두사를 사용하여 결과 필터링

메타데이터 반환

단순 목록 및 계층 구조 목록

플랫 목록 사용

계층형 목록 사용

BLOB 버전 또는 스냅샷 나열

리소스

REST API 작업

클라이언트 라이브러리 리소스

참고 항목

피드백

추가 리소스

다음을 통해 공유

.NET을 사용하여 Blob 나열

필수 조건

환경 설정

패키지 설치

using 지시문 추가

클라이언트 개체 만들기

권한 부여

Blob 목록 옵션 정보

반환되는 결과 수 관리

접두사를 사용하여 결과 필터링

메타데이터 반환

단순 목록 및 계층 구조 목록

플랫 목록 사용

계층형 목록 사용

BLOB 버전 또는 스냅샷 나열

리소스

REST API 작업

클라이언트 라이브러리 리소스

참고 항목

관련 콘텐츠

피드백

추가 리소스

`using` 지시문 추가