QueueClient Sınıf

Belirtilen kuyruktan tüm iletileri siler.

clear_messages(**kwargs: Any) -> None

Parametreler

Örnekler

Tüm iletileri temizler.

   queue.clear_messages()

Bu yöntem, istemci tarafından açılan yuvaları kapatmaktır. Bağlam yöneticisi ile kullanılırken kullanılması gerekmez.

close()

Depolama hesabında yeni bir kuyruk oluşturur.

Aynı ada sahip bir kuyruk zaten varsa, işlem ResourceExistsError ile başarısız olur.

create_queue(*, metadata: Dict[str, str] | None = None, **kwargs: Any) -> None

Parametreler

Döndürülenler

Hiçbiri veya cls(yanıt) sonucu

Dönüş türü

Özel durumlar

Örnekler

Kuyruk oluşturun.

   queue.create_queue()

Belirtilen iletiyi siler.

Normalde, bir istemci alma iletileri işlemiyle bir ileti aldıktan sonra, istemcinin iletiyi işlemesi ve silmesi beklenir. İletiyi silmek için ileti nesnesinin kendisine veya iki veri öğesine sahip olmanız gerekir: id ve pop_receipt. Kimlik önceki receive_messages işleminden döndürülür. pop_receipt en son receive_messages veya update_message işlemden döndürülür. delete_message işleminin başarılı olması için istekte belirtilen pop_receipt veya update_message işleminden receive_messages döndürülen pop_receipt eşleşmesi gerekir.

delete_message(message: str | QueueMessage, pop_receipt: str | None = None, **kwargs: Any) -> None

Parametreler

Örnekler

İletiyi silme.

   # Get the message at the front of the queue
   msg = next(queue.receive_messages())

   # Delete the specified message
   queue.delete_message(msg)

Belirtilen kuyruğu ve içerdiği tüm iletileri siler.

Bir kuyruk başarıyla silindiğinde, silinmek üzere hemen işaretlenir ve artık istemciler tarafından erişilemez. Kuyruk daha sonra çöp toplama sırasında Kuyruk hizmetinden kaldırılır.

Bir kuyruğu silme işleminin tamamlanmasının en az 40 saniye süreceğini unutmayın. Bir işlem silinirken kuyruğa karşı denenirse, bir <xref:azure.storage.queue.HttpResponseError> oluşturulur.

delete_queue(**kwargs: Any) -> None

Parametreler

Dönüş türü

Örnekler

Kuyruğu silme.

   queue.delete_queue()

Bağlantı Dizesinden QueueClient oluşturun.

from_connection_string(conn_str: str, queue_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametreler

Döndürülenler

Kuyruk istemcisi.

Dönüş türü

Örnekler

bağlantı dizesi'dan kuyruk istemcisini oluşturun.

   from azure.storage.queue import QueueClient
   queue = QueueClient.from_connection_string(self.connection_string, "myqueue1")

Belirli bir Kuyrukla etkileşime geçmek için bir istemci.

from_queue_url(queue_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametreler

Döndürülenler

Kuyruk istemcisi.

Dönüş türü

Kuyrukta belirtilen ve Paylaşılan Erişim İmzaları ile kullanılabilecek tüm saklı erişim ilkeleriyle ilgili ayrıntıları döndürür.

get_queue_access_policy(**kwargs: Any) -> Dict[str, AccessPolicy]

Parametreler

Döndürülenler

Kuyrukla ilişkili erişim ilkeleri sözlüğü.

Dönüş türü

Belirtilen kuyruk için kullanıcı tanımlı tüm meta verileri döndürür.

Döndürülen veriler kuyruğun ileti listesini içermez.

get_queue_properties(**kwargs: Any) -> QueueProperties

Parametreler

Döndürülenler

Kuyruk için kullanıcı tanımlı meta veriler.

Dönüş türü

Örnekler

Kuyrukta özellikleri alın.

   properties = queue.get_queue_properties().metadata

Kuyruğun önünden bir veya daha fazla ileti alır, ancak iletinin görünürlüğünü değiştirmez.

Yalnızca görünen iletiler alınabilir. çağrısıyla receive_messagesbir ileti ilk kez alındığında, dequeue_count özelliği 1 olarak ayarlanır. Silinmez ve daha sonra yeniden alınırsa, dequeue_count özelliği artırılır. İstemci, bir iletinin kaç kez alındığını belirlemek için bu değeri kullanabilir. peek_messages çağrısının dequeue_count değerini artırmadığını, ancak istemcinin okuması için bu değeri döndürdüğünü unutmayın.

Yerel hizmet nesnesinde anahtar-şifreleme-anahtarı veya çözümleyici alanı ayarlanırsa, iletilerin şifresi döndürülmeden önce çözülür.

peek_messages(max_messages: int | None = None, **kwargs: Any) -> List[QueueMessage]

Parametreler

Döndürülenler

Nesnelerin listesi QueueMessage . next_visible_on ve pop_receipt doldurulmayacağını unutmayın çünkü göz atma işlemi iletiyi açmaz ve yalnızca önceden görünen iletileri alabilir.

Dönüş türü

Örnekler

İletileri Gözatma.

   # Peek at one message at the front of the queue
   msg = queue.peek_messages()

   # Peek at the last 5 messages
   messages = queue.peek_messages(max_messages=5)

   # Print the last 5 messages
   for message in messages:
       print(message.content)

Kuyruğun önünden bir iletiyi kaldırır.

İleti kuyruktan alındığında, yanıt ileti içeriğini ve iletiyi silmek için gereken bir pop_receipt değeri içerir. İleti kuyruktan otomatik olarak silinmez, ancak alındıktan sonra, visibility_timeout parametresi tarafından belirtilen zaman aralığı için diğer istemciler tarafından görünmez.

Anahtar-şifreleme-anahtarı veya çözümleyici alanı yerel hizmet nesnesinde ayarlanırsa, ileti döndürülmeden önce şifresi çözülür.

receive_message(*, visibility_timeout: int | None = None, **kwargs: Any) -> QueueMessage | None

Parametreler

Döndürülenler

Kuyruk boşsa Kuyruk'tan veya Hiçbiri'nden bir ileti döndürür.

Dönüş türü

Örnekler

Kuyruktan bir ileti alın.

   # Pop two messages from the front of the queue
   message1 = queue.receive_message()
   message2 = queue.receive_message()
   # We should see message 3 if we peek
   message3 = queue.peek_messages()[0]

   if not message1 or not message2 or not message3:
       raise ValueError("One of the messages are None.")

   print(message1.content)
   print(message2.content)
   print(message3.content)

Kuyruğun önünden bir veya daha fazla iletiyi kaldırır.

Kuyruktan bir ileti alındığında, yanıt ileti içeriğini ve iletiyi silmek için gereken bir pop_receipt değeri içerir. İleti kuyruktan otomatik olarak silinmez, ancak alındıktan sonra, visibility_timeout parametresi tarafından belirtilen zaman aralığı için diğer istemciler tarafından görünmez. Yineleyici, kuyruk boş olana veya max_messages ulaşılana kadar (max_messages ayarlandıysa) iletileri sürekli olarak getirir.

Yerel hizmet nesnesinde anahtar-şifreleme-anahtarı veya çözümleyici alanı ayarlanırsa, iletilerin şifresi döndürülmeden önce çözülür.

receive_messages(*, messages_per_page: int | None = None, visibility_timeout: int | None = None, max_messages: int | None = None, **kwargs: Any) -> ItemPaged[QueueMessage]

Parametreler

Döndürülenler

Dikte benzeri İleti nesnelerinin ileti yineleyicisini döndürür.

Dönüş türü

Örnekler

Kuyruktan ileti alma.

   # Receive messages one-by-one
   messages = queue.receive_messages()
   for msg in messages:
       print(msg.content)

   # Receive messages by batch
   messages = queue.receive_messages(messages_per_page=5)
   for msg_batch in messages.by_page():
       for msg in msg_batch:
           print(msg.content)
           queue.delete_message(msg)

İleti kuyruğunun arkasına yeni bir ileti ekler.

Görünürlük zaman aşımı, iletinin görünmez olacağı zamanı belirtir. Zaman aşımı süresi dolduktan sonra ileti görünür hale gelir. Görünürlük zaman aşımı belirtilmezse varsayılan 0 değeri kullanılır.

İletinin yaşam süresi, bir iletinin kuyrukta ne kadar süreyle kalacağını belirtir. Yaşam süresi dolduğunda ileti kuyruktan silinir.

Key-encryption-key alanı yerel hizmet nesnesinde ayarlandıysa, bu yöntem karşıya yüklemeden önce içeriği şifreler.

send_message(content: object | None, *, visibility_timeout: int | None = None, time_to_live: int | None = None, **kwargs: Any) -> QueueMessage

Parametreler

Döndürülenler

Bir QueueMessage nesnesi. Bu nesne, hizmetten döndürülmese de içerikle de doldurulur.

Dönüş türü

Örnekler

İleti gönderme.

   queue.send_message("message1")
   queue.send_message("message2", visibility_timeout=30)  # wait 30s before becoming visible
   queue.send_message("message3")
   queue.send_message("message4")
   queue.send_message("message5")

Paylaşılan Erişim İmzaları ile kullanılabilecek kuyruk için depolanan erişim ilkelerini ayarlar.

Bir kuyruk için izinleri ayarladığınızda, mevcut izinler değiştirilir. Kuyruğun izinlerini güncelleştirmek için öğesini çağırarak get_queue_access_policy kuyrukla ilişkili tüm erişim ilkelerini getirin, değiştirmek istediğiniz erişim ilkesini değiştirin ve ardından güncelleştirmeyi gerçekleştirmek için tam veri kümesiyle bu işlevi çağırın.

Bir kuyrukta depolanmış erişim ilkesi oluşturduğunuzda, etkin olması 30 saniye kadar sürebilir. Bu aralık boyunca, depolanan erişim ilkesiyle ilişkili paylaşılan erişim imzası, erişim ilkesi etkin olana kadar bir <xref:azure.storage.queue.HttpResponseError> oluşturur.

set_queue_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> None

Parametreler

Örnekler

Kuyrukta bir erişim ilkesi ayarlayın.

   # Create an access policy
   from azure.storage.queue import AccessPolicy, QueueSasPermissions
   access_policy = AccessPolicy()
   access_policy.start = datetime.utcnow() - timedelta(hours=1)
   access_policy.expiry = datetime.utcnow() + timedelta(hours=1)
   access_policy.permission = QueueSasPermissions(read=True)
   identifiers = {'my-access-policy-id': access_policy}

   # Set the access policy
   queue.set_queue_access_policy(identifiers)

Belirtilen kuyrukta kullanıcı tanımlı meta verileri ayarlar.

Meta veriler kuyrukla ad-değer çiftleri olarak ilişkilendirilir.

set_queue_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

Döndürülenler

Yanıt üst bilgilerinin sözlüğü.

Dönüş türü

Örnekler

Kuyrukta meta verileri ayarlayın.

   metadata = {'foo': 'val1', 'bar': 'val2', 'baz': 'val3'}
   queue.set_queue_metadata(metadata=metadata)

İletinin görünürlük zaman aşımını Güncelleştirmeler. Bu işlemi bir iletinin içeriğini güncelleştirmek için de kullanabilirsiniz.

Bu işlem, kuyruk iletisinin görünmezliğini sürekli genişletmek için kullanılabilir. Bir çalışan rolünün kuyruk iletisini "kiralamasını" istiyorsanız bu işlev yararlı olabilir. Örneğin, bir çalışan rolü bir iletiyi işlemek için daha fazla zamana ihtiyacı olduğunu çağırır receive_messages ve tanırsa, ileti işlenene kadar iletinin görünmezliğini sürekli olarak genişletebilir. çalışan rolü işleme sırasında başarısız olursa, sonunda ileti yeniden görünür hale gelir ve başka bir çalışan rolü bunu işleyebilecektir.

Key-encryption-key alanı yerel hizmet nesnesinde ayarlandıysa, bu yöntem karşıya yüklemeden önce içeriği şifreler.

update_message(message: str | QueueMessage, pop_receipt: str | None = None, content: object | None = None, *, visibility_timeout: int | None = None, **kwargs: Any) -> QueueMessage

Parametreler

Döndürülenler

Bir QueueMessage nesnesi. Kolaylık olması için, hizmet tarafından döndürülmemesine rağmen bu nesne içerikle de doldurulur.

Dönüş türü

Örnekler

İletiyi güncelleştirme.

   # Send a message
   queue.send_message("update me")

   # Receive the message
   messages = queue.receive_messages()

   # Update the message
   list_result = next(messages)
   message = queue.update_message(
       list_result.id,
       pop_receipt=list_result.pop_receipt,
       visibility_timeout=0,
       content="updated")

İstekler için kullanılan Depolama API'sinin sürümü.

Dönüş türü

İstemcinin şu anda kullandığı konum modu.

Varsayılan olarak bu "birincil" olur. Seçenekler arasında "birincil" ve "ikincil" bulunur.

Dönüş türü

Tam birincil uç nokta URL'si.

Dönüş türü

Birincil uç noktanın ana bilgisayar adı.

Dönüş türü

Yapılandırıldıysa tam ikincil uç nokta URL'si.

Kullanılamıyorsa bir ValueError oluşturulur. İkincil ana bilgisayar adını açıkça belirtmek için, örneklemede isteğe bağlı secondary_hostname anahtar sözcük bağımsız değişkenini kullanın.

Dönüş türü

Özel durumlar

İkincil uç noktanın ana bilgisayar adı.

Kullanılamıyorsa, bu Yok olur. İkincil ana bilgisayar adını açıkça belirtmek için, örneklemede isteğe bağlı secondary_hostname anahtar sözcük bağımsız değişkenini kullanın.

Dönüş türü

Kullanılırsa SAS belirteci de dahil olmak üzere bu varlığın tam uç nokta URL'si.

Bu birincil uç nokta veya geçerli location_modeöğesine bağlı olarak ikincil uç nokta olabilir. :returns: Kullanıldıysa SAS belirteci de dahil olmak üzere bu varlığa ilişkin tam uç nokta URL'si. :rtype: str