Python을 사용하여 Blob 컨테이너 나열

아티클
08/22/2024

코드에서 Azure Storage 계정의 컨테이너를 나열할 때 여러 옵션을 지정하여 Azure Storage에서 결과가 반환되는 방식을 관리할 수 있습니다. 이 문서에서는 Python용 Azure Storage 클라이언트 라이브러리를 사용하여 컨테이너를 나열하는 방법을 보여 줍니다.

비동기 API를 사용하여 blob 컨테이너를 나열하는 방법에 대해 알아보려면 비동기적으로 컨테이너 나열을 참조하세요.

필수 조건

Azure 구독 - 체험 구독 만들기
Azure Storage 계정 - 스토리지 계정 만들기
Python 3.8+

환경 설정

기존 프로젝트가 없는 경우, 이 섹션에서는 Python Azure Blob Storage 클라이언트 라이브러리를 사용해서 작동하도록 프로젝트를 설정하는 방법을 보여 줍니다. 자세한 내용은 Azure Blob Storage 및 Python 시작을 참조하세요.

이 문서의 코드 예제를 사용하려면 다음 단계에 따라 프로젝트를 설정합니다.

패키지 설치

pip install를 사용하여 다음 패키지를 설치합니다.

pip install azure-storage-blob azure-identity

Import 문 추가

다음 import 문을 추가합니다.

from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient

권한 부여

권한 부여 메커니즘에는 Blob 컨테이너를 나열하는 데 필요한 권한이 있어야 합니다. Microsoft Entra ID(권장)로 권한 부여하려면 Azure RBAC 기본 제공 역할 Storage Blob 데이터 기여자 이상이 필요합니다. 자세한 내용은 컨테이너 나열(REST API)에 대한 권한 부여 지침을 참조하세요.

클라이언트 개체 만들기

Blob Storage에 앱을 연결하려면 BlobServiceClient의 인스턴스를 만듭니다. 다음 예에서는 권한 부여를 위해 DefaultAzureCredential을 사용하여 클라이언트 개체를 만드는 방법을 설명합니다.

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"
credential = DefaultAzureCredential()

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=credential)

BlobServiceClient 개체에서 또는 직접 특정 컨테이너 또는 Blob에 대한 클라이언트 개체를 만들 수도 있습니다. 클라이언트 개체 만들기 및 관리에 대한 자세한 내용은 데이터 리소스와 상호 작용하는 클라이언트 개체 만들기 및 관리를 참조하세요.

컨테이너 목록 옵션 정보

코드에서 컨테이너를 나열할 때 Azure Storage에서 결과가 반환되는 방식을 관리하는 옵션을 지정할 수 있습니다. 각 결과 세트에서 반환할 결과 수를 지정하고 후속 세트를 검색할 수 있습니다. 또한 접두사를 기준으로 결과를 필터링하고 결과와 함께 컨테이너 메타데이터를 반환할 수도 있습니다. 다음 섹션에서는 이러한 방법에 대해 설명합니다.

스토리지 계정의 컨테이너를 나열하려면 다음 메서드를 호출합니다.

BlobServiceClient.list_containers

이 메서드는 ContainerProperties 형식의 반복 가능 항목을 반환합니다. 컨테이너는 이름을 기준으로 사전순으로 정렬됩니다.

반환되는 결과 수 관리

기본적으로 목록 작업은 한 번에 최대 5,000개의 결과를 반환합니다. 더 작은 결과 집합을 반환하려면 results_per_page 키워드 인수에 0이 아닌 값을 제공합니다.

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

컨테이너 목록을 필터링하려면 name_starts_with 키워드 인수에 문자열이나 문자를 지정합니다. 접두사 문자열은 하나 이상의 문자를 포함할 수 있습니다. 그러면 Azure Storage는 이름이 해당 접두사로 시작하는 컨테이너만 반환합니다.

컨테이너 메타데이터 포함

결과에 컨테이너 메타데이터를 포함하려면 include_metadata 키워드 인수를 True로 설정합니다. Azure Storage에는 반환된 각 컨테이너와 함께 메타데이터가 포함되어 있으므로 컨테이너 메타데이터를 별도로 가져올 필요가 없습니다.

삭제된 컨테이너 포함

결과에 일시 삭제된 컨테이너를 포함하려면 include_deleted 키워드 인수를 True로 설정합니다.

코드 예제

