QueueService Třída
Toto je hlavní třída, která spravuje prostředky fronty.
Služba Fronta ukládá zprávy. Fronta může obsahovat neomezený počet zpráv, z nichž každá může mít velikost až 64 kB. Zprávy se obvykle přidávají na konec fronty a načítají se z přední části fronty, i když chování FIFO (first in, first out) není zaručeno.
:type ~azure.storage.common.TokenCredential
- Dědičnost
-
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)Parametry
- account_name
- str
Název účtu úložiště. Používá se k ověřování požadavků podepsaných klíčem účtu a k vytvoření koncového bodu úložiště. Vyžaduje se, pokud není zadaný připojovací řetězec.
- account_key
- str
Klíč účtu úložiště. Používá se pro ověřování pomocí sdíleného klíče.
- sas_token
- str
Token sdíleného přístupového podpisu, který se použije k ověřování požadavků místo klíče účtu. Pokud je zadán klíč účtu i token SAS, použije se k podepsání klíč účtu.
- is_emulated
- bool
Jestli se má emulátor používat. Výchozí hodnota je False. Pokud je zadaný, přepíše všechny ostatní parametry kromě relace připojovací řetězec a žádosti.
- protocol
- str
Protokol, který se má použít pro požadavky. Výchozí hodnota je https.
- endpoint_suffix
- str
Základní komponenta hostitele adresy URL minus název účtu. Výchozí hodnota je Azure (core.windows.net). Přepište tuto možnost, pokud chcete používat čínský cloud (core.chinacloudapi.cn).
- request_session
- <xref:requests.Session>
Objekt relace, který se má použít pro požadavky HTTP.
- connection_string
- str
Pokud je tato možnost zadána, přepíše se tím všechny ostatní parametry kromě relace požadavku. Viz http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ formát připojovací řetězec.
- socket_timeout
- int
Pokud je zadaný, přepíše se tím výchozí časový limit soketu. Zadaný časový limit je v sekundách. Výchozí hodnotu najdete v DEFAULT_SOCKET_TIMEOUT v _constants.py.
- token_credential
Přihlašovací údaje tokenu používané k ověřování požadavků HTTPS. Hodnota tokenu by se měla aktualizovat před vypršením platnosti.
Proměnné
- encode_function
- <xref:function>(<xref:data>)
Funkce, která se používá ke kódování zpráv fronty. Vezme jako parametr data předaná do rozhraní API put_message a vrátí zakódovanou zprávu. Ve výchozím nastavení se používá kódování textu a xml, ale dají se použít bajty a další kódování. Například base64 může být vhodnější pro vývoj napříč několika knihovnami Azure Storage v různých jazycích. QueueMessageFormat Viz xml, base64 a žádné metody kódování a binární ekvivalenty.
- decode_function
- <xref:function>(<xref:data>)
Funkce sloužící ke kódování dekódování zpráv. Vezme jako parametr data vrácené get_messages a peek_messages rozhraní API a vrátí dekódovanou zprávu. Ve výchozím nastavení se vrátí dekódování textu a xml, ale dají se použít bajty a další dekódování. Například base64 může být vhodnější pro vývoj napříč několika knihovnami Azure Storage v různých jazycích. QueueMessageFormat Viz metody xml, base64 a žádné dekódování a binární ekvivalenty.
- key_encryption_key
- object
Klíč-šifrování-klíč volitelně poskytnutý uživatelem. Pokud je k dispozici, použije se k šifrování/dešifrování v podporovaných metodách. Pro metody vyžadující dešifrování musí být k dispozici key_encryption_key nebo překladač. Pokud jsou k dispozici obě možnosti, bude mít přednost překladač. Pro rozhraní API vyžadující šifrování je nutné implementovat následující metody: wrap_key(klíč) – zabalí zadaný klíč (bajty) pomocí algoritmu podle volby uživatele. Vrátí šifrovaný klíč jako bajty. get_key_wrap_algorithm()–vrátí algoritmus použitý k zabalení zadaného symetrického klíče. get_kid()–vrátí ID klíče řetězce pro tento klíč-encryption-key. Musí implementovat následující metody pro rozhraní API vyžadující dešifrování: unwrap_key(klíč, algoritmus) – vrátí nezabalenou formu zadaného symetrického klíče pomocí algoritmu zadaného řetězcem. get_kid()–vrátí ID klíče řetězce pro tento klíč-encryption-key.
- key_resolver_function
- kid) (<xref:function>
Funkce pro překlad klíčů, které volitelně poskytuje uživatel. Pokud je k dispozici, použije se k dešifrování v podporovaných metodách. Pro metody vyžadující dešifrování musí být k dispozici key_encryption_key nebo překladač. Pokud jsou k dispozici obě možnosti, bude mít přednost překladač. Používá řetězec kid k vrácení klíče-šifrování-klíč implementuje rozhraní definované výše.
- require_encryption
- bool
Příznak, který může být nastaven tak, aby se zajistilo, že se všechny zprávy úspěšně nahrály do fronty a všechny stažené a úspěšně přečtené z fronty byly zašifrovány na serveru. Pokud je tento příznak nastavený, musí být zadané všechny požadované parametry pro šifrování nebo dešifrování. Projděte si výše uvedené komentáře k key_encryption_key a resolveru.
Metody
| clear_messages |
Odstraní všechny zprávy ze zadané fronty. |
| create_queue |
Vytvoří frontu pod daným účtem. |
| delete_message |
Odstraní zadanou zprávu. Obvykle se očekává, že jakmile klient načte zprávu s operací get_messages, klient zprávu zpracuje a odstraní. Pokud chcete zprávu odstranit, musíte mít dvě datové položky: ID a pop_receipt. ID se vrátí z předchozí operace get_messages. Pop_receipt se vrátí z poslední get_messages operace nebo update_message operace. Aby byla operace delete_message úspěšná, musí pop_receipt zadané v požadavku odpovídat pop_receipt vrácených z get_messages operace nebo update_message . |
| delete_queue |
Odstraní zadanou frontu a všechny zprávy, které obsahuje. Když se fronta úspěšně odstraní, okamžitě se označí k odstranění a přestane být přístupná klientům. Fronta se později odebere ze služby Queue během uvolňování paměti. Upozorňujeme, že odstranění fronty bude pravděpodobně trvat alespoň 40 sekund. Pokud dojde k pokusu o operaci s frontou v době, kdy byla odstraněna, <xref:azure.storage.queue.queueservice.AzureConflictHttpError> vyvolá se operace. |
| exists |
Vrátí logickou hodnotu označující, zda fronta existuje. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Vygeneruje sdílený přístupový podpis pro službu fronty. Použijte vrácený podpis s parametrem sas_token QueueService. |
| generate_queue_shared_access_signature |
Vygeneruje sdílený přístupový podpis pro frontu. Použijte vrácený podpis s parametrem sas_token QueueService. |
| get_messages |
Načte jednu nebo více zpráv z přední části fronty. Když se zpráva načte z fronty, odpověď obsahuje obsah zprávy a hodnotu pop_receipt, která se vyžaduje k odstranění zprávy. Zpráva se automaticky neodstraní z fronty, ale po načtení se nezobrazí ostatním klientům po dobu určenou parametrem visibility_timeout. Pokud je u objektu místní služby nastaveno pole klíč-šifrovací-klíč nebo překladač, budou zprávy před vrácením dešifrovány. |
| get_queue_acl |
Vrátí podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy. |
| get_queue_metadata |
Načte uživatelem definovaná metadata a vlastnosti fronty v zadané frontě. Metadata jsou přidružená k frontě jako páry název-hodnota. |
| get_queue_service_properties |
Získá vlastnosti služby Queue účtu úložiště, včetně protokolování, analýzy a pravidel CORS. |
| get_queue_service_stats |
Načte statistiky související s replikací služby Queue. Je k dispozici pouze v případě, že je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení. Díky geograficky redundantní replikaci azure storage udržuje vaše data odolná ve dvou umístěních. V obou umístěních Azure Storage neustále udržuje několik replik dat, které jsou v pořádku. Umístění, kde čtete, vytváříte, aktualizujete nebo odstraňujete data, je primární umístění účtu úložiště. Primární umístění existuje v oblasti, kterou zvolíte, v okamžiku vytvoření účtu prostřednictvím portálu Azure Management Azure Classic, například USA – středosever. Umístění, do kterého se data replikují, je sekundární umístění. Sekundární umístění je automaticky určeno na základě umístění primární; nachází se ve druhém datovém centru, které se nachází ve stejné oblasti jako primární umístění. Přístup jen pro čtení je k dispozici ze sekundárního umístění, pokud je pro váš účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení. |
| list_queues |
Vrátí generátor pro výpis front. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny fronty nebo se dosáhne num_results. Pokud je zadána num_results a účet má více front, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky. |
| peek_messages |
Načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy. Načítat se můžou jenom zprávy, které jsou viditelné. Při prvním načtení zprávy s voláním get_messages je její vlastnost dequeue_count nastavena na hodnotu 1. Pokud se neodstraní a následně se znovu načte, zvýší se vlastnost dequeue_count. Klient může tuto hodnotu použít k určení, kolikrát byla zpráva načtena. Všimněte si, že volání peek_messages nezvýší hodnotu DequeueCount, ale vrátí tuto hodnotu pro čtení klienta. Pokud je u objektu místní služby nastaveno pole klíč-šifrovací-klíč nebo překladač, budou zprávy před vrácením dešifrovány. |
| put_message |
Přidá novou zprávu do zadní části fronty zpráv. Časový limit viditelnosti určuje čas, kdy bude zpráva neviditelná. Po vypršení časového limitu se zpráva zobrazí. Pokud není zadaný časový limit viditelnosti, použije se výchozí hodnota 0. Hodnota time-to-live zprávy určuje, jak dlouho zpráva zůstane ve frontě. Zpráva bude odstraněna z fronty, jakmile vyprší doba trvání. Pokud je pole klíč-šifrování-klíč nastaveno v objektu místní služby, tato metoda před nahráním zašifruje obsah. |
| set_proxy |
Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT. |
| set_queue_acl |
Nastaví uložené zásady přístupu pro frontu, které se dají použít se sdílenými přístupovými podpisy. Když nastavíte oprávnění pro frontu, nahradí se stávající oprávnění. Pokud chcete aktualizovat oprávnění fronty, zavolejte a načtěte get_queue_acl všechny zásady přístupu přidružené k frontě, upravte zásady přístupu, které chcete změnit, a pak zavolejte tuto funkci s úplnou sadou dat, aby se aktualizace provedla. Když vytvoříte uložené zásady přístupu ve frontě, může trvat až 30 sekund, než se projeví. Během tohoto intervalu vyvolá sdílený přístupový podpis přidružený k uloženým zásadám přístupu chybu <xref:azure.storage.queue.queueservice.AzureHttpError> , dokud se zásady přístupu neaktivuje. |
| set_queue_metadata |
Nastaví uživatelem definovaná metadata v zadané frontě. Metadata jsou přidružená k frontě jako páry název-hodnota. |
| set_queue_service_properties |
Nastaví vlastnosti služby Queue účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (ex Protokolování) ponechán jako Žádný, stávající nastavení služby pro danou funkci se zachovají. Další informace o azure Analýza úložiště najdete v tématu https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx. |
| update_message |
Aktualizace časový limit viditelnosti zprávy. Tuto operaci můžete použít také k aktualizaci obsahu zprávy. Tuto operaci lze použít k neustálému rozšiřování neviditelnosti zprávy fronty. Tato funkce může být užitečná, pokud chcete, aby role pracovního procesu "zapůjmila" zprávu fronty. Pokud například role pracovního procesu volá get_messages a rozpozná, že ke zpracování zprávy potřebuje více času, může nepřetržitě prodlužovat neviditelnost zprávy, dokud se nezpracuje. Pokud by role pracovního procesu během zpracování selhala, nakonec by se zpráva znovu zobrazila a mohla by ji zpracovat jiná role pracovního procesu. Pokud je pole klíč-šifrování-klíč nastaveno v objektu místní služby, tato metoda před nahráním zašifruje obsah. |
clear_messages
Odstraní všechny zprávy ze zadané fronty.
clear_messages(queue_name, timeout=None)Parametry
create_queue
Vytvoří frontu pod daným účtem.
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)Parametry
- queue_name
- str
Název fronty, která se má vytvořit. Název fronty musí mít délku 3 až 63 znaků a může obsahovat pouze malá písmena, číslice a pomlčku (-). První a poslední písmeno ve frontě musí být alfanumerické. Znak pomlčky (-) nemůže být prvním ani posledním znakem. Po sobě jdoucí pomlčky nejsou v názvu fronty povoleny.
Dikt obsahující páry název-hodnota, které se přidruží k frontě jako metadata. Všimněte si, že názvy metadat zachovávají písmena, se kterými byly vytvořeny, ale při nastavení nebo čtení nerozlišují velká a malá písmena.
- fail_on_exist
- bool
Určuje, zda se má vyvolat výjimka, pokud fronta již existuje.
Návraty
Logická hodnota označující, jestli byla fronta vytvořena. Pokud fail_on_exist byla nastavena na Hodnotu True, vyvolá se místo vrácení hodnoty false.
Návratový typ
delete_message
Odstraní zadanou zprávu.
Obvykle se očekává, že jakmile klient načte zprávu s operací get_messages, klient zprávu zpracuje a odstraní. Pokud chcete zprávu odstranit, musíte mít dvě datové položky: ID a pop_receipt. ID se vrátí z předchozí operace get_messages. Pop_receipt se vrátí z poslední get_messages operace nebo update_message operace. Aby byla operace delete_message úspěšná, musí pop_receipt zadané v požadavku odpovídat pop_receipt vrácených z get_messages operace nebo update_message .
delete_message(queue_name, message_id, pop_receipt, timeout=None)Parametry
- pop_receipt
- str
Platná hodnota potvrzení pop vrácená z dřívějšího volání nebo get_messagesupdate_message.
delete_queue
Odstraní zadanou frontu a všechny zprávy, které obsahuje.
Když se fronta úspěšně odstraní, okamžitě se označí k odstranění a přestane být přístupná klientům. Fronta se později odebere ze služby Queue během uvolňování paměti.
Upozorňujeme, že odstranění fronty bude pravděpodobně trvat alespoň 40 sekund. Pokud dojde k pokusu o operaci s frontou v době, kdy byla odstraněna, <xref:azure.storage.queue.queueservice.AzureConflictHttpError> vyvolá se operace.
delete_queue(queue_name, fail_not_exist=False, timeout=None)Parametry
- fail_not_exist
- bool
Určuje, jestli se má vyvolat výjimka, pokud fronta neexistuje.
Návraty
Logická hodnota označující, jestli byla fronta odstraněna. Pokud byla fail_not_exist nastavená na Hodnotu True, vyvolá se místo vrácení hodnoty false.
Návratový typ
exists
Vrátí logickou hodnotu označující, zda fronta existuje.
exists(queue_name, timeout=None)Parametry
Návraty
Logická hodnota označující, jestli fronta existuje.
Návratový typ
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parametry
- retry_context
generate_account_shared_access_signature
Vygeneruje sdílený přístupový podpis pro službu fronty. Použijte vrácený podpis s parametrem sas_token QueueService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parametry
- resource_types
- <xref:ResourceTypes>
Určuje typy prostředků, které jsou přístupné pomocí SAS účtu.
- permission
- <xref:AccountPermissions>
Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
- ip
- str
Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip=168.1.5.65 nebo sip=168.1.5.60-168.1.5.70 v SAS omezí požadavek na tyto IP adresy.
- protocol
- str
Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https,http. Projděte si Protocol možné hodnoty.
Návraty
Token sdíleného přístupového podpisu (SAS).
Návratový typ
generate_queue_shared_access_signature
Vygeneruje sdílený přístupový podpis pro frontu. Použijte vrácený podpis s parametrem sas_token QueueService.
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)Parametry
- permission
- QueuePermissions
Oprávnění přidružená ke sdílenému přístupovém podpisu. Uživatel je omezen na operace povolené oprávněními. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu.
Čas, kdy se sdílený přístupový podpis stane neplatným. Povinné, pokud není zadané ID odkazující na uložené zásady přístupu, které obsahují toto pole. Toto pole je nutné vynechat, pokud je zadané v přidružených uložených zásadách přístupu. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
Čas, kdy se sdílený přístupový podpis stane platným. Pokud je vynechán, předpokládá se, že počáteční čas pro toto volání je čas, kdy služba úložiště přijme požadavek. Azure vždy převede hodnoty na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC.
- id
- str
Jedinečná hodnota o délce až 64 znaků, která koreluje s uloženými zásadami přístupu. K vytvoření uložených zásad přístupu použijte set_queue_acl.
- ip
- str
Určuje IP adresu nebo rozsah IP adres, ze kterých se mají přijímat požadavky. Pokud IP adresa, ze které požadavek pochází, neodpovídá IP adrese nebo rozsahu adres zadaným v tokenu SAS, požadavek se neověří. Například zadání sip='168.1.5.65' nebo sip='168.1.5.60-168.1.5.70' v SAS omezí požadavek na tyto IP adresy.
- protocol
- str
Určuje protokol povolený pro zadaný požadavek. Výchozí hodnota je https,http. Projděte si Protocol možné hodnoty.
Návraty
Token sdíleného přístupového podpisu (SAS).
Návratový typ
get_messages
Načte jednu nebo více zpráv z přední části fronty.
Když se zpráva načte z fronty, odpověď obsahuje obsah zprávy a hodnotu pop_receipt, která se vyžaduje k odstranění zprávy. Zpráva se automaticky neodstraní z fronty, ale po načtení se nezobrazí ostatním klientům po dobu určenou parametrem visibility_timeout.
Pokud je u objektu místní služby nastaveno pole klíč-šifrovací-klíč nebo překladač, budou zprávy před vrácením dešifrovány.
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)Parametry
- num_messages
- int
Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají načíst z fronty, maximálně 32. Pokud je viditelných méně, viditelné zprávy se vrátí. Ve výchozím nastavení se z fronty pomocí této operace načte jedna zpráva.
- visibility_timeout
- int
Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Nová hodnota musí být větší nebo rovna 1 sekundě a nesmí být větší než 7 dnů. Časový limit viditelnosti zprávy je možné nastavit na hodnotu později, než je doba vypršení platnosti.
Návraty
Objekt QueueMessage představující předané informace.
Návratový typ
get_queue_acl
Vrátí podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy.
get_queue_acl(queue_name, timeout=None)Parametry
Návraty
Slovník zásad přístupu přidružených k frontě.
Návratový typ
get_queue_metadata
Načte uživatelem definovaná metadata a vlastnosti fronty v zadané frontě. Metadata jsou přidružená k frontě jako páry název-hodnota.
get_queue_metadata(queue_name, timeout=None)Parametry
Návraty
Slovník představující metadata fronty s vlastností approximate_message_count int ve diktu, který odhaduje počet zpráv ve frontě.
Návratový typ
get_queue_service_properties
Získá vlastnosti služby Queue účtu úložiště, včetně protokolování, analýzy a pravidel CORS.
get_queue_service_properties(timeout=None)Parametry
Návraty
Vlastnosti služby front.
Návratový typ
get_queue_service_stats
Načte statistiky související s replikací služby Queue. Je k dispozici pouze v případě, že je pro účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.
Díky geograficky redundantní replikaci azure storage udržuje vaše data odolná ve dvou umístěních. V obou umístěních Azure Storage neustále udržuje několik replik dat, které jsou v pořádku. Umístění, kde čtete, vytváříte, aktualizujete nebo odstraňujete data, je primární umístění účtu úložiště. Primární umístění existuje v oblasti, kterou zvolíte, v okamžiku vytvoření účtu prostřednictvím portálu Azure Management Azure Classic, například USA – středosever. Umístění, do kterého se data replikují, je sekundární umístění. Sekundární umístění je automaticky určeno na základě umístění primární; nachází se ve druhém datovém centru, které se nachází ve stejné oblasti jako primární umístění. Přístup jen pro čtení je k dispozici ze sekundárního umístění, pokud je pro váš účet úložiště povolená geograficky redundantní replikace s přístupem pro čtení.
get_queue_service_stats(timeout=None)Parametry
Návraty
Statistiky služby front.
Návratový typ
list_queues
Vrátí generátor pro výpis front. Generátor bude líně sledovat tokeny pokračování vrácené službou a zastaví se, jakmile se vrátí všechny fronty nebo se dosáhne num_results.
Pokud je zadána num_results a účet má více front, generátor bude mít po dokončení vyplněné pole next_marker. Tuto značku je možné použít k vytvoření nového generátoru, pokud jsou požadované další výsledky.
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parametry
- prefix
- str
Filtruje výsledky tak, aby vracely pouze fronty s názvy, které začínají zadanou předponou.
- marker
- str
Neprůsledný pokračovací token. Tuto hodnotu lze načíst z pole next_marker předchozího objektu generátoru, pokud byl zadán num_results a tento generátor dokončil výčet výsledků. Pokud je tato hodnota zadána, začne tento generátor vracet výsledky z bodu, kde se předchozí generátor zastavil.
- timeout
- int
Časový limit serveru vyjádřený v sekundách Tato funkce může provádět více volání služby, v takovém případě se zadaná hodnota časového limitu použije na každé jednotlivé volání.
peek_messages
Načte jednu nebo více zpráv z přední části fronty, ale nezmění viditelnost zprávy.
Načítat se můžou jenom zprávy, které jsou viditelné. Při prvním načtení zprávy s voláním get_messages je její vlastnost dequeue_count nastavena na hodnotu 1. Pokud se neodstraní a následně se znovu načte, zvýší se vlastnost dequeue_count. Klient může tuto hodnotu použít k určení, kolikrát byla zpráva načtena. Všimněte si, že volání peek_messages nezvýší hodnotu DequeueCount, ale vrátí tuto hodnotu pro čtení klienta.
Pokud je u objektu místní služby nastaveno pole klíč-šifrovací-klíč nebo překladač, budou zprávy před vrácením dešifrovány.
peek_messages(queue_name, num_messages=None, timeout=None)Parametry
- num_messages
- int
Nenulová celočíselná hodnota, která určuje počet zpráv, které se mají zobrazit z fronty, maximálně 32. Ve výchozím nastavení se pomocí této operace z fronty zobrazí jedna zpráva.
Návraty
Seznam QueueMessage objektů. Všimněte si, že time_next_visible a pop_receipt se nenaplní, protože náhled zprávu neotevří a může načíst pouze již viditelné zprávy.
Návratový typ
put_message
Přidá novou zprávu do zadní části fronty zpráv.
Časový limit viditelnosti určuje čas, kdy bude zpráva neviditelná. Po vypršení časového limitu se zpráva zobrazí. Pokud není zadaný časový limit viditelnosti, použije se výchozí hodnota 0.
Hodnota time-to-live zprávy určuje, jak dlouho zpráva zůstane ve frontě. Zpráva bude odstraněna z fronty, jakmile vyprší doba trvání.
Pokud je pole klíč-šifrování-klíč nastaveno v objektu místní služby, tato metoda před nahráním zašifruje obsah.
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)Parametry
- content
- <xref:obj>
Obsah zprávy. Povolený typ je určen encode_function nastaveným ve službě. Výchozí hodnota je str. Zakódovaná zpráva může mít velikost až 64 kB.
- visibility_timeout
- int
Pokud není zadán, výchozí hodnota je 0. Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Hodnota musí být větší nebo rovna 0 a nesmí být větší než 7 dnů. Časový limit viditelnosti zprávy nelze nastavit na hodnotu pozdější než čas vypršení platnosti. visibility_timeout by měla být nastavena na hodnotu menší než hodnota time-to-live.
- time_to_live
- int
Určuje časový interval zprávy v sekundách. Hodnota time-to-live může být libovolné kladné číslo nebo -1 pro nekonečno. Pokud je tento parametr vynechán, výchozí hodnota time-to-live je 7 dní.
Návraty
Objekt QueueMessage . Tento objekt je také naplněn obsahem, i když není vrácen ze služby.
Návratový typ
set_proxy
Nastaví hostitele proxy serveru a port pro tunelování HTTP CONNECT.
set_proxy(host, port, user=None, password=None)Parametry
set_queue_acl
Nastaví uložené zásady přístupu pro frontu, které se dají použít se sdílenými přístupovými podpisy.
Když nastavíte oprávnění pro frontu, nahradí se stávající oprávnění. Pokud chcete aktualizovat oprávnění fronty, zavolejte a načtěte get_queue_acl všechny zásady přístupu přidružené k frontě, upravte zásady přístupu, které chcete změnit, a pak zavolejte tuto funkci s úplnou sadou dat, aby se aktualizace provedla.
Když vytvoříte uložené zásady přístupu ve frontě, může trvat až 30 sekund, než se projeví. Během tohoto intervalu vyvolá sdílený přístupový podpis přidružený k uloženým zásadám přístupu chybu <xref:azure.storage.queue.queueservice.AzureHttpError> , dokud se zásady přístupu neaktivuje.
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)Parametry
- signed_identifiers
- dict(str, AccessPolicy)
Slovník zásad přístupu, které se mají přidružit k frontě. Slovník může obsahovat až 5 prvků. Prázdný slovník vymaže zásady přístupu nastavené ve službě.
set_queue_metadata
Nastaví uživatelem definovaná metadata v zadané frontě. Metadata jsou přidružená k frontě jako páry název-hodnota.
set_queue_metadata(queue_name, metadata=None, timeout=None)Parametry
- metadata
- dict
Dikt obsahující páry název-hodnota, které se přidruží k frontě jako metadata.
set_queue_service_properties
Nastaví vlastnosti služby Queue účtu úložiště, včetně Azure Analýza úložiště. Pokud je prvek (ex Protokolování) ponechán jako Žádný, stávající nastavení služby pro danou funkci se zachovají. Další informace o azure Analýza úložiště najdete v tématu 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)Parametry
- logging
- <xref:Logging>
Nastavení protokolování poskytují protokoly požadavků.
- hour_metrics
- <xref:Metrics>
Nastavení hodinových metrik poskytuje souhrn statistik žádostí seskupených podle rozhraní API v hodinové agregaci pro fronty.
- minute_metrics
- <xref:Metrics>
Nastavení minutových metrik poskytuje statistiky žádostí pro každou minutu pro fronty.
- cors
- list(CorsRule)
Do seznamu můžete zahrnout až pět prvků CorsRule. Pokud je zadaný prázdný seznam, odstraní se všechna pravidla CORS a cors se pro službu zakáže. Podrobné informace o pravidlech CORS a logice vyhodnocení najdete v tématu https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
update_message
Aktualizace časový limit viditelnosti zprávy. Tuto operaci můžete použít také k aktualizaci obsahu zprávy.
Tuto operaci lze použít k neustálému rozšiřování neviditelnosti zprávy fronty. Tato funkce může být užitečná, pokud chcete, aby role pracovního procesu "zapůjmila" zprávu fronty. Pokud například role pracovního procesu volá get_messages a rozpozná, že ke zpracování zprávy potřebuje více času, může nepřetržitě prodlužovat neviditelnost zprávy, dokud se nezpracuje. Pokud by role pracovního procesu během zpracování selhala, nakonec by se zpráva znovu zobrazila a mohla by ji zpracovat jiná role pracovního procesu.
Pokud je pole klíč-šifrování-klíč nastaveno v objektu místní služby, tato metoda před nahráním zašifruje obsah.
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)Parametry
- pop_receipt
- str
Platná hodnota potvrzení pop vrácená z dřívějšího get_messages volání operace nebo update_message .
- visibility_timeout
- int
Určuje novou hodnotu časového limitu viditelnosti v sekundách vzhledem k času serveru. Nová hodnota musí být větší nebo rovna 0 a nesmí být větší než 7 dnů. Časový limit viditelnosti zprávy nelze nastavit na hodnotu pozdější než čas vypršení platnosti. Zprávu je možné aktualizovat, dokud nebude odstraněna nebo nevypršela.
- content
- <xref:obj>
Obsah zprávy. Povolený typ je určen encode_function nastaveným ve službě. Výchozí hodnota je str.
Návraty
Seznam QueueMessage objektů. Pro usnadnění je tento objekt také naplněn obsahem, i když ho služba nevrátí.
Návratový typ
Atributy
protocol
request_session
socket_timeout
Azure SDK for Python
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro