QueueService Osztály
Ez az üzenetsor-erőforrásokat kezelő főosztály.
A Queue szolgáltatás tárolja az üzeneteket. Az üzenetsorok korlátlan számú üzenetet tartalmazhatnak, amelyek mindegyike legfeljebb 64 KB méretű lehet. Az üzenetek általában az üzenetsor végére kerülnek, és az üzenetsor elejéről kérik le, bár az első lépésben az első kimenő (FIFO) viselkedés nem garantált.
:type ~azure.storage.common.TokenCredential
- Öröklődés
-
QueueService
Konstruktor
QueueService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None, token_credential=None)Paraméterek
- account_name
- str
A tárfiók neve. Ez a fiókkulccsal aláírt kérések hitelesítésére és a tárvégpont létrehozására szolgál. Ez csak akkor szükséges, ha kapcsolati karakterlánc van megadva.
- account_key
- str
A tárfiókkulcs. Ez a megosztott kulcsos hitelesítéshez használatos.
- sas_token
- str
Megosztott hozzáférésű jogosultságkód-jogkivonat a kérések hitelesítéséhez a fiókkulcs helyett. Ha a fiókkulcs és az sas-jogkivonat is meg van adva, a rendszer a fiókkulcsot használja az aláíráshoz.
- is_emulated
- bool
Az emulátor használata. Alapértelmezés szerint Hamis. Ha meg van adva, a kapcsolati karakterlánc és a kérési munkameneten kívül minden más paramétert felülbírál.
- protocol
- str
A kérésekhez használandó protokoll. Alapértelmezés szerint https.
- endpoint_suffix
- str
Az URL gazdagép alapösszetevője, mínusz a fiók neve. Alapértelmezett érték az Azure-ba (core.windows.net). Ezt felülbírálhatja a kínai felhő (core.chinacloudapi.cn) használatához.
- request_session
- <xref:requests.Session>
A http-kérelmekhez használandó munkamenet-objektum.
- connection_string
- str
Ha meg van adva, ez felülbírálja az összes többi paramétert a kérelem munkamenete mellett. Tekintse meg http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ a kapcsolati karakterlánc formátumot.
- socket_timeout
- int
Ha meg van adva, ez felülbírálja az alapértelmezett szoftvercsatorna-időtúllépést. A megadott időtúllépés másodpercben van megadva. Az alapértelmezett értékről lásd: DEFAULT_SOCKET_TIMEOUT a _constants.py.
- token_credential
A HTTPS-kérések hitelesítéséhez használt jogkivonat-hitelesítő adatok. A jogkivonat értékét a lejárat előtt frissíteni kell.
Változók
- encode_function
- <xref:function>(<xref:data>)
Üzenetsor-üzenetek kódolására szolgáló függvény. Paraméterként veszi át a put_message API-nak átadott adatokat, és visszaadja a kódolt üzenetet. Alapértelmezés szerint szöveg- és XML-kódolást használ, de bájtok és más kódolások is használhatók. A base64 például előnyösebb lehet több Különböző nyelvű Azure Storage-kódtárban való fejlesztéshez. Tekintse meg az QueueMessageFormat xml, base64 és no kódolási módszereket, valamint a bináris megfelelőket.
- decode_function
- <xref:function>(<xref:data>)
Az üzenetek dekódolására szolgáló függvény. Paraméterként veszi a get_messages és peek_messages API-k által visszaadott adatokat, és visszaadja a dekódolt üzenetet. Alapértelmezés szerint szöveget és XML-dekódolást ad vissza, de bájtok és más dekódolások is használhatók. A base64 például előnyösebb lehet több Különböző nyelvű Azure Storage-kódtárban való fejlesztéshez. Tekintse meg az QueueMessageFormat xml, a base64 és a no decoding metódusokat, valamint a bináris megfelelőket.
- key_encryption_key
- object
A felhasználó által opcionálisan megadott kulcstitkosítási kulcs. Ha meg van adva, a rendszer a támogatott módszerek titkosítására/visszafejtésére szolgál. A visszafejtést igénylő metódusok esetében a key_encryption_key VAGY a feloldót kell megadni. Ha mindkettő meg van adva, a feloldó elsőbbséget élvez. A titkosítást igénylő API-khoz a következő módszereket kell implementálnia: wrap_key(kulcs)– a megadott kulcsot (bájtokat) a felhasználó által választott algoritmussal burkolja. A titkosított kulcsot bájtként adja vissza. get_key_wrap_algorithm()– a megadott szimmetrikus kulcs körbefuttatásához használt algoritmust adja vissza. get_kid()– a kulcstitkosítási kulcs sztringkulcs-azonosítóját adja vissza. A következő metódusokat kell implementálnia a visszafejtést igénylő API-khoz: unwrap_key(kulcs, algoritmus)– a megadott szimmetrikus kulcs nem feltört formáját adja vissza a sztringben megadott algoritmus használatával. get_kid()– a kulcstitkosítási kulcs sztringkulcs-azonosítóját adja vissza.
- key_resolver_function
- kid) (<xref:function>
A felhasználó által opcionálisan megadott kulcsok feloldására szolgáló függvény. Ha meg van adva, a rendszer a támogatott metódusok visszafejtésére szolgál. A visszafejtést igénylő metódusok esetében a key_encryption_key VAGY a feloldót kell megadni. Ha mindkettő meg van adva, a feloldó elsőbbséget élvez. A gyermek sztringet használja a fent definiált felületet implementáló kulcstitkosítási kulcs visszaadásához.
- require_encryption
- bool
Egy jelző, amely beállítható annak biztosítására, hogy az összes üzenet sikeresen fel legyen töltve az üzenetsorba, és hogy az üzenetsorból letöltött és sikeresen beolvasott üzenetek titkosítva legyenek/legyenek a kiszolgálón. Ha ez a jelző be van állítva, meg kell adnia a titkosításhoz/visszafejtéshez szükséges összes paramétert. Tekintse meg a fenti megjegyzéseket a key_encryption_key és a feloldóval kapcsolatban.
Metódusok
| clear_messages |
Törli az összes üzenetet a megadott üzenetsorból. |
| create_queue |
Létrehoz egy üzenetsort az adott fiók alatt. |
| delete_message |
Törli a megadott üzenetet. Általában miután egy ügyfél lekért egy üzenetet a get_messages művelettel, az ügyfélnek várhatóan fel kell dolgoznia és törölnie kell az üzenetet. Az üzenet törléséhez két adatelemnek kell lennie: azonosító és pop_receipt. Az azonosítót az előző get_messages művelet adja vissza. A pop_receipt a legutóbbi get_messages vagy update_message a műveletből lesz visszaadva. Ahhoz, hogy a delete_message művelet sikeres legyen, a kérelemben megadott pop_receipt meg kell egyeznie a vagy update_message művelet által get_messages visszaadott pop_receipt. |
| delete_queue |
Törli a megadott üzenetsort és a benne lévő üzeneteket. Ha egy üzenetsor sikeresen törölve van, a rendszer azonnal megjelöli törlésre, és már nem érhető el az ügyfelek számára. A rendszer később eltávolítja az üzenetsort a Queue szolgáltatásból a szemétgyűjtés során. Vegye figyelembe, hogy az üzenetsor törlése valószínűleg legalább 40 másodpercet vesz igénybe. Ha a rendszer egy műveletet kísérel meg az üzenetsoron a törlés közben, a rendszer egy <xref:azure.storage.queue.queueservice.AzureConflictHttpError> üzenetet küld. |
| exists |
Egy logikai értéket ad vissza, amely jelzi, hogy létezik-e az üzenetsor. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Létrehoz egy megosztott hozzáférési aláírást az üzenetsor-szolgáltatáshoz. Használja a visszaadott aláírást a QueueService sas_token paraméterével. |
| generate_queue_shared_access_signature |
Létrehoz egy közös hozzáférésű jogosultságkódot az üzenetsorhoz. Használja a visszaadott aláírást a QueueService sas_token paraméterével. |
| get_messages |
Egy vagy több üzenetet kér le az üzenetsor elejéről. Amikor lekér egy üzenetet az üzenetsorból, a válasz tartalmazza az üzenet tartalmát és egy pop_receipt értéket, amely az üzenet törléséhez szükséges. Az üzenet nem törlődik automatikusan az üzenetsorból, de a lekérése után nem látható a többi ügyfél számára a visibility_timeout paraméter által megadott időtartamig. Ha a kulcstitkosítási kulcs vagy a feloldó mező be van állítva a helyi szolgáltatásobjektumon, a rendszer visszafejti az üzeneteket, mielőtt visszaadja őket. |
| get_queue_acl |
A megosztott hozzáférésű jogosultságkódokkal használható üzenetsoron megadott tárolt hozzáférési szabályzatok részleteit adja vissza. |
| get_queue_metadata |
Lekéri a felhasználó által definiált metaadatokat és az üzenetsor tulajdonságait a megadott üzenetsoron. A metaadatok név-érték párokként kapcsolódnak az üzenetsorhoz. |
| get_queue_service_properties |
Lekéri a tárfiók Queue szolgáltatásának tulajdonságait, beleértve a naplózást, az elemzést és a CORS-szabályokat. |
| get_queue_service_stats |
Lekéri a Queue szolgáltatás replikációs statisztikáit. Ez csak akkor érhető el, ha az olvasási hozzáférés georedundáns replikációja engedélyezve van a tárfiókban. A georedundáns replikációval az Azure Storage két helyen tartja tartósan az adatokat. Az Azure Storage mindkét helyen folyamatosan több kifogástalan állapotú replikát tart fenn az adatokból. Az adatok olvasási, létrehozási, frissítési vagy törlési helye az elsődleges tárfiók helye. Az elsődleges hely a fiók létrehozásakor kiválasztott régióban található a klasszikus Azure Azure-portálon keresztül, például az USA északi középső régiója. Az adatok replikálásának helye a másodlagos hely. A másodlagos hely automatikusan meg lesz határozva az elsődleges hely alapján; egy második adatközpontban található, amely ugyanabban a régióban található, mint az elsődleges hely. Az írásvédett hozzáférés a másodlagos helyről érhető el, ha az írásvédett georedundáns replikáció engedélyezve van a tárfiókban. |
| list_queues |
Egy generátort ad vissza az üzenetsorok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat, és leáll az összes üzenetsor visszaadásakor vagy num_results elérésekor. Ha num_results van megadva, és a fióknak több várólistája van, mint amennyi üzenetsor van, a generátor a befejezés után egy kitöltött next_marker mezőt fog látni. Ezzel a jelölővel új generátort hozhat létre, ha több eredményre van szükség. |
| peek_messages |
Egy vagy több üzenetet kér le az üzenetsor elejéről, de nem módosítja az üzenet láthatóságát. Csak a látható üzenetek kérhetők le. Amikor egy get_messages hívásával első alkalommal kér le egy üzenetet, a dequeue_count tulajdonság értéke 1 lesz. Ha a rendszer nem törli, és később ismét lekéri, a dequeue_count tulajdonság növekszik. Az ügyfél ezt az értéket használhatja annak meghatározására, hogy hányszor kérték le az üzeneteket. Vegye figyelembe, hogy a peek_messages hívása nem növeli a DequeueCount értékét, hanem ezt az értéket adja vissza az ügyfélnek az olvasáshoz. Ha a kulcstitkosítási kulcs vagy a feloldó mező be van állítva a helyi szolgáltatásobjektumon, a rendszer visszafejti az üzeneteket, mielőtt visszaadja őket. |
| put_message |
Új üzenetet ad hozzá az üzenetsor hátuljához. A láthatósági időtúllépés azt az időt adja meg, amikor az üzenet láthatatlan lesz. Az időtúllépés lejárta után az üzenet láthatóvá válik. Ha nincs megadva láthatósági időtúllépés, a rendszer a 0 alapértelmezett értékét használja. Az üzenet élettartamát határozza meg, hogy az üzenet mennyi ideig maradjon az üzenetsorban. Az üzenet az élettartam lejártakor törlődik az üzenetsorból. Ha a kulcstitkosítás-kulcs mező be van állítva a helyi szolgáltatásobjektumon, ez a metódus a feltöltés előtt titkosítja a tartalmat. |
| set_proxy |
Beállítja a proxykiszolgáló gazdagépét és portját a HTTP CONNECT-bújtatáshoz. |
| set_queue_acl |
Beállítja a megosztott hozzáférésű jogosultságkódokkal használható üzenetsor tárolt hozzáférési szabályzatait. Amikor engedélyeket állít be egy üzenetsorhoz, a meglévő engedélyek lecserélődnek. Az üzenetsor engedélyeinek frissítéséhez hívja get_queue_acl meg az üzenetsorhoz társított összes hozzáférési szabályzat lekérését, módosítsa a módosítani kívánt hozzáférési szabályzatot, majd hívja meg ezt a függvényt a teljes adatkészlettel a frissítés végrehajtásához. Ha tárolt hozzáférési szabályzatot hoz létre egy üzenetsoron, az érvénybe lépése akár 30 másodpercet is igénybe vehet. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód addig jelenik <xref:azure.storage.queue.queueservice.AzureHttpError> meg, amíg a hozzáférési szabályzat aktívvá nem válik. |
| set_queue_metadata |
Felhasználó által definiált metaadatokat állít be a megadott üzenetsoron. A metaadatok név-érték párokként lesznek társítva az üzenetsorhoz. |
| set_queue_service_properties |
Beállítja a tárfiók Queue szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics. Ha egy elem (pl. naplózás) Nincs értékre van állítva, a szolgáltatás meglévő beállításai megmaradnak a funkcióhoz. Az Azure Storage Analytics kapcsolatos további információkért lásd: https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx. |
| update_message |
Frissítések egy üzenet láthatósági időtúllépését. Ezzel a művelettel frissítheti az üzenetek tartalmát. Ezzel a művelettel folyamatosan bővíthető az üzenetsorüzenetek láthatatlansága. Ez a funkció akkor lehet hasznos, ha azt szeretné, hogy egy feldolgozói szerepkör "bérletet" adjon egy üzenetsornak. Ha például egy feldolgozói szerepkör meghívja get_messages, és felismeri, hogy több időre van szüksége az üzenetek feldolgozásához, a feldolgozásig folyamatosan kiterjesztheti az üzenet láthatatlanságát. Ha a feldolgozói szerepkör nem működik a feldolgozás során, az üzenet végül ismét láthatóvá válik, és egy másik feldolgozói szerepkör feldolgozhatja azt. Ha a kulcstitkosítás-kulcs mező be van állítva a helyi szolgáltatásobjektumon, ez a metódus a feltöltés előtt titkosítja a tartalmat. |
clear_messages
Törli az összes üzenetet a megadott üzenetsorból.
clear_messages(queue_name, timeout=None)Paraméterek
create_queue
Létrehoz egy üzenetsort az adott fiók alatt.
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)Paraméterek
- queue_name
- str
A létrehozandó üzenetsor neve. Az üzenetsor nevének 3–63 karakter hosszúságúnak kell lennie, és csak kisbetűket, számokat és kötőjelet (-) tartalmazhat. Az üzenetsor első és utolsó betűjének alfanumerikusnak kell lennie. A kötőjel (-) karakter nem lehet az első vagy az utolsó karakter. Az üzenetsor nevében nem engedélyezettek az egymást követő kötőjelek.
Név-érték párokat tartalmazó diktálás, amely metaadatként társítja az üzenetsort. Vegye figyelembe, hogy a metaadatnevek megőrzik azt az esetet, amellyel létrehozták őket, de nem érzéketlenek a be- vagy olvasáskor.
- fail_on_exist
- bool
Meghatározza, hogy a rendszer kivételt adjon-e ki, ha az üzenetsor már létezik.
Válaszok
Logikai érték, amely azt jelzi, hogy az üzenetsor létrejött-e. Ha fail_on_exist Igaz értékre van állítva, akkor a függvény a hamis érték helyett ad vissza.
Visszatérési típus
delete_message
Törli a megadott üzenetet.
Általában miután egy ügyfél lekért egy üzenetet a get_messages művelettel, az ügyfélnek várhatóan fel kell dolgoznia és törölnie kell az üzenetet. Az üzenet törléséhez két adatelemnek kell lennie: azonosító és pop_receipt. Az azonosítót az előző get_messages művelet adja vissza. A pop_receipt a legutóbbi get_messages vagy update_message a műveletből lesz visszaadva. Ahhoz, hogy a delete_message művelet sikeres legyen, a kérelemben megadott pop_receipt meg kell egyeznie a vagy update_message művelet által get_messages visszaadott pop_receipt.
delete_message(queue_name, message_id, pop_receipt, timeout=None)Paraméterek
- pop_receipt
- str
Érvényes előugró nyugtaérték, amely a vagy update_messageegy korábbi hívásából származikget_messages.
delete_queue
Törli a megadott üzenetsort és a benne lévő üzeneteket.
Ha egy üzenetsor sikeresen törölve van, a rendszer azonnal megjelöli törlésre, és már nem érhető el az ügyfelek számára. A rendszer később eltávolítja az üzenetsort a Queue szolgáltatásból a szemétgyűjtés során.
Vegye figyelembe, hogy az üzenetsor törlése valószínűleg legalább 40 másodpercet vesz igénybe. Ha a rendszer egy műveletet kísérel meg az üzenetsoron a törlés közben, a rendszer egy <xref:azure.storage.queue.queueservice.AzureConflictHttpError> üzenetet küld.
delete_queue(queue_name, fail_not_exist=False, timeout=None)Paraméterek
- fail_not_exist
- bool
Meghatározza, hogy a rendszer kivételt jelez-e, ha az üzenetsor nem létezik.
Válaszok
Logikai érték, amely azt jelzi, hogy az üzenetsor törölve lett-e. Ha fail_not_exist Igaz értékre van állítva, a függvény a hamis érték helyett ad vissza.
Visszatérési típus
exists
Egy logikai értéket ad vissza, amely jelzi, hogy létezik-e az üzenetsor.
exists(queue_name, timeout=None)Paraméterek
Válaszok
Logikai érték, amely jelzi, hogy létezik-e az üzenetsor.
Visszatérési típus
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Paraméterek
- retry_context
generate_account_shared_access_signature
Létrehoz egy megosztott hozzáférési aláírást az üzenetsor-szolgáltatáshoz. Használja a visszaadott aláírást a QueueService sas_token paraméterével.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Paraméterek
- resource_types
- <xref:ResourceTypes>
Meghatározza a fiók SAS-jével elérhető erőforrástípusokat.
- permission
- <xref:AccountPermissions>
A közös hozzáférésű jogosultságkódhoz társított engedélyek. A felhasználó az engedélyek által engedélyezett műveletekre korlátozódik. Kötelező, hacsak nincs megadva azonosító, amely a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva.
A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Kötelező, hacsak nincs megadva azonosító, amely a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva. Az Azure mindig UTC-vé konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez.
A közös hozzáférésű jogosultságkód érvényességének időpontja. Ha nincs megadva, a rendszer feltételezi, hogy a hívás kezdési időpontja az az idő, amikor a társzolgáltatás megkapja a kérést. Az Azure mindig UTC-vé konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC értéket feltételez.
- ip
- str
Olyan IP-címet vagy IP-címtartományt ad meg, amelyből a kéréseket fogadni szeretné. Ha az IP-cím, amelyről a kérelem származik, nem egyezik meg az SAS-jogkivonaton megadott IP-címmel vagy címtartománynal, a kérés nem hitelesítve lesz. Ha például sip=168.1.5.65 vagy sip=168.1.5.60-168.1.5.70 értéket ad meg az SAS-en, az a kérést ezekre az IP-címekre korlátozza.
- protocol
- str
Meghatározza a kérelemhez engedélyezett protokollt. Az alapértelmezett érték a https,http. Tekintse meg Protocol a lehetséges értékeket.
Válaszok
Közös hozzáférésű jogosultságkód (sas) jogkivonat.
Visszatérési típus
generate_queue_shared_access_signature
Létrehoz egy közös hozzáférésű jogosultságkódot az üzenetsorhoz. Használja a visszaadott aláírást a QueueService sas_token paraméterével.
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)Paraméterek
- queue_name
- str
Annak az üzenetsornak a neve, amelyhez SAS-jogkivonatot szeretne létrehozni.
- permission
- QueuePermissions
A közös hozzáférésű jogosultságkódhoz társított engedélyek. A felhasználó az engedélyek által engedélyezett műveletekre korlátozódik. Kötelező, hacsak nincs megadva azonosító, amely a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva.
A közös hozzáférésű jogosultságkód érvénytelenné válásának időpontja. Kötelező, hacsak nincs megadva azonosító, amely a mezőt tartalmazó tárolt hozzáférési szabályzatra hivatkozik. Ezt a mezőt ki kell hagyni, ha egy társított tárolt hozzáférési szabályzatban van megadva. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.
A közös hozzáférésű jogosultságkód érvényességének időpontja. Ha nincs megadva, a rendszer feltételezi, hogy a hívás indítási ideje az az időpont, amikor a storage szolgáltatás megkapja a kérést. Az Azure mindig UTC értékké konvertálja az értékeket. Ha egy dátumot időzón-információ nélkül ad át, akkor a rendszer UTC-nek tekinti.
- id
- str
Egy legfeljebb 64 karakter hosszúságú egyedi érték, amely egy tárolt hozzáférési szabályzattal korrelál. Tárolt hozzáférési szabályzat létrehozásához használja a következőt set_queue_acl: .
- ip
- str
Megadja azt az IP-címet vagy IP-címtartományt, amelyből a kéréseket fogadni szeretné. Ha az IP-cím, amelyről a kérés származik, nem egyezik az SAS-jogkivonatban megadott IP-címmel vagy címtartománysal, a kérés nem lesz hitelesítve. Ha például a sip='168.1.5.65' vagy a sip='168.1.5.60-168.1.5.70' értéket adja meg az SAS-en, akkor a kérés az adott IP-címekre lesz korlátozva.
- protocol
- str
Meghatározza, hogy egy kéréshez mely protokoll engedélyezett. Az alapértelmezett érték a https,http. Tekintse meg Protocol a lehetséges értékeket.
Válaszok
Közös hozzáférésű jogosultságkód (sas) jogkivonat.
Visszatérési típus
get_messages
Egy vagy több üzenetet kér le az üzenetsor elejéről.
Amikor lekér egy üzenetet az üzenetsorból, a válasz tartalmazza az üzenet tartalmát és egy pop_receipt értéket, amely az üzenet törléséhez szükséges. Az üzenet nem törlődik automatikusan az üzenetsorból, de a lekérése után nem látható a többi ügyfél számára a visibility_timeout paraméter által megadott időtartamig.
Ha a kulcstitkosítási kulcs vagy a feloldó mező be van állítva a helyi szolgáltatásobjektumon, a rendszer visszafejti az üzeneteket, mielőtt visszaadja őket.
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)Paraméterek
- num_messages
- int
Nem nulla egész szám, amely az üzenetsorból lekérendő üzenetek számát adja meg, legfeljebb 32-ig. Ha kevesebb látható, a rendszer visszaadja a látható üzeneteket. A rendszer alapértelmezés szerint egyetlen üzenetet kér le az üzenetsorból ezzel a művelettel.
- visibility_timeout
- int
Az új láthatóság időtúllépési értékét adja meg másodpercben a kiszolgálói időhöz viszonyítva. Az új értéknek 1 másodpercnél nagyobbnak vagy egyenlőnek kell lennie, és nem lehet nagyobb 7 napnál. Az üzenetek láthatósági időtúllépése a lejárati időnél későbbi értékre állítható be.
Válaszok
Az QueueMessage átadott információkat jelképező objektum.
Visszatérési típus
get_queue_acl
A megosztott hozzáférésű jogosultságkódokkal használható üzenetsoron megadott tárolt hozzáférési szabályzatok részleteit adja vissza.
get_queue_acl(queue_name, timeout=None)Paraméterek
Válaszok
Az üzenetsorhoz társított hozzáférési szabályzatok szótára.
Visszatérési típus
get_queue_metadata
Lekéri a felhasználó által definiált metaadatokat és az üzenetsor tulajdonságait a megadott üzenetsoron. A metaadatok név-érték párokként kapcsolódnak az üzenetsorhoz.
get_queue_metadata(queue_name, timeout=None)Paraméterek
Válaszok
Az üzenetsor metaadatait jelölő szótár, amely approximate_message_count int tulajdonsággal rendelkezik a diktálásban az üzenetsorban lévő üzenetek számának becsléséhez.
Visszatérési típus
get_queue_service_properties
Lekéri a tárfiók Queue szolgáltatásának tulajdonságait, beleértve a naplózást, az elemzést és a CORS-szabályokat.
get_queue_service_properties(timeout=None)Paraméterek
Válaszok
Az üzenetsor-szolgáltatás tulajdonságai.
Visszatérési típus
get_queue_service_stats
Lekéri a Queue szolgáltatás replikációs statisztikáit. Ez csak akkor érhető el, ha az olvasási hozzáférés georedundáns replikációja engedélyezve van a tárfiókban.
A georedundáns replikációval az Azure Storage két helyen tartja tartósan az adatokat. Az Azure Storage mindkét helyen folyamatosan több kifogástalan állapotú replikát tart fenn az adatokból. Az adatok olvasási, létrehozási, frissítési vagy törlési helye az elsődleges tárfiók helye. Az elsődleges hely a fiók létrehozásakor kiválasztott régióban található a klasszikus Azure Azure-portálon keresztül, például az USA északi középső régiója. Az adatok replikálásának helye a másodlagos hely. A másodlagos hely automatikusan meg lesz határozva az elsődleges hely alapján; egy második adatközpontban található, amely ugyanabban a régióban található, mint az elsődleges hely. Az írásvédett hozzáférés a másodlagos helyről érhető el, ha az írásvédett georedundáns replikáció engedélyezve van a tárfiókban.
get_queue_service_stats(timeout=None)Paraméterek
Válaszok
A queue szolgáltatás statisztikái.
Visszatérési típus
list_queues
Egy generátort ad vissza az üzenetsorok listázásához. A generátor lazán követi a szolgáltatás által visszaadott folytatási jogkivonatokat, és leáll az összes üzenetsor visszaadásakor vagy num_results elérésekor.
Ha num_results van megadva, és a fióknak több várólistája van, mint amennyi üzenetsor van, a generátor a befejezés után egy kitöltött next_marker mezőt fog látni. Ezzel a jelölővel új generátort hozhat létre, ha több eredményre van szükség.
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Paraméterek
- prefix
- str
Szűri az eredményeket, hogy csak a megadott előtaggal kezdődő neveket tartalmazó üzenetsorokat adja vissza.
- include_metadata
- bool
Megadja, hogy a tároló metaadatai vissza legyenek adva a válaszban.
- marker
- str
Egy átlátszatlan folytatási jogkivonat. Ez az érték lekérhető egy korábbi generátorobjektum next_marker mezőjéből, ha num_results meg lett adva, és a generátor befejezte az eredmények számbavételét. Ha meg van adva, ez a generátor attól a ponttól kezdi visszaadni az eredményeket, ahol az előző generátor leállt.
- timeout
- int
A kiszolgáló időtúllépése másodpercben kifejezve. Ez a függvény több hívást is indíthat a szolgáltatás felé, ebben az esetben a megadott időtúllépési érték lesz alkalmazva minden egyes hívásra.
peek_messages
Egy vagy több üzenetet kér le az üzenetsor elejéről, de nem módosítja az üzenet láthatóságát.
Csak a látható üzenetek kérhetők le. Amikor egy get_messages hívásával első alkalommal kér le egy üzenetet, a dequeue_count tulajdonság értéke 1 lesz. Ha a rendszer nem törli, és később ismét lekéri, a dequeue_count tulajdonság növekszik. Az ügyfél ezt az értéket használhatja annak meghatározására, hogy hányszor kérték le az üzeneteket. Vegye figyelembe, hogy a peek_messages hívása nem növeli a DequeueCount értékét, hanem ezt az értéket adja vissza az ügyfélnek az olvasáshoz.
Ha a kulcstitkosítási kulcs vagy a feloldó mező be van állítva a helyi szolgáltatásobjektumon, a rendszer visszafejti az üzeneteket, mielőtt visszaadja őket.
peek_messages(queue_name, num_messages=None, timeout=None)Paraméterek
- num_messages
- int
Nem nulla egész szám, amely az üzenetsorból betekintendő üzenetek számát adja meg, legfeljebb 32-ig. Alapértelmezés szerint egyetlen üzenet jelenik meg az üzenetsorból ezzel a művelettel.
Válaszok
Objektumok listája QueueMessage . Vegye figyelembe, hogy time_next_visible és pop_receipt nem lesznek kitöltve, mivel a betekintő nem jeleníti meg az üzenetet, és csak a már látható üzeneteket tudja lekérni.
Visszatérési típus
put_message
Új üzenetet ad hozzá az üzenetsor hátuljához.
A láthatósági időtúllépés azt az időt adja meg, amikor az üzenet láthatatlan lesz. Az időtúllépés lejárta után az üzenet láthatóvá válik. Ha nincs megadva láthatósági időtúllépés, a rendszer a 0 alapértelmezett értékét használja.
Az üzenet élettartamát határozza meg, hogy az üzenet mennyi ideig maradjon az üzenetsorban. Az üzenet az élettartam lejártakor törlődik az üzenetsorból.
Ha a kulcstitkosítás-kulcs mező be van állítva a helyi szolgáltatásobjektumon, ez a metódus a feltöltés előtt titkosítja a tartalmat.
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)Paraméterek
- content
- <xref:obj>
Üzenet tartalma. Az engedélyezett típust a szolgáltatásban beállított encode_function határozza meg. Az alapértelmezett érték az str. A kódolt üzenet mérete legfeljebb 64 KB lehet.
- visibility_timeout
- int
Ha nincs megadva, az alapértelmezett érték 0. Az új láthatóság időtúllépési értékét adja meg másodpercben a kiszolgálói időhöz viszonyítva. Az értéknek 0-nál nagyobbnak vagy egyenlőnek kell lennie, és nem lehet nagyobb 7 napnál. Az üzenetek láthatósági időtúllépése nem állítható a lejárati időnél későbbi értékre. visibility_timeout az élettartamnál kisebb értékre kell állítani.
- time_to_live
- int
Az üzenet élettartamát adja meg másodpercben. Az élettartam lehet bármilyen pozitív szám, vagy -1 a végtelenhez. Ha ez a paraméter nincs megadva, az alapértelmezett élettartam 7 nap.
Válaszok
Egy QueueMessage objektum. Ez az objektum is feltöltődik a tartalommal, bár a szolgáltatás nem adja vissza.
Visszatérési típus
set_proxy
Beállítja a proxykiszolgáló gazdagépét és portját a HTTP CONNECT-bújtatáshoz.
set_proxy(host, port, user=None, password=None)Paraméterek
set_queue_acl
Beállítja a megosztott hozzáférésű jogosultságkódokkal használható üzenetsor tárolt hozzáférési szabályzatait.
Amikor engedélyeket állít be egy üzenetsorhoz, a meglévő engedélyek lecserélődnek. Az üzenetsor engedélyeinek frissítéséhez hívja get_queue_acl meg az üzenetsorhoz társított összes hozzáférési szabályzat lekérését, módosítsa a módosítani kívánt hozzáférési szabályzatot, majd hívja meg ezt a függvényt a teljes adatkészlettel a frissítés végrehajtásához.
Ha tárolt hozzáférési szabályzatot hoz létre egy üzenetsoron, az érvénybe lépése akár 30 másodpercet is igénybe vehet. Ebben az intervallumban a tárolt hozzáférési szabályzathoz társított közös hozzáférésű jogosultságkód addig jelenik <xref:azure.storage.queue.queueservice.AzureHttpError> meg, amíg a hozzáférési szabályzat aktívvá nem válik.
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)Paraméterek
- signed_identifiers
- dict(str, AccessPolicy)
Az üzenetsorhoz társítandó hozzáférési szabályzatok szótára. A szótár legfeljebb 5 elemet tartalmazhat. Egy üres szótár törli a szolgáltatásban beállított hozzáférési szabályzatokat.
set_queue_metadata
Felhasználó által definiált metaadatokat állít be a megadott üzenetsoron. A metaadatok név-érték párokként lesznek társítva az üzenetsorhoz.
set_queue_metadata(queue_name, metadata=None, timeout=None)Paraméterek
- metadata
- dict
Név-érték párokat tartalmazó diktálás, amely metaadatként társítja az üzenetsort.
set_queue_service_properties
Beállítja a tárfiók Queue szolgáltatásának tulajdonságait, beleértve az Azure Storage Analytics. Ha egy elem (pl. naplózás) Nincs értékre van állítva, a szolgáltatás meglévő beállításai megmaradnak a funkcióhoz. Az Azure Storage Analytics kapcsolatos további információkért lásd: https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.
set_queue_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)Paraméterek
- logging
- <xref:Logging>
A naplózási beállítások kérésnaplókat biztosítanak.
- hour_metrics
- <xref:Metrics>
Az óránkénti metrikák beállításai az API-k szerint csoportosított kérésstatisztikák összegzését biztosítják az üzenetsorok óránkénti összesítésében.
- minute_metrics
- <xref:Metrics>
A percmetrikák beállításai kérésstatisztikákat biztosítanak az egyes percekhez az üzenetsorokhoz.
- cors
- list(CorsRule)
A listában legfeljebb öt CorsRule-elem szerepelhet. Ha üres lista van megadva, az összes CORS-szabály törlődik, és a CORS le lesz tiltva a szolgáltatáshoz. A CORS-szabályokkal és a kiértékelési logikával kapcsolatos részletes információkért lásd: https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
update_message
Frissítések egy üzenet láthatósági időtúllépését. Ezzel a művelettel frissítheti az üzenetek tartalmát.
Ezzel a művelettel folyamatosan bővíthető az üzenetsorüzenetek láthatatlansága. Ez a funkció akkor lehet hasznos, ha azt szeretné, hogy egy feldolgozói szerepkör "bérletet" adjon egy üzenetsornak. Ha például egy feldolgozói szerepkör meghívja get_messages, és felismeri, hogy több időre van szüksége az üzenetek feldolgozásához, a feldolgozásig folyamatosan kiterjesztheti az üzenet láthatatlanságát. Ha a feldolgozói szerepkör nem működik a feldolgozás során, az üzenet végül ismét láthatóvá válik, és egy másik feldolgozói szerepkör feldolgozhatja azt.
Ha a kulcstitkosítás-kulcs mező be van állítva a helyi szolgáltatásobjektumon, ez a metódus a feltöltés előtt titkosítja a tartalmat.
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)Paraméterek
- pop_receipt
- str
A vagy update_message művelet egy korábbi hívásából visszaadott érvényes pop-visszaigazolási get_messages érték.
- visibility_timeout
- int
Az új láthatóság időtúllépési értékét adja meg másodpercben a kiszolgálói időhöz viszonyítva. Az új értéknek 0-nál nagyobbnak vagy egyenlőnek kell lennie, és nem lehet nagyobb 7 napnál. Az üzenetek láthatósági időtúllépése nem állítható be a lejárati időnél későbbi értékre. Az üzenetek mindaddig frissíthetők, amíg el nem törölték vagy lejárt.
- content
- <xref:obj>
Üzenet tartalma. Az engedélyezett típust a szolgáltatáson beállított encode_function határozza meg. Az alapértelmezett érték az str.
Válaszok
Objektumok listája QueueMessage . A kényelem érdekében ez az objektum a tartalommal is fel van töltve, bár a szolgáltatás nem adja vissza.
Visszatérési típus
Attribútumok
protocol
request_session
socket_timeout
Azure SDK for Python