다음을 통해 공유

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

  • 아티클

Python용 Azure Queue Storage 클라이언트 라이브러리로 시작합니다. Azure Queue Storage는 나중에 검색하고 처리할 수 있도록 대량의 메시지를 저장하는 서비스입니다. 다음 단계에 따라 패키지를 설치하고 기본 작업에 대한 예제 코드를 사용해 보세요.

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

Python용 Azure Queue Storage 클라이언트 라이브러리를 사용하여 다음을 수행합니다.

  • 큐 만들기
  • 큐에 메시지 추가
  • 큐의 메시지 피킹(Peeking)
  • 큐의 메시지 업데이트
  • 큐 길이 가져오기
  • 큐에서 메시지 받기
  • 큐에서 메시지 삭제
  • 큐 삭제

필수 조건

설정

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

프로젝트 만들기

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

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

    mkdir queues-quickstart

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

    cd queues-quickstart

패키지 설치

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

pip install azure-storage-queue azure-identity

앱 프레임워크 설정

  1. 코드 편집기에서 새 텍스트 파일 열기

  2. import 문 추가

  3. 기본적인 예외 처리를 포함하여 프로그램의 구조 만들기

    코드는 다음과 같습니다.

    import os, uuid
from azure.identity import DefaultAzureCredential
from azure.storage.queue import QueueServiceClient, QueueClient, QueueMessage, BinaryBase64DecodePolicy, BinaryBase64EncodePolicy

try:
    print("Azure Queue storage - Python quickstart sample")
    # Quickstart code goes here
except Exception as ex:
    print('Exception:')
    print(ex)

  4. 새 파일을 queues-quickstart 디렉터리에 queues-quickstart.py로 저장합니다.

Azure에 대한 인증

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

암호, 연결 문자열 또는 기타 자격 증명을 사용하여 Azure 서비스에 대한 요청에 권한을 직접 부여할 수도 있습니다. 그러나 이 방법은 신중하게 사용해야 합니다. 개발자는 이러한 비밀을 안전하지 않은 위치에 노출하지 않도록 부지런해야 합니다. 암호 또는 비밀 키에 대한 액세스 권한을 얻는 사람은 누구나 인증할 수 있습니다. DefaultAzureCredential은 암호 없는 인증을 허용하기 위해 계정 키보다 향상된 관리 및 보안 이점을 제공합니다. 두 옵션 모두에 대해 다음 예에서 설명하고 있습니다.

DefaultAzureCredential 는 Python용 Azure ID 클라이언트 라이브러리에서 제공하는 클래스입니다. 자세한 DefaultAzureCredential내용은 DefaultAzureCredential 개요를 참조하세요. DefaultAzureCredential은 여러 인증 방법을 지원하고 런타임에 사용해야 하는 방법을 결정합니다. 이 방법을 사용하면 앱에서 환경별 코드를 구현하지 않고도 다양한 환경(로컬 및 프로덕션)에서 다양한 인증 방법을 사용할 수 있습니다.

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

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

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

다음 예제에서는 스토리지 계정의 큐 데이터에 대한 읽기 및 쓰기 권한을 모두 제공하는 스토리지 큐 데이터 기여자 역할을 사용자 계정에 할당합니다.

Important

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

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

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

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

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

A screenshot showing how to assign a role.

  1. 검색 상자를 사용하여 결과를 원하는 역할로 필터링합니다. 이 예에서는 스토리지 큐 데이터 기여자를 검색하고, 일치하는 결과를 선택한 후 다음을 선택합니다.

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

  3. 대화 상자에서 Microsoft Entra 사용자 이름(일반적으로 user@do기본 전자 메일 주소)을 검색한 다음 대화 상자 아래쪽에서 선택을 선택합니다.

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

개체 모델

Azure Queue Storage는 대량의 메시지를 저장하기 위한 서비스입니다. 큐 메시지의 크기는 최대 64KB입니다. 큐는 스토리지 계정의 용량 제한에 도달할 때까지 수백만 개의 메시지를 포함할 수 있습니다. 큐는 비동기적으로 처리할 작업의 백로그를 만드는 데 일반적으로 사용됩니다. Queue Storage는 다음 세 가지 유형의 리소스를 제공합니다.

  • Storage 계정: Azure Storage에 대한 모든 액세스는 Storage 계정을 통해 수행됩니다. 스토리지 계정에 대한 자세한 내용은 스토리지 계정 개요를 참조하세요.
  • 큐: 큐에는 메시지 집합이 포함됩니다. 모든 메시지는 큐에 있어야 합니다. 큐 이름은 모두 소문자여야 합니다. 큐 이름 지정에 대한 자세한 내용은 큐 및 메타데이터 명명을 참조하세요.
  • 메시지: 최대 64KB인 임의 형식의 메시지입니다. 메시지는 최대 7일 동안 큐에 남아 있을 수 있습니다. 2017-07-29 이상 버전에서 허용되는 최대 TTL(Time to Live)은 모든 양수 또는 메시지가 만료되지 않는 -1입니다. 이 매개 변수를 생략하면 기본 TTL(Time to Live)은 7일입니다.

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

