Python을 사용하여 Blob 속성 및 메타데이터 관리

아티클
08/22/2024

Blob은 포함된 데이터 외에도 시스템 속성 및 사용자 정의 메타데이터를 지원합니다. 이 문서에서는 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, ContentSettings

권한 부여

권한 부여 메커니즘에는 컨테이너 속성 또는 메타데이터를 사용하는 데 필요한 권한이 있어야 합니다. Microsoft Entra ID로 권한 부여하려면(권장) get 작업을 위한 Azure RBAC 기본 제공 역할 Storage Blob 데이터 읽기 권한자 이상 및 set 작업을 위한 Storage Blob 데이터 기여자 이상이 필요합니다. 자세한 내용은 Blob 속성 설정(REST API), Blob 속성 가져오기(REST API), Blob 메타데이터 설정(REST API) 또는 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에 대한 클라이언트 개체를 만들 수도 있습니다. 클라이언트 개체 만들기 및 관리에 대한 자세한 내용은 데이터 리소스와 상호 작용하는 클라이언트 개체 만들기 및 관리를 참조하세요.

속성 및 메타데이터 정보

시스템 속성: 각 Blob Storage 리소스에는 시스템 속성이 있습니다. 그 중 일부를 읽거나 설정할 수 있지만 나머지는 읽기 전용입니다. 일부 시스템 속성은 내부적으로 특정 표준 HTTP 헤더에 해당합니다. Python용 Azure Storage 클라이언트 라이브러리는 이러한 속성을 유지 관리합니다.
사용자 정의 메타데이터: 사용자 정의 메타데이터는 Blob Storage 리소스에 지정하는 하나 이상의 이름-값 쌍으로 구성됩니다. 메타데이터를 사용하여 리소스와 함께 추가 값을 저장할 수 있습니다. 메타데이터 값은 고유한 목적으로만 사용되며 리소스의 동작 방식에 영향을 주지 않습니다.

메타데이터 이름/값 쌍은 유효한 HTTP 헤더이므로 HTTP 헤더와 관련된 모든 제한 사항을 준수해야 합니다. 메타데이터 명명 요구 사항에 대한 자세한 내용은 메타데이터 이름을 참조하세요.

참고 항목

또한 Blob 인덱스 태그는 Azure Blob Storage 리소스와 함께 임의의 사용자 정의 키/값 특성을 저장하는 기능을 제공합니다. 메타데이터와 비슷하지만 Blob 인덱스 태그만 자동으로 인덱싱되고 네이티브 Blob Service에서 검색할 수 있습니다. Azure Search와 같은 별도의 서비스를 활용하지 않으면 메타데이터를 인덱싱하고 쿼리할 수 없습니다.

이 기능에 대한 자세한 내용은 Blob 인덱스를 사용하여 Azure Blob Storage에서 데이터 관리 및 찾기(미리 보기)를 참조하세요.

속성 설정 및 검색

Blob에서 속성을 설정하려면 다음 메서드를 사용합니다.

BlobClient.set_http_headers

명시적으로 설정되지 않은 속성은 모두 지워진 것입니다. 기존 속성을 유지하려면 먼저 Blob 속성을 검색한 다음, 이를 사용하여 업데이트되지 않는 헤더를 채울 수 있습니다.

다음 코드 예제에서는 기존 속성을 유지하면서 Blob에서 content_type 및 content_language 시스템 속성을 설정합니다.

def set_properties(self, blob_service_client: BlobServiceClient, container_name):
    blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")

    # Get the existing blob properties
    properties = blob_client.get_blob_properties()

    # Set the content_type and content_language headers, and populate the remaining headers from the existing properties
    blob_headers = ContentSettings(content_type="text/plain",
                                   content_encoding=properties.content_settings.content_encoding,
                                   content_language="en-US",
                                   content_disposition=properties.content_settings.content_disposition,
                                   cache_control=properties.content_settings.cache_control,
                                   content_md5=properties.content_settings.content_md5)
    
    blob_client.set_http_headers(blob_headers)

Blob에서 속성을 검색하려면 다음 메서드를 사용합니다.

BlobClient.get_blob_properties

다음 코드 예제에서는 Blob의 시스템 속성을 가져오고 일부 값을 표시합니다.

def get_properties(self, blob_service_client: BlobServiceClient, container_name):
    blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")

    properties = blob_client.get_blob_properties()

    print(f"Blob type: {properties.blob_type}")
    print(f"Blob size: {properties.size}")
    print(f"Content type: {properties.content_settings.content_type}")
    print(f"Content language: {properties.content_settings.content_language}")

메타데이터 설정 및 검색

