빠른 시작: Python용 클라이언트 라이브러리 Azure Blob Storage

Python용 Azure Blob Storage 클라이언트 라이브러리를 시작하여 Blob 및 컨테이너를 관리합니다. 다음 단계에 따라 패키지를 설치하고 대화형 콘솔 앱에서 기본 작업에 대한 예제 코드를 사용해 보세요.

API 참조 설명서 | 라이브러리 소스 코드 | 패키지(PyPi) | 샘플

사전 요구 사항

• 활성 구독이 있는 Azure 계정 - 무료로 계정 만들기
• Azure Storage 계정 - 스토리지 계정 만들기
• Python 3.6+

설치

이 섹션에서는 Python용 Azure Blob Storage 클라이언트 라이브러리를 사용하는 프로젝트를 준비합니다.

프로젝트 만들기

Blob-quickstart라는 Python 애플리케이션을 만듭니다.

1. 콘솔 창(예: PowerShell 또는 Bash)에서 프로젝트에 대한 새 디렉터리를 만듭니다.

   mkdir blob-quickstart
   

2. 새로 만든 Blob-quickstart 디렉터리로 전환합니다.

   cd blob-quickstart
   

패키지 설치

프로젝트 디렉터리에서 명령을 사용하여 pip install Azure Blob Storage 및 Azure Identity 클라이언트 라이브러리에 대한 패키지를 설치합니다. Azure 서비스에 암호 없이 연결하려면 azure-identity 패키지가 필요합니다.

pip install azure-storage-blob azure-identity

앱 프레임워크 설정

프로젝트 디렉터리에서 단계에 따라 앱의 기본 구조를 만듭니다.

1. 코드 편집기에서 새 텍스트 파일을 엽니다.
2. 아래와 같이 문을 추가하고 import , 프로그램의 구조를 만들고, 기본 예외 처리를 포함합니다.
3. 새 파일을 blob-quickstart 디렉터리에 blob-quickstart.py 저장합니다.

import os, uuid
from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient, BlobClient, ContainerClient

try:
    print("Azure Blob Storage Python quickstart sample")

    # Quickstart code goes here

except Exception as ex:
    print('Exception:')
    print(ex)

개체 모델

Azure Blob Storage는 대량의 비정형 데이터를 저장하는 데 최적화되어 있습니다. 비정형 데이터는 텍스트 또는 이진 데이터와 같은 특정 데이터 모델이나 정의를 따르지 않는 데이터입니다. Blob Storage는 다음 세 가지 유형의 리소스를 제공합니다.

• 스토리지 계정
• 스토리지 계정의 컨테이너
• 컨테이너의 blob

다음 다이어그램에서는 이러한 리소스 간의 관계를 보여줍니다.

다음 Python 클래스를 사용하여 이러한 리소스와 상호 작용합니다.

• BlobServiceClient: BlobServiceClient 클래스를 사용하여 Azure Storage 리소스 및 blob 컨테이너를 조작할 수 있습니다.
• ContainerClient: ContainerClient 클래스를 사용하여 Azure Storage 컨테이너 및 해당 blob을 조작할 수 있습니다.
• BlobClient: BlobClient 클래스를 사용하여 Azure Storage blob을 조작할 수 있습니다.

코드 예제

이러한 코드 조각 예제에서는 Python용 Azure Blob Storage 클라이언트 라이브러리를 사용하여 다음 작업을 수행하는 방법을 보여줍니다.

• Azure에 인증하고 Blob 데이터에 대한 액세스 권한 부여
• 컨테이너 만들기
• 컨테이너에 Blob 업로드
• 컨테이너의 Blob 나열
• Blob 다운로드
• 컨테이너 삭제

Azure에 인증하고 Blob 데이터에 대한 액세스 권한 부여