다음 예제에서는 모든 컨테이너 및 메타데이터를 나열합니다. include_metadata를 True로 설정하여 컨테이너 메타데이터를 포함할 수 있습니다.

def list_containers(self, blob_service_client: BlobServiceClient):
    containers = blob_service_client.list_containers(include_metadata=True)
    for container in containers:
        print(container['name'], container['metadata'])

다음 예제에서는 name_starts_with 매개 변수에 지정된 접두사로 시작하는 컨테이너만 나열합니다.

def list_containers_prefix(self, blob_service_client: BlobServiceClient):
    containers = blob_service_client.list_containers(name_starts_with='test-')
    for container in containers:
        print(container['name'])

페이지당 결과 수 제한을 지정할 수도 있습니다. 이 예제는 results_per_page를 전달하고 결과 페이지를 매깁니다.

def list_containers_pages(self, blob_service_client: BlobServiceClient):
    i=0
    all_pages = blob_service_client.list_containers(results_per_page=5).by_page()
    for container_page in all_pages:
        i += 1
        print(f"Page {i}")
        for container in container_page:
            print(container['name'])

비동기식으로 컨테이너 나열

Python용 Azure Blob Storage 클라이언트 라이브러리는 비동기적으로 컨테이너 나열을 지원합니다. 프로젝트 설정 요구 사항에 대해 자세히 알아보려면 비동기 프로그래밍을 참조하세요.

비동기 API를 사용하여 컨테이너를 나열하려면 다음 단계를 따릅니다.

다음 import 문을 추가합니다.

import asyncio

from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient

asyncio.run을 사용하여 프로그램을 실행하는 코드를 추가합니다. 이 함수는 전달된 코루틴(예에서는 main())을 실행하고 asyncio 이벤트 루프를 관리합니다. 코루틴은 async/await 구문으로 선언됩니다. 이 예에서 main() 코루틴은 먼저 async with를 사용하여 최상위 수준 BlobServiceClient를 만든 다음 컨테이너를 나열하는 메서드를 호출합니다. 최상위 클라이언트에서만 async with를 사용해야 합니다. 이 클라이언트에서 만들어진 다른 클라이언트는 동일한 연결 풀을 공유하기 때문입니다.
```
async def main():
    sample = ContainerSamples()

    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    credential = DefaultAzureCredential()

    async with BlobServiceClient(account_url, credential=credential) as blob_service_client:
        await sample.list_containers(blob_service_client)

if __name__ == '__main__':
    asyncio.run(main())
```
컨테이너를 나열하는 코드를 추가합니다. 메서드가 async 키워드로 선언되고 list_containers 메서드를 호출할 때 async for가 사용된다는 점을 제외하면 코드는 동기 예와 동일합니다.
```
async def list_containers(self, blob_service_client: BlobServiceClient):
    async for container in blob_service_client.list_containers(include_metadata=True):
        print(container['name'], container['metadata'])
```

이 기본 설정을 사용하면 async/await 구문을 사용하여 이 문서의 다른 예를 코루틴으로 구현할 수 있습니다.

리소스

Python용 Azure Blob Storage 클라이언트 라이브러리를 사용하여 컨테이너를 나열하는 방법에 대해 자세히 알아보려면 다음 리소스를 참조하세요.

코드 샘플

이 문서(GitHub)에서 동기 또는 비동기 코드 샘플 보기

REST API 작업

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

컨테이너 나열(REST API)

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

참고 항목

Blob 리소스 열거

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

다음을 통해 공유

Python을 사용하여 Blob 컨테이너 나열

필수 조건

환경 설정

패키지 설치

Import 문 추가

권한 부여

클라이언트 개체 만들기

컨테이너 목록 옵션 정보

반환되는 결과 수 관리

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

컨테이너 메타데이터 포함

삭제된 컨테이너 포함

코드 예제

비동기식으로 컨테이너 나열

리소스

코드 샘플

REST API 작업

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

참고 항목

피드백

추가 리소스

다음을 통해 공유

Python을 사용하여 Blob 컨테이너 나열

필수 조건

환경 설정

패키지 설치

Import 문 추가

권한 부여

클라이언트 개체 만들기

컨테이너 목록 옵션 정보

반환되는 결과 수 관리

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

컨테이너 메타데이터 포함

삭제된 컨테이너 포함

코드 예제

비동기식으로 컨테이너 나열

리소스

코드 샘플

REST API 작업

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

참고 항목

관련 콘텐츠

피드백

추가 리소스