Blob 또는 컨테이너 리소스에 하나 이상의 이름-값 쌍으로 메타 데이터를 지정할 수 있습니다. 메타데이터를 설정하려면 다음 메서드를 사용하여 이름-값 쌍이 포함된 dictionary를 보냅니다.

BlobClient.set_blob_metadata

다음 코드 예제에서는 Blob에서 메타데이터를 설정합니다.

def set_metadata(self, blob_service_client: BlobServiceClient, container_name):
    blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")

    # Retrieve existing metadata, if desired
    blob_metadata = blob_client.get_blob_properties().metadata

    more_blob_metadata = {'docType': 'text', 'docCategory': 'reference'}
    blob_metadata.update(more_blob_metadata)

    # Set metadata on the blob
    blob_client.set_blob_metadata(metadata=blob_metadata)

메타데이터를 검색하려면 아래 예제에 나온 것처럼 Blob에서 get_blob_properties 메서드를 호출하여 메타데이터 컬렉션을 채운 다음, 값을 읽습니다. get_blob_properties 메서드는 Blob 속성 가져오기 작업과 Blob 메타데이터 가져오기 작업을 모두 호출하여 Blob 속성 및 메타데이터를 검색합니다.

다음 코드 예제에서는 Blob에서 메타데이터를 읽고 각 키/값 쌍을 인쇄합니다.

def get_metadata(self, blob_service_client: BlobServiceClient, container_name):
    blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")

    # Retrieve existing metadata, if desired
    blob_metadata = blob_client.get_blob_properties().metadata

    for k, v in blob_metadata.items():
        print(k, v)

비동기적으로 Blob 메타데이터 설정

Python용 Azure Blob Storage 클라이언트 라이브러리는 Blob 속성 및 메타데이터를 비동기적으로 관리할 수 있습니다. 프로젝트 설정 요구 사항에 대해 자세히 알아보려면 비동기 프로그래밍을 참조하세요.

비동기 API를 사용하여 Blob 메타데이터를 설정하려면 다음 단계를 수행합니다.

다음 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를 만든 다음, Blob 메타데이터를 설정하는 메서드를 호출합니다. 이 클라이언트에서 만들어진 다른 클라이언트는 동일한 연결 풀을 공유하기 때문에 최상위 클라이언트에서만 async with를 사용해야 합니다.
```
async def main():
    sample = BlobSamples()

    # 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.set_metadata(blob_service_client, "sample-container")

if __name__ == '__main__':
    asyncio.run(main())
```

Blob 메타데이터를 설정하는 코드를 추가합니다. 메서드가 async 키워드로 선언되고 get_blob_properties 및 set_blob_metadata 메서드를 호출할 때 await 키워드가 사용된다는 점을 제외하면 코드는 동기 예와 동일합니다.

async def set_metadata(self, blob_service_client: BlobServiceClient, container_name):
    blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")

    # Retrieve existing metadata, if desired
    properties = await blob_client.get_blob_properties()
    blob_metadata = properties.metadata

    more_blob_metadata = {'docType': 'text', 'docCategory': 'reference'}
    blob_metadata.update(more_blob_metadata)

    # Set metadata on the blob
    await blob_client.set_blob_metadata(metadata=blob_metadata)

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

리소스

Python용 Azure Blob Storage 클라이언트 라이브러리를 사용하여 시스템 속성 및 사용자 정의 메타데이터를 관리하는 방법에 대한 자세한 내용은 다음 리소스를 참조하세요.

코드 샘플

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

REST API 작업

Python용 Azure SDK에는 Azure REST API를 기반으로 빌드되는 라이브러리가 포함되어 있어 친숙한 Python 패러다임을 통해 REST API 작업과 상호 작용할 수 있습니다. 시스템 속성 및 사용자 정의 메타데이터를 관리하기 위한 클라이언트 라이브러리 메서드는 다음 REST API 작업을 사용합니다.

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

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

다음을 통해 공유

Python을 사용하여 Blob 속성 및 메타데이터 관리

필수 조건

환경 설정

패키지 설치

Import 문 추가

권한 부여

클라이언트 개체 만들기

속성 및 메타데이터 정보

속성 설정 및 검색

메타데이터 설정 및 검색

비동기적으로 Blob 메타데이터 설정

리소스

코드 샘플

REST API 작업

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

피드백

추가 리소스

다음을 통해 공유

Python을 사용하여 Blob 속성 및 메타데이터 관리

필수 조건

환경 설정

패키지 설치

Import 문 추가

권한 부여

클라이언트 개체 만들기

속성 및 메타데이터 정보

속성 설정 및 검색

메타데이터 설정 및 검색

비동기적으로 Blob 메타데이터 설정

리소스

코드 샘플

REST API 작업

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

관련 콘텐츠

피드백

추가 리소스