Azure Blob Storage에 대한 애플리케이션 요청에 대한 권한을 부여해야 합니다. DefaultAzureCredential Azure ID 클라이언트 라이브러리에서 제공하는 클래스를 사용하는 것이 Blob Storage를 비롯한 코드에서 Azure 서비스에 대한 암호 없는 연결을 구현하는 데 권장되는 방법입니다.

또한 계정 액세스 키를 사용하여 Azure Blob Storage 요청에 대한 권한을 부여할 수 있습니다. 그러나 이 방법은 신중하게 사용해야 합니다. 개발자는 액세스 키를 안전하지 않은 위치에 노출하지 않도록 끊임없이 노력해야 합니다. 액세스 키가 있는 사람은 누구나 스토리지 계정에 대한 요청에 권한을 부여할 수 있으며 모든 데이터에 효과적으로 액세스할 수 있습니다. DefaultAzureCredential은 암호 없는 인증을 허용하기 위해 계정 키보다 향상된 관리 및 보안 이점을 제공합니다. 두 옵션 모두에 대해 다음 예에서 설명하고 있습니다.

암호 없음(권장)

DefaultAzureCredential은 여러 인증 방법을 지원하고 런타임에 사용해야 하는 방법을 결정합니다. 이 방법을 사용하면 앱에서 환경별 코드를 구현하지 않고도 다양한 환경(로컬 및 프로덕션)에서 다양한 인증 방법을 사용할 수 있습니다.

DefaultAzureCredential에서 자격 증명을 찾는 순서와 위치는 Azure ID 라이브러리 개요에서 확인할 수 있습니다.

예를 들어 앱은 로컬로 개발할 때 와 함께 Azure CLI 로그인 자격 증명을 사용하여 인증할 수 있습니다. 그러면 앱이 Azure에 배포되면 관리 ID를 사용할 수 있습니다. 이 전환에서는 코드를 변경할 필요가 없습니다.

Azure AD 사용자 계정에 역할 할당

로컬로 개발하는 경우 Blob 데이터에 액세스하는 사용자 계정에 올바른 권한이 있는지 확인합니다. Blob 데이터를 읽고 쓰려면 Storage Blob 데이터 참가자가 필요합니다. 이 역할을 자신에게 할당하려면 사용자 액세스 관리자 역할 또는 Microsoft.Authorization/roleAssignments/write 작업을 포함하는 다른 역할이 필요합니다. Azure Portal, Azure CLI 또는 Azure PowerShell을 사용하여 사용자에게 Azure RBAC 역할을 할당할 수 있습니다. 범위 개요 페이지에서 역할 할당에 사용할 수 있는 범위에 대해 자세히 알아볼 수 있습니다.

이 시나리오에서는 최소 권한 원칙을 따르기 위해 범위가 스토리지 계정으로 지정된 사용자 계정에 권한을 할당합니다. 이 방법은 사용자에게 필요한 최소 권한만 부여하고 더 안전한 프로덕션 환경을 만듭니다.

다음 예제에서는 스토리지 계정의 Blob 데이터에 대한 읽기 및 쓰기 액세스를 모두 제공하는 Storage Blob 데이터 참가자 역할을 사용자 계정에 할당합니다.

중요

대부분의 경우 Azure에서 역할 할당이 전파되는 데 1~2분이 걸리지만 드문 경우이지만 최대 8분이 걸릴 수 있습니다. 코드를 처음 실행할 때 인증 오류가 발생하면 잠시 기다렸다가 다시 시도하세요.

Azure Portal

1. Azure Portal에서 기본 검색 창 또는 왼쪽 탐색 영역을 사용하여 스토리지 계정을 찾습니다.

2. 스토리지 계정 개요 페이지의 왼쪽 메뉴에서 액세스 제어(IAM)를 선택합니다.

3. 액세스 제어(IAM) 페이지에서 역할 할당 탭을 선택합니다.

4. 위쪽 메뉴에서 + 추가를 선택한 다음, 드롭다운 메뉴에서 역할 할당 추가를 선택합니다.

   

5. 검색 상자를 사용하여 결과를 원하는 역할로 필터링합니다. 이 예에서는 Storage Blob 데이터 기여자를 검색하고, 일치하는 결과를 선택하고, 다음을 선택합니다.

6. 다음에 대한 액세스 할당 아래에서 사용자, 그룹 또는 서비스 주체를 선택한 다음, + 멤버 선택을 선택합니다.

7. 대화 상자에서 Azure AD 사용자 이름(일반적으로 user@domain 이메일 주소)을 검색한 다음, 대화 상자 아래쪽에서 선택을 선택합니다.

8. 검토 + 할당을 선택하여 최종 페이지로 이동한 다음, 검토 + 할당을 다시 선택하여 프로세스를 완료합니다.

Azure CLI

Azure CLI를 사용하여 리소스 수준에서 역할을 할당하려면 먼저 az storage account show 명령을 사용하여 리소스 ID를 검색해야 합니다. --query 매개 변수를 사용하여 출력 속성을 필터링할 수 있습니다.

az storage account show --resource-group '<your-resource-group-name>' --name '<your-storage-account-name>' --query id

이전 명령의 Id 출력을 복사합니다. 그런 다음, Azure CLI의 az role 명령을 사용하여 역할을 할당할 수 있습니다.

az role assignment create --assignee "<user@domain>" \
    --role "Storage Blob Data Contributor" \
    --scope "<your-resource-id>"

PowerShell

Azure PowerShell을 사용하여 리소스 수준에서 역할을 할당하려면 먼저 Get-AzResource 명령을 사용하여 리소스 ID를 검색해야 합니다.

Get-AzResource -ResourceGroupName "<yourResourceGroupname>" -Name "<yourStorageAccountName>"

이전 명령 출력에서 Id 값을 복사합니다. 그런 다음, PowerShell에서 New-AzRoleAssignment 명령을 사용하여 역할을 할당할 수 있습니다.

New-AzRoleAssignment -SignInName <user@domain> `
    -RoleDefinitionName "Storage Blob Data Contributor" `
    -Scope <yourStorageAccountId>

DefaultAzureCredential을 사용하여 로그인하고 앱 코드를 Azure에 연결

다음 단계를 사용하여 스토리지 계정의 데이터에 대한 액세스 권한을 부여할 수 있습니다.

1. 스토리지 계정에서 역할을 할당한 것과 동일한 Azure AD 계정으로 인증되었는지 확인합니다. Azure CLI, Visual Studio Code 또는 Azure PowerShell 통해 인증할 수 있습니다.

   Azure CLI

   다음 명령을 사용하여 Azure CLI를 통해 Azure에 로그인합니다.

   az login
   

   Visual Studio Code

   Visual Studio Code 통해 작업 DefaultAzureCredential 하려면 Azure CLI를 설치해야 합니다.

   Visual Studio Code의 주 메뉴에서 터미널 > 새 터미널로 차례로 이동합니다.

   다음 명령을 사용하여 Azure CLI를 통해 Azure에 로그인합니다.

   az login
   

   PowerShell

   다음 명령을 통해 PowerShell을 사용하여 Azure에 로그인합니다.

   Connect-AzAccount
   

2. 를 사용 DefaultAzureCredential하려면 azure-identity 패키지가 설치되어 있고 클래스를 가져오는지 확인합니다.

   from azure.identity import DefaultAzureCredential
   

3. 블록 내에 이 코드를 추가합니다 try . 코드가 로컬 워크스테이션 DefaultAzureCredential 에서 실행되는 경우 은 로그인한 우선 순위가 지정된 도구의 개발자 자격 증명을 사용하여 Azure에 인증합니다. 이러한 도구의 예로는 Azure CLI 또는 Visual Studio Code 있습니다.

   account_url = "https://<storageaccountname>.blob.core.windows.net"
   default_credential = DefaultAzureCredential()
   
   # Create the BlobServiceClient object
   blob_service_client = BlobServiceClient(account_url, credential=default_credential)
   

4. 개체의 URI에서 스토리지 계정 이름을 업데이트해야 합니다 BlobServiceClient . 스토리지 계정 이름은 Azure Portal의 개요 페이지에서 찾을 수 있습니다.

   

   참고

   Azure에 배포하는 경우 이 동일한 코드를 사용하여 Azure에서 실행되는 애플리케이션에서 Azure Storage 요청에 대한 권한을 부여할 수 있습니다. 그러나 Azure의 앱에서 관리 ID를 사용하도록 설정해야 합니다. 그런 다음, 해당 관리 ID가 연결되도록 스토리지 계정을 구성합니다. 이 연결을 Azure 서비스 간에 구성하는 방법에 대한 자세한 지침은 Azure 호스팅 앱에서 인증 자습서를 참조하세요.

연결 문자열

연결 문자열에는 스토리지 계정 액세스 키가 포함되며, 이를 사용하여 요청에 대한 권한을 부여합니다. 키를 안전하지 않은 위치에 노출하지 않도록 항상 주의해야 합니다.

참고

스토리지 계정 액세스 키를 사용하여 데이터 액세스 권한을 부여하려면 다음 Azure RBAC 작업에 대한 권한이 필요합니다. Microsoft.Storage/storageAccounts/listkeys/action. 이 작업에 대한 권한이 있는 최소 권한 있는 기본 제공 역할은 읽기 권한자 및 데이터 액세스이지만 이 작업을 포함하는 모든 역할이 작동합니다.

Azure Portal

1. Azure Portal에 로그인합니다.

2. 스토리지 계정을 찾습니다.

3. 스토리지 계정 메뉴 창의 보안 + 네트워킹에서 액세스 키를 선택합니다. 여기에서 계정 액세스 키 및 각 키의 전체 연결 문자열을 볼 수 있습니다.

4. 액세스 키 창에서 키 표시를 선택합니다.

5. key1 섹션에서 연결 문자열 값을 찾습니다. 클립보드에 복사 아이콘을 선택하여 연결 문자열을 복사합니다. 다음 단계에서 연결 문자열 값을 환경 변수에 추가합니다.

   

Azure CLI

az storage account show-connection-string 명령을 사용하여 스토리지 계정에 대한 연결 문자열을 볼 수 있습니다.

az storage account show-connection-string --name "<your-storage-account-name>"

PowerShell

Get-AzStorageAccount 및 Get-AzStorageAccountKey 명령을 사용하여 PowerShell에서 연결 문자열을 어셈블할 수 있습니다.

$saName = "yourStorageAccountName"
$rgName = "yourResourceGroupName"
$sa = Get-AzStorageAccount -StorageAccountName $saName -ResourceGroupName $rgName

$saKey = (Get-AzStorageAccountKey -ResourceGroupName $rgName -Name $saName)[0].Value

'DefaultEndpointsProtocol=https;AccountName=' + $saName + ';AccountKey=' + $saKey + ';EndpointSuffix=core.windows.net'

스토리지 연결 문자열 구성

연결 문자열을 복사한 후 애플리케이션을 실행하는 로컬 컴퓨터의 새 환경 변수에 적습니다. 환경 변수를 설정하려면 콘솔 창을 열고 사용 중인 운영 체제의 지침을 따릅니다. <yourconnectionstring>을 실제 연결 문자열로 바꿉니다.

Windows:

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

Windows에서 환경 변수가 추가되면 명령 창의 새 인스턴스를 시작해야 합니다.

Linux:

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

아래 코드는 이전에 만든 환경 변수에서 스토리지 계정에 대한 연결 문자열을 검색하고 연결 문자열을 사용하여 서비스 클라이언트 개체를 생성합니다.

다음 코드를 try 블록 내에 추가합니다.