Diagram of Queue storage architecture

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

  • QueueServiceClient: QueueServiceClient를 사용하면 스토리지 계정의 모든 큐를 관리할 수 있습니다.
  • QueueClient: QueueClient 클래스를 사용하면 개별 큐와 해당 메시지를 관리하고 조작할 수 있습니다.
  • QueueMessage: QueueMessage 클래스는 큐에서 receive_messages를 호출할 때 반환되는 개별 개체를 나타냅니다.

코드 예제

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

액세스 권한 부여 및 클라이언트 개체 만들기

역할을 할당한 것과 동일한 Microsoft Entra 계정으로 인증되었는지 확인합니다. Azure CLI, Visual Studio 코드 또는 Azure PowerShell을 통해 인증할 수 있습니다.

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

az login

인증되면 DefaultAzureCredential을 사용하여 스토리지 계정의 큐 데이터에 액세스하는 QueueClient 개체를 만들고 권한을 부여할 수 있습니다. DefaultAzureCredential 는 이전 단계에서 로그인한 계정을 자동으로 검색하고 사용합니다.

DefaultAzureCredential을 사용하여 권한을 부여하려면 패키지 설치에 설명된 대로 azure-identity 패키지를 추가했는지 확인합니다. 또한 queues-quickstart.py 파일에 다음 import 문을 추가해야 합니다.

from azure.identity import DefaultAzureCredential

큐 이름을 결정하고 DefaultAzureCredential을 권한 부여에 사용하여 QueueClient 클래스의 인스턴스를 만듭니다. 이 클라이언트 개체를 사용하여 스토리지 계정에서 큐 리소스를 만들고 상호 작용합니다.

Important

큐 이름은 소문자, 숫자 및 하이픈만 포함할 수 있으며 문자 또는 숫자로 시작해야 합니다. 각 하이픈의 앞과 뒤에는 하이픈이 아닌 문자가 있어야 합니다. 이름은 3자에서 63자 사이여야 합니다. 큐 이름 지정에 대한 자세한 내용은 큐 및 메타데이터 명명을 참조하세요.

try 블록 내에 다음 코드를 추가하고 <storage-account-name> 자리 표시자 값을 바꿔야 합니다.

    print("Azure Queue storage - Python quickstart sample")

    # Create a unique name for the queue
    queue_name = "quickstartqueues-" + str(uuid.uuid4())

    account_url = "https://<storageaccountname>.queue.core.windows.net"
    default_credential = DefaultAzureCredential()

    # Create the QueueClient object
    # We'll use this object to create and interact with the queue
    queue_client = QueueClient(account_url, queue_name=queue_name ,credential=default_credential)

큐 메시지는 텍스트로 저장됩니다. 이진 데이터를 저장하려면 메시지를 큐에 넣기 전에 Base64 인코딩 및 디코딩 함수를 설정합니다.

클라이언트 개체를 만들 때 Base64 인코딩 및 디코딩 함수를 구성할 수 있습니다.

# Setup Base64 encoding and decoding functions
base64_queue_client = QueueClient.from_connection_string(
                            conn_str=connect_str, queue_name=q_name,
                            message_encode_policy = BinaryBase64EncodePolicy(),
                            message_decode_policy = BinaryBase64DecodePolicy()
                        )

큐 만들기

QueueClient 개체를 사용하여 create_queue 메서드를 호출하고 스토리지 계정에 큐를 만듭니다.

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

    print("Creating queue: " + queue_name)

    # Create the queue
    queue_client.create_queue()

큐에 메시지 추가

다음 코드 조각은 send_message 메서드를 호출하여 큐에 메시지를 추가합니다. 또한 세 번째 send_message 호출에서 반환된 QueueMessage를 저장합니다. 프로그램 saved_message 뒷부분에서 메시지 콘텐츠를 업데이트하는 데 사용됩니다.

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

    print("\nAdding messages to the queue...")

    # Send several messages to the queue
    queue_client.send_message(u"First message")
    queue_client.send_message(u"Second message")
    saved_message = queue_client.send_message(u"Third message")

큐의 메시지 피킹(Peeking)

peek_messages 메서드를 호출하여 큐의 메시지를 피킹합니다. 이 메서드는 큐 앞에서 하나 이상의 메시지를 검색하지만 메시지의 표시 유형을 변경하지는 않습니다.

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

    print("\nPeek at the messages in the queue...")

    # Peek at messages in the queue
    peeked_messages = queue_client.peek_messages(max_messages=5)

    for peeked_message in peeked_messages:
        # Display the message
        print("Message: " + peeked_message.content)

