Hızlı Başlangıç: Python için Azure Kuyruk Depolama istemci kitaplığı

Python için Azure Kuyruk Depolama istemci kitaplığını kullanmaya başlayın. Azure Kuyruk Depolama, daha sonra almak ve işlemek üzere çok sayıda iletiyi depolamaya yönelik bir hizmettir. Paketi yüklemek için bu adımları izleyin ve temel görevler için örnek kodu deneyin.

API başvuru belgeleri | Kitaplık kaynak kodu | Paketi (Python Paket Dizini)Örnekler |

Python için Azure Kuyruk Depolama istemci kitaplığını kullanarak:

• Kuyruk oluştur
• Kuyruğa ileti ekleme
• Kuyruktaki iletilere göz atma
• Kuyruktaki iletiyi güncelleştirme
• Kuyruk uzunluğu alma
• Kuyruktan ileti alma
• Kuyruktan iletileri silme
• Bir kuyruk silme

Önkoşullar

• Azure aboneliği - ücretsiz bir abonelik oluşturun
• Azure Depolama hesabı - depolama hesabı oluşturma
• Python 3.8+

Ayarlama

Bu bölüm, Python için Azure Kuyruk Depolama istemci kitaplığıyla çalışmak üzere bir proje hazırlama işleminde size yol gösterir.

Proje oluşturma

queues-quickstart adlı bir Python uygulaması oluşturun.

1. Konsol penceresinde (cmd, PowerShell veya Bash gibi) proje için yeni bir dizin oluşturun.

   mkdir queues-quickstart
   

2. Yeni oluşturulan queues-quickstart dizinine geçin.

   cd queues-quickstart
   

Paketleri yükleme

Proje dizininden komutunu kullanarak Python paketi için Azure Kuyruk Depolama istemci kitaplığını pip install yükleyin. Azure hizmetlerine parolasız bağlantılar için azure-identity paketi gereklidir.

pip install azure-storage-queue azure-identity

Uygulama çerçevesini ayarlama

1. Kod düzenleyicinizde yeni bir metin dosyası açma

2. Deyim ekleme import

3. Temel özel durum işleme dahil olmak üzere programın yapısını oluşturma

   Kod şu şekildedir:

   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. Yeni dosyayı queues-quickstart dizinine queues-quickstart.py olarak kaydedin.

Azure'da kimlik doğrulaması

Çoğu Azure hizmeti için uygulama istekleri yetkilendirilmelidir. DefaultAzureCredential Azure Identity istemci kitaplığı tarafından sağlanan sınıfı kullanmak, kodunuzda Azure hizmetlerine parolasız bağlantılar uygulamak için önerilen yaklaşımdır.

Ayrıca parolaları, bağlantı dizesi veya diğer kimlik bilgilerini kullanarak Azure hizmetlerine yönelik istekleri doğrudan yetkilendirilebilirsiniz. Ancak bu yaklaşım dikkatli kullanılmalıdır. Geliştiriciler bu gizli dizileri güvenli olmayan bir konumda asla açığa çıkarmamak için dikkatli olmalıdır. Parolaya veya gizli anahtara erişim kazanan herkes kimlik doğrulaması yapabilir. DefaultAzureCredential parolasız kimlik doğrulamasına izin vermek için hesap anahtarı üzerinde gelişmiş yönetim ve güvenlik avantajları sunar. Her iki seçenek de aşağıdaki örnekte gösterilmiştir.

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

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

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

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

setx AZURE_STORAGE_CONNECTION_STRING "<yourconnectionstring>"

export AZURE_STORAGE_CONNECTION_STRING="<yourconnectionstring>"

Nesne modeli

Azure Kuyruk Depolama, çok sayıda iletiyi depolamaya yönelik bir hizmettir. Kuyruk iletisinin boyutu en fazla 64 KB olabilir. Kuyruk, depolama hesabının toplam kapasite sınırına kadar milyonlarca ileti içerebilir. Kuyruklar genellikle zaman uyumsuz olarak işlenmek üzere bir iş kapsamı oluşturmak için kullanılır. Kuyruk Depolama üç tür kaynak sunar:

• Depolama hesabı: Azure Depolama tüm erişimi bir depolama hesabı üzerinden yapılır. Depolama hesapları hakkında daha fazla bilgi için bkz. Depolama hesaba genel bakış
• Kuyruk: Kuyrukta bir dizi ileti vardır. Tüm iletiler bir kuyrukta olmalıdır. Kuyruk adının tamamen küçük harfli olması gerektiğini unutmayın. Kuyrukların adlandırılması hakkında daha fazla bilgi için bkz. Kuyrukları ve Meta Verileri Adlandırma.
• İleti: İleti, biçimi ne olursa olsun en çok 64 KB büyüklüktedir. İleti en fazla 7 gün kuyrukta kalabilir. Sürüm 2017-07-29 veya üzeri için maksimum yaşam süresi herhangi bir pozitif sayı veya iletinin süresinin dolmadığını belirten -1 olabilir. Bu parametre atlanırsa, varsayılan yaşam süresi yedi gündür.

Aşağıdaki diyagramda bu kaynaklar arasındaki ilişki gösterilmektedir.

Bu kaynaklarla etkileşime geçmek için aşağıdaki Python sınıflarını kullanın:

• QueueServiceClient: depolama QueueServiceClient hesabınızdaki tüm kuyrukları yönetmenize olanak tanır.
• QueueClient: sınıfı, QueueClient tek bir kuyruğu ve iletilerini yönetmenize ve işlemenize olanak tanır.
• QueueMessage: sınıfı, QueueMessage bir kuyrukta çağrılırken receive_messages döndürülen tek tek nesneleri temsil eder.

Kod örnekleri

Bu örnek kod parçacıkları, Python için Azure Kuyruk Depolama istemci kitaplığıyla aşağıdaki eylemlerin nasıl yapılacağını gösterir:

• Erişimi yetkilendirme ve istemci nesnesi oluşturma
• Kuyruk oluşturma
• Kuyruğa ileti ekleme
• Kuyruktaki iletilere göz atma
• Kuyruktaki iletiyi güncelleştirme
• Kuyruk uzunluğunu alma
• Kuyruktan ileti alma
• Kuyruktan iletileri silme
• Kuyruk silme

az login

az login

Connect-AzAccount

from azure.identity import DefaultAzureCredential

    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)

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

    # 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 a unique name for the queue
    queue_name = "quickstartqueues-" + str(uuid.uuid4())

    print("Creating queue: " + queue_name)

    # Instantiate a QueueClient which will be
    # used to create and manipulate the queue
    queue_client = QueueClient.from_connection_string(connect_str, queue_name)

Kuyruk iletileri metin olarak depolanır. İkili verileri depolamak istiyorsanız, kuyruğa ileti yerleştirmeden önce Base64 kodlama ve kod çözme işlevlerini ayarlayın.

İstemci nesnesini oluştururken Base64 kodlama ve kod çözme işlevlerini yapılandırabilirsiniz:

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

Kuyruk oluştur

QueueClient nesnesini kullanarak, depolama hesabınızda kuyruk oluşturmak için yöntemini çağırıncreate_queue.

Bu kodu bloğun try sonuna ekleyin:

    print("Creating queue: " + queue_name)

    # Create the queue
    queue_client.create_queue()

Kuyruğa ileti ekleme

Aşağıdaki kod parçacığı yöntemini çağırarak send_message kuyruğa iletiler ekler. Ayrıca QueueMessage üçüncü send_message çağrıdan döndürülen kaydeder. saved_message, programın ilerleyen bölümlerinde ileti içeriğini güncelleştirmek için kullanılır.

Bu kodu bloğun try sonuna ekleyin:

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

Kuyruktaki iletilere göz atma

yöntemini çağırarak kuyruktaki iletilere peek_messages göz atın. Bu yöntem kuyruğun önünden bir veya daha fazla ileti alır, ancak iletinin görünürlüğünü değiştirmez.

Bu kodu bloğun try sonuna ekleyin:

    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)

Kuyruktaki iletiyi güncelleştirme