# Retrieve the connection string for use with the application. The storage
# connection string is stored in an environment variable on the machine
# running the application called AZURE_STORAGE_CONNECTION_STRING. If the environment variable is
# created after the application is launched in a console or with Visual Studio,
# the shell or application needs to be closed and reloaded to take the
# environment variable into account.
connect_str = os.getenv('AZURE_STORAGE_CONNECTION_STRING')

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient.from_connection_string(connect_str)

중요

계정 액세스 키는 신중하게 사용해야 합니다. 계정 액세스 키가 손실하거나 실수로 안전하지 않은 위치에 배치되는 경우 서비스가 취약해질 수 있습니다. 액세스 키가 있는 사람은 누구나 스토리지 계정에 대한 요청에 권한을 부여할 수 있으며 모든 데이터에 효과적으로 액세스할 수 있습니다. DefaultAzureCredential은 향상된 보안 기능과 이점을 제공하며 Azure 서비스에 대한 권한 부여를 관리하는 데 권장되는 방법입니다.

컨테이너 만들기

새 컨테이너의 이름을 결정합니다. 아래 코드는 컨테이너 이름이 고유해질 수 있도록 이름에 UUID 값을 추가합니다.

중요

컨테이너 이름은 소문자여야 합니다. 컨테이너 및 Blob 이름 지정에 대한 자세한 내용은 컨테이너, Blob, 메타데이터 이름 지정 및 참조를 참조하세요.

create_container 메서드를 호출하여 스토리지 계정에 컨테이너를 실제로 만듭니다.

이 코드를 try 블록의 끝에 추가합니다.

# Create a unique name for the container
container_name = str(uuid.uuid4())

# Create the container
container_client = blob_service_client.create_container(container_name)

컨테이너를 만드는 방법에 대해 자세히 알아보고 더 많은 코드 샘플을 살펴보려면 Python을 사용하여 Blob 컨테이너 만들기를 참조하세요.

컨테이너에 Blob 업로드

다음 코드 조각을 실행합니다.

1. 데이터 파일을 저장할 로컬 디렉터리를 만듭니다.
2. 로컬 디렉터리에 텍스트 파일을 만듭니다.
3. 컨테이너 만들기 섹션에서 BlobServiceClient에 대해 get_blob_client 메서드를 호출하여 BlobClient 개체에 대한 참조를 가져옵니다.
4. upload_blob 메서드를 호출하여 로컬 텍스트 파일을 Blob에 업로드합니다.

이 코드를 try 블록의 끝에 추가합니다.

# Create a local directory to hold blob data
local_path = "./data"
os.mkdir(local_path)

# Create a file in the local data directory to upload and download
local_file_name = str(uuid.uuid4()) + ".txt"
upload_file_path = os.path.join(local_path, local_file_name)

# Write text to the file
file = open(file=upload_file_path, mode='w')
file.write("Hello, World!")
file.close()

# Create a blob client using the local file name as the name for the blob
blob_client = blob_service_client.get_blob_client(container=container_name, blob=local_file_name)

print("\nUploading to Azure Storage as blob:\n\t" + local_file_name)

# Upload the created file
with open(file=upload_file_path, mode="rb") as data:
    blob_client.upload_blob(data)

Blob 업로드에 대해 자세히 알아보고 더 많은 코드 샘플을 살펴보려면 Python을 사용하여 Blob 업로드를 참조하세요.

컨테이너의 Blob 나열

list_blobs 메서드를 호출하여 컨테이너의 blob을 나열합니다. 이 경우 하나의 Blob만 컨테이너에 추가되었으므로 나열된 작업은 하나의 해당 Blob만 반환합니다.

이 코드를 try 블록의 끝에 추가합니다.

print("\nListing blobs...")

# List the blobs in the container
blob_list = container_client.list_blobs()
for blob in blob_list:
    print("\t" + blob.name)

Blob을 나열하고 더 많은 코드 샘플을 탐색하는 방법에 대한 자세한 내용은 Python을 사용하여 Blob 나열을 참조하세요.

