Azure Queue Storage gebruiken vanuit Python

pip install azure-storage-queue

pip install azure-storage-queue==2.1.0

Met QueueClient het -object kunt u met een wachtrij werken. Voeg de volgende code toe boven aan een Python-bestand waarin u programmatisch toegang wilt krijgen tot een Azure-wachtrij:

from azure.storage.queue import (
        QueueClient,
        BinaryBase64EncodePolicy,
        BinaryBase64DecodePolicy
)

import os, uuid

Met QueueService het -object kunt u met wachtrijen werken. Met de volgende code maakt u een QueueService -object. Voeg de volgende code toe aan de bovenkant van een Python-bestand waarin u programmatisch toegang wilt krijgen tot Azure Storage:

from azure.storage.queue import (
        QueueService,
        QueueMessageFormat
)

import os, uuid

Met de volgende code maakt u QueueClient een -object met behulp van connection string.

# Retrieve the connection string from an environment
# variable named AZURE_STORAGE_CONNECTION_STRING
connect_str = os.getenv("AZURE_STORAGE_CONNECTION_STRING")

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

# Instantiate a QueueClient object which will
# be used to create and manipulate the queue
print("Creating queue: " + q_name)
queue_client = QueueClient.from_connection_string(connect_str, q_name)

# Create the queue
queue_client.create_queue()

Met de volgende code maakt u QueueService een -object met behulp van connection string.

# Retrieve the connection string from an environment
# variable named AZURE_STORAGE_CONNECTION_STRING
connect_str = os.getenv("AZURE_STORAGE_CONNECTION_STRING")

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

# Create a QueueService object which will
# be used to create and manipulate the queue
print("Creating queue: " + queue_name)
queue_service = QueueService(connection_string=connect_str)

# Create the queue
queue_service.create_queue(queue_name)

Configureer base64-coderings- en decodeerfuncties bij het maken van het clientobject.

# 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()
                        )

Configureer base64-coderings- en decodeerfuncties op het Queue Storage-object.

# Setup Base64 encoding and decoding functions
queue_service.encode_function = QueueMessageFormat.binary_base64encode
queue_service.decode_function = QueueMessageFormat.binary_base64decode

Als u een bericht in een wachtrij wilt invoegen, gebruikt u de send_message methode .

message = u"Hello World"
print("Adding message: " + message)
queue_client.send_message(message)

Als u een bericht in een wachtrij wilt invoegen, gebruikt u de methode om een nieuw bericht put_message te maken en toe te voegen aan de wachtrij.

message = u"Hello, World"
print("Adding message: " + message)
queue_service.put_message(queue_name, message)

U kunt berichten bekijken zonder ze uit de wachtrij te verwijderen door de methode aan te peek_messages roepen. Deze methode bekijkt standaard één bericht.

# Peek at the first message
messages = queue_client.peek_messages()

for peeked_message in messages:
    print("Peeked message: " + peeked_message.content)

U kunt berichten bekijken zonder ze uit de wachtrij te verwijderen door de methode aan te peek_messages roepen. Deze methode bekijkt standaard één bericht.

messages = queue_service.peek_messages(queue_name)

for peeked_message in messages:
    print("Peeked message: " + peeked_message.content)

De volgende code gebruikt de update_message methode om een bericht bij te werken. De time-out voor zichtbaarheid is ingesteld op 0, wat betekent dat het bericht onmiddellijk wordt weergegeven en de inhoud wordt bijgewerkt.

messages = queue_client.receive_messages()
list_result = next(messages)

message = queue_client.update_message(
        list_result.id, list_result.pop_receipt,
        visibility_timeout=0, content=u'Hello World Again')

print("Updated message to: " + message.content)

De volgende code gebruikt de update_message methode om een bericht bij te werken. De time-out voor zichtbaarheid is ingesteld op 0, wat betekent dat het bericht onmiddellijk wordt weergegeven en de inhoud wordt bijgewerkt.

messages = queue_service.get_messages(queue_name)

for message in messages:
    queue_service.update_message(
        queue_name, message.id, message.pop_receipt, 0, u"Hello, World Again")

De get_queue_properties retourneert wachtrijeigenschappen, waaronder approximate_message_count de .

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

De get_queue_metadata methode retourneert wachtrijeigenschappen, waaronder approximate_message_count .

metadata = queue_service.get_queue_metadata(queue_name)
count = metadata.approximate_message_count
print("Message count: " + str(count))

Wanneer u een receive_messages,krijgt u standaard het volgende bericht in de wachtrij. Een bericht dat wordt geretourneerd receive_messages door wordt onzichtbaar voor alle andere code die berichten uit deze wachtrij leest. Standaard blijft het bericht onzichtbaar gedurende 30 seconden. Als u het bericht uit de wachtrij wilt verwijderen, moet u ook delete_message.

messages = queue_client.receive_messages()

for message in messages:
    print("Dequeueing message: " + message.content)
    queue_client.delete_message(message.id, message.pop_receipt)

Wanneer u een get_messages,krijgt u standaard het volgende bericht in de wachtrij. Een bericht dat wordt geretourneerd get_messages door wordt onzichtbaar voor alle andere code die berichten uit deze wachtrij leest. Standaard blijft het bericht onzichtbaar gedurende 30 seconden. Als u het bericht uit de wachtrij wilt verwijderen, moet u ook delete_message.

messages = queue_service.get_messages(queue_name)

for message in messages:
    print("Deleting message: " + message.content)
    queue_service.delete_message(queue_name, message.id, message.pop_receipt)

In het volgende codevoorbeeld wordt de receive_messages methode gebruikt om berichten in batches op te halen. Vervolgens wordt elk bericht in elke batch verwerkt met behulp van een geneste for lus. De time-out voor onzichtbaarheid wordt ingesteld op vijf minuten voor elk bericht.

messages = queue_client.receive_messages(messages_per_page=5, visibility_timeout=5*60)

for msg_batch in messages.by_page():
   for msg in msg_batch:
      print("Batch dequeue message: " + msg.content)
      queue_client.delete_message(msg)

In het volgende codevoorbeeld wordt de get_messages methode gebruikt om 16 berichten in één aanroep op te halen. Vervolgens wordt elk bericht verwerkt met behulp van een for lus. De time-out voor onzichtbaarheid wordt ingesteld op vijf minuten voor elk bericht.

messages = queue_service.get_messages(queue_name, num_messages=16, visibility_timeout=5*60)

for message in messages:
    print("Deleting message: " + message.content)
    queue_service.delete_message(queue_name, message.id, message.pop_receipt)

Als u een wachtrij en alle berichten erin wilt verwijderen, roept u de methode delete_queue aan.

print("Deleting queue: " + queue_client.queue_name)
queue_client.delete_queue()

Als u een wachtrij en alle berichten erin wilt verwijderen, roept u de methode delete_queue aan.

print("Deleting queue: " + queue_name)
queue_service.delete_queue(queue_name)