yöntemini çağırarak iletinin içeriğini güncelleştirin update_message . Bu yöntem, iletinin görünürlük zaman aşımını ve içeriğini değiştirebilir. İleti içeriğinin boyutu 64 KB'a kadar olan UTF-8 kodlanmış bir dize olmalıdır. Yeni içerikle birlikte, kodda daha önce kaydedilmiş olan iletideki değerleri de geçirin. saved_message Değerler, hangi iletinin güncelleştirilecek olduğunu belirler.

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

Kuyruk uzunluğu alma

Bir kuyruktaki ileti sayısı ile ilgili bir tahmin alabilirsiniz.

get_queue_properties yöntemi, dahil olmak üzere approximate_message_countkuyruk özelliklerini döndürür.

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

Hizmet isteğinize yanıt verdikten sonra iletiler eklenebileceği veya kaldırılabildiği için sonuç yaklaşık olarak elde edilir.

Kuyruktan ileti alma

Yöntemini çağırarak receive_messages daha önce eklenen iletileri indirebilirsiniz.

Bu kodu bloğun try sonuna ekleyin:

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

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

yöntemini çağırırken receive_messages isteğe bağlı olarak, kuyruktan alınacak ileti sayısı olan için max_messagesbir değer belirtebilirsiniz. Varsayılan değer 1 iletidir ve en fazla 32 iletidir. Ayrıca, zaman aşımı dönemi için visibility_timeoutdiğer işlemlerden gelen iletileri gizleyen bir değeri de belirtebilirsiniz. Varsayılan değer 30 saniyedir.

Kuyruktan iletileri silme

İletiler alındıktan ve işlendikten sonra kuyruktan silin. Bu durumda, işlem yalnızca konsolda iletiyi görüntüler.

Uygulama, iletileri işlemeden ve silmeden önce çağırarak input kullanıcı girişi için duraklatılır. Azure portalınızda kaynakların silinmeden önce doğru oluşturulduğunu doğrulayın. Açıkça silinmeyen tüm iletiler sonunda bunları işlemek için başka bir şans için kuyrukta yeniden görünür hale gelir.

Bu kodu bloğun try sonuna ekleyin:

    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)

Bir kuyruk silme

Aşağıdaki kod, yöntemini kullanarak delete_queue kuyruğu silerek uygulamanın oluşturduğu kaynakları temizler.

Bu kodu bloğun try sonuna ekleyin ve dosyayı kaydedin:

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

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

    print("Done")

Kodu çalıştırma

Bu uygulama bir Azure kuyruğuna üç ileti oluşturur ve ekler. Kod, kuyruktaki iletileri listeler, ardından kuyruğu silmeden önce alır ve siler.

Konsol pencerenizde, queues-quickstart.py dosyasını içeren dizine gidin ve uygulamayı çalıştırmak için aşağıdaki python komutu kullanın.

python queues-quickstart.py

Uygulamanın çıkışı aşağıdaki örneğe benzer:

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

Uygulama iletileri almadan önce duraklatıldığında Azure portalında depolama hesabınızı denetleyin. İletilerin kuyrukta olduğunu doğrulayın.

İletileri Enter almak ve silmek için tuşuna basın. İstendiğinde Enter , kuyruğu silmek ve tanıtımı tamamlamak için tuşuna yeniden basın.

Sonraki adımlar

Bu hızlı başlangıçta Python kodunu kullanarak kuyruk oluşturmayı ve ileti eklemeyi öğrendiniz. Ardından iletileri göz atıp almayı ve silmeyi öğrendiniz. Son olarak, ileti kuyruğu silmeyi öğrendinsiniz.

Öğreticiler, örnekler, hızlı başlangıçlar ve diğer belgeler için şu adresi ziyaret edin:

• Kullanım dışı bırakılan Python sürüm 2 SDK'larını kullanan ilgili kod örnekleri için bkz . Python sürüm 2'yi kullanan kod örnekleri.
• Daha fazla bilgi edinmek için bkz. Python için Azure Depolama kitaplıkları.
• Daha fazla Azure Kuyruk Depolama örnek uygulama için bkz. Python için Azure Kuyruk Depolama istemci kitaplığı - örnekler.