Blob 다운로드

download_blob 메서드를 호출하여 이전에 만든 blob을 다운로드합니다. 예제 코드는 로컬 파일 시스템에서 두 파일을 볼 수 있도록 파일 이름에 "DOWNLOAD" 접미사를 추가합니다.

이 코드를 try 블록의 끝에 추가합니다.

# Download the blob to a local file
# Add 'DOWNLOAD' before the .txt extension so you can see both files in the data directory
download_file_path = os.path.join(local_path, str.replace(local_file_name ,'.txt', 'DOWNLOAD.txt'))
container_client = blob_service_client.get_container_client(container= container_name) 
print("\nDownloading blob to \n\t" + download_file_path)

with open(file=download_file_path, mode="wb") as download_file:
 download_file.write(container_client.download_blob(blob.name).readall())

Blob 다운로드에 대해 자세히 알아보고 더 많은 코드 샘플을 살펴보려면 Python을 사용하여 Blob 다운로드를 참조하세요.

컨테이너 삭제

다음 코드는 delete_container 메서드로 전체 컨테이너를 제거하여 앱이 만든 리소스를 정리합니다. 원하는 경우 로컬 파일을 삭제할 수도 있습니다.

앱은 blob, 컨테이너 및 로컬 파일을 삭제하기 전에 input()을 호출하여 사용자 입력을 일시 중지합니다. 리소스가 삭제되기 전에 올바르게 만들어졌는지 확인합니다.

이 코드를 try 블록의 끝에 추가합니다.

# Clean up
print("\nPress the Enter key to begin clean up")
input()

print("Deleting blob container...")
container_client.delete_container()

print("Deleting the local source and downloaded files...")
os.remove(upload_file_path)
os.remove(download_file_path)
os.rmdir(local_path)

print("Done")

컨테이너 삭제에 대해 자세히 알아보고 더 많은 코드 샘플을 살펴보려면 Python을 사용하여 Blob 컨테이너 삭제 및 복원을 참조하세요.

코드 실행

이 앱은 로컬 폴더에 테스트 파일을 만들고 Azure Blob Storage에 업로드합니다. 그런 다음, 예제에서 컨테이너의 Blob을 나열하고 새 이름으로 파일을 다운로드합니다. 이전 파일과 새 파일을 비교할 수 있습니다.

blob-quickstart.py 파일이 포함된 디렉터리로 이동한 다음, 다음 python 명령을 실행하여 앱을 실행합니다.

python blob-quickstart.py

앱의 출력은 다음 예제와 유사합니다(가독성을 위해 생략된 UUID 값).

Azure Blob Storage Python quickstart sample

Uploading to Azure Storage as blob:
        quickstartUUID.txt

Listing blobs...
        quickstartUUID.txt

Downloading blob to
        ./data/quickstartUUIDDOWNLOAD.txt

Press the Enter key to begin clean up

Deleting blob container...
Deleting the local source and downloaded files...
Done

정리 프로세스를 시작하기 전에 data 폴더에서 두 파일을 확인합니다. 비교하고 동일한지 확인할 수 있습니다.

리소스 정리

파일을 확인하고 테스트를 완료한 후 Enter 키를 눌러 스토리지 계정에서 만든 컨테이너와 함께 테스트 파일을 삭제합니다. Azure CLI를 사용하여 리소스를 삭제할 수도 있습니다.

다음 단계

이 빠른 시작에서는 Python을 사용하여 Blob을 업로드, 다운로드 및 나열하는 방법을 배웠습니다.

Blob 스토리지 샘플 앱을 보려면 다음을 계속 진행합니다.

Python 샘플용 Azure Blob Storage 라이브러리

• 자세한 내용은 Python용 Azure Blob Storage 클라이언트 라이브러리를 참조하세요.
• 자습서, 샘플, 빠른 시작 및 기타 설명서는 Python 개발자용 Azure를 참조하세요.