큐의 메시지 업데이트

update_message 메서드를 호출하여 메시지 콘텐츠를 업데이트합니다. 이 메서드는 메시지의 표시 시간 제한 및 콘텐츠를 변경할 수 있습니다. 메시지 콘텐츠는 크기가 최대 64KB인 UTF-8 인코딩 문자열이어야 합니다. 새 콘텐츠와 함께 코드의 앞부분에서 저장한 메시지의 값을 전달합니다. 값은 saved_message 업데이트할 메시지를 식별합니다.

    print("\nUpdating the third message in the queue...")

    # Update a message using the message saved when calling send_message earlier
    queue_client.update_message(saved_message, pop_receipt=saved_message.pop_receipt, \
        content="Third message has been updated")

큐 길이 가져오기

큐에 있는 메시지의 추정된 개수를 가져올 수 있습니다.

get_queue_properties 메서드는 .approximate_message_count

properties = queue_client.get_queue_properties()
count = properties.approximate_message_count
print("Message count: " + str(count))

서비스가 요청에 응답한 후 메시지가 추가되거나 제거될 수 있으므로 이 결과는 근사치입니다.

큐에서 메시지 받기

receive_messages 메서드를 호출하여 이전에 추가한 메시지를 다운로드할 수 있습니다.

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

    print("\nReceiving messages from the queue...")

    # Get messages from the queue
    messages = queue_client.receive_messages(max_messages=5)

receive_messages 메서드를 호출할 때 필요에 따라 max_messages(큐에서 검색할 메시지 수)에 대한 값을 지정할 수 있습니다. 기본값은 1개 메시지이고 최댓값은 32개 메시지입니다. visibility_timeout(제한 시간 동안 다른 작업의 메시지 숨기기)에 대한 값을 지정할 수도 있습니다. 기본값은 30초입니다.

큐에서 메시지 삭제

메시지를 받아서 처리한 후 큐에서 메시지를 삭제합니다. 여기서는 콘솔에 메시지를 표시하는 것 외에는 다른 처리 작업이 없습니다.

앱은 메시지를 처리하고 삭제하기 전에 호출 input 하여 사용자 입력을 일시 중지합니다. Azure Portal에서 리소스가 삭제되기 전에 올바르게 만들어졌는지 확인합니다. 명시적으로 삭제되지 않은 메시지는 다시 처리할 수 있도록 큐에 다시 표시됩니다.

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

    print("\nPress Enter key to 'process' messages and delete them from the queue...")
    input()

    for msg_batch in messages.by_page():
            for msg in msg_batch:
                # "Process" the message
                print(msg.content)
                # Let the service know we're finished with
                # the message and it can be safely deleted.
                queue_client.delete_message(msg)

큐 삭제

다음 코드는 delete_queue 메서드를 사용하여 큐를 삭제하여 앱이 만든 리소스를 정리합니다.

블록의 try 끝에 이 코드를 추가하고 파일을 저장합니다.

    print("\nPress Enter key to delete the queue...")
    input()

    # Clean up
    print("Deleting queue...")
    queue_client.delete_queue()

    print("Done")

코드 실행

이 앱은 메시지 세 개를 만들어서 Azure 큐에 추가합니다. 이 코드는 큐의 메시지를 나열한 다음, 큐를 검색하고 삭제한 후 큐를 삭제합니다.

콘솔 창에서 queues-quickstart.py 파일이 포함된 디렉터리로 이동한 후 다음 python 명령을 실행하여 앱을 실행합니다.

python queues-quickstart.py

앱의 출력은 다음 예제와 유사합니다.

Azure Queue Storage client library - Python quickstart sample
Creating queue: quickstartqueues-<UUID>

Adding messages to the queue...

Peek at the messages in the queue...
Message: First message
Message: Second message
Message: Third message

Updating the third message in the queue...

Receiving messages from the queue...

Press Enter key to 'process' messages and delete them from the queue...

First message
Second message
Third message has been updated

Press Enter key to delete the queue...

Deleting queue...
Done

메시지를 받기 전에 앱이 일시 중지되면 Azure Portal에서 스토리지 계정을 검사. 메시지가 큐에 있는지 확인합니다.

Enter 키를 눌러서 메시지를 받고 삭제합니다. 메시지가 표시되면 Enter 키를 다시 눌러 대기열을 삭제하고 데모를 마칩니다.

다음 단계

이 빠른 시작에서는 Python 코드를 사용하여 큐를 만들고 메시지를 추가하는 방법을 알아보았습니다. 그런 다음, 메시지를 피킹하고 검색하고 삭제하는 방법을 알아보았습니다. 마지막으로 메시지 큐를 삭제하는 방법을 알아보았습니다.

자습서, 샘플, 빠른 시작 및 기타 설명서는 다음을 방문하세요.

Python 개발자용 Azure