次の方法で共有

クイックスタート: Python 用 Azure Queue Storage クライアント ライブラリ

  • [アーティクル]

Python 用 Azure Queue Storage クライアント ライブラリを使用してみましょう。 Azure Queue Storage は、後で取得して処理するために多数のメッセージを格納するためのサービスです。 以下の手順に従って、パッケージをインストールし、基本タスクのコード例を試してみましょう。

API のリファレンスのドキュメント | ライブラリのソース コード | パッケージ (Python Package Index) | サンプル

Python 用 Azure Queue Storage クライアント ライブラリを使用すると、以下のことができます。

  • キューを作成する
  • メッセージをキューに追加する
  • キュー内のメッセージを表示する
  • キュー内のメッセージを更新する
  • キューの長さを取得する
  • キューからメッセージを受信する
  • キューからメッセージを削除する
  • キューを削除する

前提条件

設定

このセクションでは、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-identity パッケージが必要です。

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.py として queues-quickstart ディレクトリに保存します。

Azure に対して認証します

ほとんどの Azure サービスに対するアプリケーション要求は、認可される必要があります。 コード内の Azure サービスに対してパスワードレス接続を実装するには、Azure ID クライアント ライブラリによって提供される DefaultAzureCredential クラスを使用する方法お勧めします。

パスワード、接続文字列、その他の資格情報を使用して、Azure サービスへの要求を直接承認することもできます。 ただし、この方法は慎重に使用する必要があります。 開発者は、安全でない場所にこれらのシークレットを公開しないように注意する必要があります。 パスワードまたはシークレット キーへのアクセス権を取得したユーザーは、誰でも認証を受けることができます。 DefaultAzureCredential はアカウント・キーよりも管理しやすく、セキュリティが優れており、パスワードレス認証が可能になります。 両方のオプションの例を次に示します。

DefaultAzureCredential は、Python 用 Azure ID クライアント ライブラリによって提供されるクラスです。 DefaultAzureCredential の詳細については、DefaultAzureCredential の概要を参照してください。 DefaultAzureCredential は複数の認証方法をサポートしており、実行時に使用する方法が決定されます。 このアプローチを採用すると、環境固有のコードを実装することなく、異なる環境 (ローカルと運用環境) で異なる認証方法をアプリに使用できます。

たとえば、ローカルでの開発時には Visual Studio Code サインイン資格情報を使用してアプリを認証し、それが Azure にデプロイされたらマネージド ID を使用できます。 この移行のためにコードを変更する必要はありません。

ローカルで開発する場合は、キュー データにアクセスするユーザー アカウントに正しいアクセス許可があることを確認します。 キュー データの読み取りと書き込みを行うには、ストレージ キュー データ共同作成者が必要です。 このロールを自分に割り当てるには、ユーザー アクセス管理者ロール、または Microsoft.Authorization/roleAssignments/write アクションを含む別のロールに割り当てられている必要があります。 Azure portal、Azure CLI、または Azure PowerShell を使用して、ユーザーに Azure RBAC ロールを割り当てることができます。 ロールの割り当てに使用できるスコープの詳細は、スコープの概要ページでご覧いただけます。

このシナリオでは、最小限の特権の原則に従って、ストレージ アカウントに限定したアクセス許可をユーザー アカウントに割り当てます。 この方法を使って、ユーザーに必要最小限のアクセス許可のみを与え、より安全な運用環境を作成します。

次の例では、ストレージ キュー データ共同作成者ロールを自分のユーザー アカウントに割り当てます。これにより、そのストレージ アカウント内のキュー データに対する読み取りと書き込みの両方のアクセス権が付与されます。

重要

ほとんどの場合、ロールの割り当てが 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@domain メール アドレス) を検索し、ダイアログの下部にある [選択] を選びます。

  4. [レビューと割り当て] を選んで最終ページに移動し、もう一度 [レビューと割り当て] を行ってプロセスを完了します。

オブジェクト モデル

Azure Queue storage は、多数のメッセージを格納するためのサービスです。 キュー メッセージの許容される最大サイズは 64 KB です。 キューには、ストレージ アカウントの総容量の上限を超えない限り、数百万のメッセージを含めることができます。 キューは通常、非同期的な処理用に作業のバックログを作成するために使用されます。 Queue Storage には、次の 3 種類のリソースがあります。

  • ストレージ アカウント: Azure Storage にアクセスするときは必ずストレージ アカウントを使用します。 ストレージ アカウントの詳細については、「ストレージ アカウントの概要」を参照してください
  • キュー: キューは、メッセージのセットを格納します。 すべてのメッセージはキューに 格納されている必要があります。 キュー名は小文字で入力する必要があります。 キューの名前付け規則については、「 Naming Queues and Metadata (キューとメタデータの名前付け規則)」を参照してください。
  • メッセージ: 形式を問わず、メッセージのサイズは最大で 64 KB です。 メッセージは最大 7 日間キューに残ることができます。 バージョン 2017-07-29 以降では、最大有効期間を任意の正の数にすることができます。また、-1 は、メッセージが期限切れにならないことを示します。 このパラメーターを省略すると、既定の有効期間は 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 Code、または Azure PowerShell を使って認証することができます。

Azure CLI で次のコマンドを使って Azure にサインインします。

az login

認証が完了したら、DefaultAzureCredential を使って、ストレージ アカウント内のキュー データにアクセスする QueueClient オブジェクトを作成および認可できます。 DefaultAzureCredential は、前の手順でサインインしたアカウントを自動的に検出して使用します。

DefaultAzureCredential を使用して承認するには、「パッケージをインストールする」の説明に従って、azure-identity パッケージを追加していることを確認します。 また、queues-quickstart.py ファイルに次の import ステートメントを追加してください。

from azure.identity import DefaultAzureCredential

キューの名前を決定し、認証に DefaultAzureCredential を使用して、QueueClient クラスのインスタンスを作成します。 このクライアント オブジェクトを使って、ストレージ アカウント内のキュー リソースを作成して操作します。

重要

キュー名に使用できるのは小文字、数字、ハイフンのみであり、名前の先頭は文字または数字にする必要があります。 各ハイフンの前後にはハイフン以外の文字を指定する必要があります。 また、名前は 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 メソッドを呼び出してキューにメッセージを追加します。 また、3 番目の 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")

キュー内のメッセージを表示する

キュー内のメッセージをクイック表示するには、peek_messages メソッドを呼び出します。 このメソッドは、キューの先頭からメッセージを 1 つ以上取得しますが、メッセージの可視性は変更しません。

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 メソッドを呼び出します。 メッセージの表示タイムアウトと内容は、このメソッドで変更できます。 メッセージの内容には UTF-8 でエンコードされた文字列を指定してください。最大サイズは 64 KB です。 先ほどこのコードの中で保存したメッセージの値を、新しい内容と共に渡します。 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")

コードの実行

このアプリは、3 つのメッセージを作成して 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