Så här använder du Azure Queue Storage från Python

pip install azure-storage-queue

pip install azure-storage-queue==2.1.0

Med QueueClient -objektet kan du arbeta med en kö. Lägg till följande kod längst upp i en Python-fil där du vill komma åt en Azure-kö programmatiskt:

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

import os, uuid

Med QueueService -objektet kan du arbeta med köer. Följande kod skapar ett QueueService -objekt. Lägg till följande kod längst upp i en Python-fil där du vill komma åt Azure Storage:

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

import os, uuid

Följande kod skapar ett -objekt QueueClient med lagringsanslutningssträngen.

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

Följande kod skapar ett -objekt QueueService med lagringsanslutningssträngen.

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

Konfigurera Base64-kodning och avkodningsfunktioner när du skapar klientobjektet.

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

Konfigurera Base64-kodning och avkodningsfunktioner i Queue Storage objekt.

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

Om du vill infoga ett meddelande i en kö använder du send_message metoden .

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

Om du vill infoga ett meddelande i en kö använder du put_message metoden för att skapa ett nytt meddelande och lägga till det i kön.

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

Du kan granska meddelanden utan att ta bort dem från kön genom att anropa peek_messages metoden . Som standard granskar den här metoden ett enda meddelande.

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

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

Du kan granska meddelanden utan att ta bort dem från kön genom att anropa peek_messages metoden . Som standard granskar den här metoden ett enda meddelande.

messages = queue_service.peek_messages(queue_name)

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

Följande kod använder metoden update_message för att uppdatera ett meddelande. Tidsgränsen för synlighet är inställd på 0, vilket innebär att meddelandet visas omedelbart och innehållet uppdateras.

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)

Följande kod använder metoden update_message för att uppdatera ett meddelande. Tidsgränsen för synlighet är inställd på 0, vilket innebär att meddelandet visas omedelbart och innehållet uppdateras.

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")

Metoden get_queue_properties returnerar köegenskaper inklusive approximate_message_count .

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

Metoden get_queue_metadata returnerar köegenskaper inklusive approximate_message_count .

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

När du anropar receive_messagesfår du nästa meddelande i kön som standard. Ett meddelande som returneras receive_messages från blir osynligt för andra kodläsningsmeddelanden från den här kön. Som standard är det här meddelandet osynligt i 30 sekunder. För att slutföra borttagningen av meddelandet från kön måste du även anropa 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)

När du anropar get_messagesfår du nästa meddelande i kön som standard. Ett meddelande som returneras get_messages från blir osynligt för andra kodläsningsmeddelanden från den här kön. Som standard är det här meddelandet osynligt i 30 sekunder. För att slutföra borttagningen av meddelandet från kön måste du även anropa 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)

I följande kodexempel används metoden receive_messages för att hämta meddelanden i batchar. Sedan bearbetar den varje meddelande i varje batch med hjälp av en kapslad for loop. Koden ställer också in tidsgränsen för osynlighet till fem minuter för varje meddelande.

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)

I följande kodexempel används metoden get_messages för att hämta 16 meddelanden i ett anrop. Sedan bearbetar den varje meddelande med hjälp av en for loop. Koden ställer också in tidsgränsen för osynlighet till fem minuter för varje meddelande.

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)

Om du vill ta bort en kö och alla meddelanden som finns i den anropar du delete_queue metoden .

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

Om du vill ta bort en kö och alla meddelanden som finns i den anropar du delete_queue metoden .

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