QueueService Klass
Det här är huvudklassen som hanterar köresurser.
Kötjänsten lagrar meddelanden. En kö kan innehålla ett obegränsat antal meddelanden, som var och en kan vara upp till 64 kB i storlek. Meddelanden läggs vanligtvis till i slutet av kön och hämtas längst fram i kön, men först in, först ut (FIFO) är inte garanterat.
:type ~azure.storage.common.TokenCredential
- Arv
-
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)Parametrar
- account_name
- str
Namnet på lagringskontot. Detta används för att autentisera begäranden som signerats med en kontonyckel och för att konstruera lagringsslutpunkten. Det krävs om inte en anslutningssträng anges.
- account_key
- str
Nyckeln till lagringskontot. Detta används för autentisering med delad nyckel.
- sas_token
- str
En signaturtoken för delad åtkomst som ska användas för att autentisera begäranden i stället för kontonyckeln. Om både kontonyckel och sas-token har angetts används kontonyckeln för att signera.
- is_emulated
- bool
Om emulatorn ska användas. Standardvärdet är False. Om detta anges åsidosätts alla andra parametrar förutom anslutningssträng- och begärandesessionen.
- protocol
- str
Det protokoll som ska användas för begäranden. Standardvärdet är https.
- endpoint_suffix
- str
Värdbaskomponenten för URL:en, minus kontonamnet. Standardvärdet är Azure (core.windows.net). Åsidosätt detta om du vill använda Moln i Kina (core.chinacloudapi.cn).
- request_session
- <xref:requests.Session>
Sessionsobjektet som ska användas för http-begäranden.
- connection_string
- str
Om detta anges åsidosätts alla andra parametrar förutom begärandesessionen. Se http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ för formatet anslutningssträng.
- socket_timeout
- int
Om detta anges åsidosätts standardtimeout för socket. Den angivna tidsgränsen anges i sekunder. Standardvärdet finns i DEFAULT_SOCKET_TIMEOUT i _constants.py.
- token_credential
En tokenautentiseringsuppgift som används för att autentisera HTTPS-begäranden. Tokenvärdet bör uppdateras innan det upphör att gälla.
Variabler
- encode_function
- <xref:function>(<xref:data>)
En funktion som används för att koda kömeddelanden. Tar som parameter de data som skickas till put_message-API:et och returnerar det kodade meddelandet. Standardinställningen är att ta text- och XML-kodning, men byte och andra kodningar kan användas. Till exempel kan base64 vara att föredra för att utveckla över flera Azure Storage-bibliotek på olika språk. QueueMessageFormat Se for xml-, base64- och no encoding-metoder samt binära motsvarigheter.
- decode_function
- <xref:function>(<xref:data>)
En funktion som används för att koda avkoda meddelanden. Tar som parameter de data som returneras av get_messages- och peek_messages-API:erna och returnerar det avkodade meddelandet. Standardvärdet är att returnera text- och XML-avkodning, men byte och andra avkodningar kan användas. Till exempel kan base64 vara att föredra för att utveckla över flera Azure Storage-bibliotek på olika språk. QueueMessageFormat Se for xml-, base64- och no avkodningsmetoder samt binära motsvarigheter.
- key_encryption_key
- object
Nyckelkrypteringsnyckeln som eventuellt tillhandahålls av användaren. Om detta anges används för att kryptera/dekryptera i metoder som stöds. För metoder som kräver dekryptering måste antingen key_encryption_key ELLER matcharen anges. Om båda anges har matcharen företräde. Måste implementera följande metoder för API:er som kräver kryptering: wrap_key(nyckel)–omsluter den angivna nyckeln (byte) med hjälp av en algoritm som användaren väljer. Returnerar den krypterade nyckeln som byte. get_key_wrap_algorithm()– returnerar algoritmen som används för att omsluta den angivna symmetriska nyckeln. get_kid()– returnerar ett strängnyckel-ID för den här nyckelkrypteringsnyckeln. Måste implementera följande metoder för API:er som kräver dekryptering: unwrap_key(nyckel, algoritm)– returnerar den owrappade formen av den angivna symmetriska nyckeln med hjälp av den strängdefinierade algoritmen. get_kid()– returnerar ett strängnyckel-ID för den här nyckelkrypteringsnyckeln.
- key_resolver_function
- kid) (<xref:function>
En funktion för att matcha nycklar som tillhandahålls av användaren. Om detta anges kommer att användas för att dekryptera i metoder som stöds. För metoder som kräver dekryptering måste antingen key_encryption_key ELLER matcharen anges. Om båda anges har matcharen företräde. Den använder barnsträngen för att returnera en nyckelkrypteringsnyckel som implementerar gränssnittet som definierats ovan.
- require_encryption
- bool
En flagga som kan ställas in för att säkerställa att alla meddelanden har laddats upp till kön och att alla som laddats ned och lästs från kön har krypterats på servern. Om den här flaggan anges måste alla obligatoriska parametrar för kryptering/dekryptering anges. Se kommentarerna ovan på key_encryption_key och resolver.
Metoder
| clear_messages |
Tar bort alla meddelanden från den angivna kön. |
| create_queue |
Skapar en kö under det angivna kontot. |
| delete_message |
Tar bort det angivna meddelandet. Normalt när en klient hämtar ett meddelande med den get_messages åtgärden förväntas klienten bearbeta och ta bort meddelandet. Om du vill ta bort meddelandet måste du ha två dataobjekt: ID och pop_receipt. ID:t returneras från föregående get_messages åtgärd. Den pop_receipt returneras från den senaste get_messages åtgärden eller update_message åtgärden. För att den delete_message åtgärden ska lyckas måste pop_receipt som anges i begäran matcha pop_receipt som returneras från get_messages åtgärden eller update_message . |
| delete_queue |
Tar bort den angivna kön och eventuella meddelanden som den innehåller. När en kö har tagits bort markeras den omedelbart för borttagning och är inte längre tillgänglig för klienter. Kön tas senare bort från kötjänsten under skräpinsamlingen. Observera att det sannolikt tar minst 40 sekunder att ta bort en kö. Om en åtgärd görs mot kön medan den togs bort utlöses en <xref:azure.storage.queue.queueservice.AzureConflictHttpError> . |
| exists |
Returnerar ett booleskt värde som anger om kön finns. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Genererar en signatur för delad åtkomst för kötjänsten. Använd den returnerade signaturen med parametern sas_token i QueueService. |
| generate_queue_shared_access_signature |
Genererar en signatur för delad åtkomst för kön. Använd den returnerade signaturen med parametern sas_token i QueueService. |
| get_messages |
Hämtar ett eller flera meddelanden längst fram i kön. När ett meddelande hämtas från kön innehåller svaret meddelandeinnehållet och ett pop_receipt värde, vilket krävs för att ta bort meddelandet. Meddelandet tas inte bort automatiskt från kön, men när det har hämtats visas det inte för andra klienter för det tidsintervall som anges av parametern visibility_timeout. Om fältet key-encryption-key eller resolver har angetts för det lokala tjänstobjektet dekrypteras meddelandena innan de returneras. |
| get_queue_acl |
Returnerar information om lagrade åtkomstprinciper som anges i kön och som kan användas med signaturer för delad åtkomst. |
| get_queue_metadata |
Hämtar användardefinierade metadata och köegenskaper i den angivna kön. Metadata associeras med kön som namn/värde-par. |
| get_queue_service_properties |
Hämtar egenskaperna för ett lagringskontos kötjänst, inklusive loggning, analys och CORS-regler. |
| get_queue_service_stats |
Hämtar statistik relaterad till replikering för kötjänsten. Den är endast tillgänglig när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot. Med geo-redundant replikering underhåller Azure Storage dina data på två platser. På båda platserna upprätthåller Azure Storage ständigt flera felfria repliker av dina data. Den plats där du läser, skapar, uppdaterar eller tar bort data är den primära lagringskontoplatsen. Den primära platsen finns i den region som du väljer när du skapar ett konto via den klassiska Azure-portalen för Azure-hantering, till exempel USA, norra centrala. Platsen som dina data replikeras till är den sekundära platsen. Den sekundära platsen bestäms automatiskt baserat på platsen för den primära platsen. det finns i ett andra datacenter som finns i samma region som den primära platsen. Skrivskyddad åtkomst är tillgänglig från den sekundära platsen, om geo-redundant replikering med läsbehörighet är aktiverad för ditt lagringskonto. |
| list_queues |
Returnerar en generator för att visa en lista över köerna. Generatorn följer lazily fortsättningstoken som returneras av tjänsten och stoppas när alla köer har returnerats eller num_results nås. Om num_results anges och kontot har fler än det antalet köer har generatorn ett ifyllt next_marker fält när det är klart. Den här markören kan användas för att skapa en ny generator om fler resultat önskas. |
| peek_messages |
Hämtar ett eller flera meddelanden längst fram i kön, men ändrar inte meddelandets synlighet. Endast meddelanden som är synliga kan hämtas. När ett meddelande hämtas för första gången med ett anrop till get_messages anges dess egenskap dequeue_count till 1. Om den inte tas bort och sedan hämtas igen ökas egenskapen dequeue_count. Klienten kan använda det här värdet för att avgöra hur många gånger ett meddelande har hämtats. Observera att ett anrop till peek_messages inte ökar värdet för DequeueCount, utan returnerar det här värdet för klienten att läsa. Om fältet key-encryption-key eller resolver har angetts för det lokala tjänstobjektet dekrypteras meddelandena innan de returneras. |
| put_message |
Lägger till ett nytt meddelande på baksidan av meddelandekön. Tidsgränsen för synlighet anger den tid då meddelandet blir osynligt. När tidsgränsen går ut visas meddelandet. Om en tidsgräns för synlighet inte anges används standardvärdet 0. Meddelandet time to live anger hur länge ett meddelande ska finnas kvar i kön. Meddelandet tas bort från kön när time to live-perioden upphör att gälla. Om fältet key-encryption-key har angetts för det lokala tjänstobjektet krypterar den här metoden innehållet innan det laddas upp. |
| set_proxy |
Anger proxyserverns värd och port för HTTP CONNECT-tunnlar. |
| set_queue_acl |
Anger lagrade åtkomstprinciper för kön som kan användas med signaturer för delad åtkomst. När du anger behörigheter för en kö ersätts de befintliga behörigheterna. Om du vill uppdatera köns behörigheter anropar get_queue_acl du för att hämta alla åtkomstprinciper som är associerade med kön, ändrar åtkomstprincipen som du vill ändra och anropar sedan den här funktionen med den fullständiga datauppsättningen för att utföra uppdateringen. När du upprättar en lagrad åtkomstprincip i en kö kan det ta upp till 30 sekunder innan den börjar gälla. Under det här intervallet utlöser en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen en <xref:azure.storage.queue.queueservice.AzureHttpError> tills åtkomstprincipen blir aktiv. |
| set_queue_metadata |
Anger användardefinierade metadata i den angivna kön. Metadata associeras med kön som namn/värde-par. |
| set_queue_service_properties |
Anger egenskaperna för ett lagringskontos kötjänst, inklusive Azure Lagringsanalys. Om ett element (t.ex. loggning) lämnas som Ingen bevaras de befintliga inställningarna för tjänsten för den funktionen. Mer information om Azure Lagringsanalys finns i https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx. |
| update_message |
Uppdateringar visningstimeout för ett meddelande. Du kan också använda den här åtgärden för att uppdatera innehållet i ett meddelande. Den här åtgärden kan användas för att kontinuerligt utöka osynligheten för ett kömeddelande. Den här funktionen kan vara användbar om du vill att en arbetsroll ska "leasa" ett kömeddelande. Om en arbetsroll till exempel anropar get_messages och inser att den behöver mer tid för att bearbeta ett meddelande, kan den kontinuerligt utöka meddelandets osynlighet tills det bearbetas. Om arbetsrollen skulle misslyckas under bearbetningen blir meddelandet så småningom synligt igen och en annan arbetsroll kan bearbeta det. Om fältet key-encryption-key har angetts för det lokala tjänstobjektet krypterar den här metoden innehållet innan det laddas upp. |
clear_messages
Tar bort alla meddelanden från den angivna kön.
clear_messages(queue_name, timeout=None)Parametrar
create_queue
Skapar en kö under det angivna kontot.
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)Parametrar
- queue_name
- str
Namnet på kön som ska skapas. Ett könamn måste vara mellan 3 och 63 tecken långt och får bara innehålla gemener, siffror och bindestreck (-). De första och sista bokstäverna i kön måste vara alfanumeriska. Strecktecknet (-) får inte vara det första eller sista tecknet. Efterföljande bindestreck är inte tillåtna i könamnet.
En diktamen som innehåller namn/värde-par som ska associeras med kön som metadata. Observera att metadatanamn bevarar det skiftläge som de skapades med, men de är skiftlägesokänsliga när de anges eller läss.
Returer
Ett booleskt värde som anger om kön skapades. Om fail_on_exist har angetts till Sant utlöser detta i stället för att returnera falskt.
Returtyp
delete_message
Tar bort det angivna meddelandet.
Normalt när en klient hämtar ett meddelande med den get_messages åtgärden förväntas klienten bearbeta och ta bort meddelandet. Om du vill ta bort meddelandet måste du ha två dataobjekt: ID och pop_receipt. ID:t returneras från föregående get_messages åtgärd. Den pop_receipt returneras från den senaste get_messages åtgärden eller update_message åtgärden. För att den delete_message åtgärden ska lyckas måste pop_receipt som anges i begäran matcha pop_receipt som returneras från get_messages åtgärden eller update_message .
delete_message(queue_name, message_id, pop_receipt, timeout=None)Parametrar
- pop_receipt
- str
Ett giltigt popkvittovärde som returneras från ett tidigare anrop till get_messages eller update_message.
delete_queue
Tar bort den angivna kön och eventuella meddelanden som den innehåller.
När en kö har tagits bort markeras den omedelbart för borttagning och är inte längre tillgänglig för klienter. Kön tas senare bort från kötjänsten under skräpinsamlingen.
Observera att det sannolikt tar minst 40 sekunder att ta bort en kö. Om en åtgärd görs mot kön medan den togs bort utlöses en <xref:azure.storage.queue.queueservice.AzureConflictHttpError> .
delete_queue(queue_name, fail_not_exist=False, timeout=None)Parametrar
Returer
Ett booleskt värde som anger om kön har tagits bort. Om fail_not_exist har angetts till Sant utlöser detta i stället för att returnera falskt.
Returtyp
exists
Returnerar ett booleskt värde som anger om kön finns.
exists(queue_name, timeout=None)Parametrar
Returer
Ett booleskt värde som anger om kön finns.
Returtyp
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parametrar
- retry_context
generate_account_shared_access_signature
Genererar en signatur för delad åtkomst för kötjänsten. Använd den returnerade signaturen med parametern sas_token i QueueService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parametrar
- resource_types
- <xref:ResourceTypes>
Anger de resurstyper som är tillgängliga med kontots SAS.
- permission
- <xref:AccountPermissions>
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger sip=168.1.5.65 eller sip=168.1.5.60-168.1.5.70 på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https,http. Se Protocol för möjliga värden.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
generate_queue_shared_access_signature
Genererar en signatur för delad åtkomst för kön. Använd den returnerade signaturen med parametern sas_token i QueueService.
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)Parametrar
- permission
- QueuePermissions
De behörigheter som är associerade med signaturen för delad åtkomst. Användaren är begränsad till åtgärder som tillåts av behörigheterna. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip.
Den tidpunkt då signaturen för delad åtkomst blir ogiltig. Krävs om inte ett ID anges som refererar till en lagrad åtkomstprincip som innehåller det här fältet. Det här fältet måste utelämnas om det har angetts i en associerad lagrad åtkomstprincip. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
Den tidpunkt då signaturen för delad åtkomst blir giltig. Om det utelämnas antas starttiden för det här anropet vara den tid då lagringstjänsten tar emot begäran. Azure konverterar alltid värden till UTC. Om ett datum skickas in utan tidszonsinformation antas det vara UTC.
- id
- str
Ett unikt värde på upp till 64 tecken som korrelerar med en lagrad åtkomstprincip. Om du vill skapa en lagrad åtkomstprincip använder du set_queue_acl.
- ip
- str
Anger en IP-adress eller ett intervall med IP-adresser som begäranden ska accepteras från. Om IP-adressen som begäran kommer från inte matchar IP-adressen eller adressintervallet som anges i SAS-token autentiseras inte begäran. Om du till exempel anger sip='168.1.5.65' eller sip='168.1.5.60-168.1.5.70' på SAS begränsas begäran till dessa IP-adresser.
- protocol
- str
Anger vilket protokoll som tillåts för en begäran. Standardvärdet är https,http. Se Protocol för möjliga värden.
Returer
En sas-token (signatur för delad åtkomst).
Returtyp
get_messages
Hämtar ett eller flera meddelanden längst fram i kön.
När ett meddelande hämtas från kön innehåller svaret meddelandeinnehållet och ett pop_receipt värde, vilket krävs för att ta bort meddelandet. Meddelandet tas inte bort automatiskt från kön, men när det har hämtats visas det inte för andra klienter för det tidsintervall som anges av parametern visibility_timeout.
Om fältet key-encryption-key eller resolver har angetts för det lokala tjänstobjektet dekrypteras meddelandena innan de returneras.
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)Parametrar
- num_messages
- int
Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska hämtas från kön, upp till högst 32. Om färre visas returneras de synliga meddelandena. Som standard hämtas ett enda meddelande från kön med den här åtgärden.
- visibility_timeout
- int
Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertiden. Det nya värdet måste vara större än eller lika med 1 sekund och får inte vara större än 7 dagar. Tidsgränsen för ett meddelandes synlighet kan anges till ett värde senare än förfallotiden.
Returer
Ett QueueMessage objekt som representerar den information som skickas.
Returtyp
get_queue_acl
Returnerar information om lagrade åtkomstprinciper som anges i kön och som kan användas med signaturer för delad åtkomst.
get_queue_acl(queue_name, timeout=None)Parametrar
Returer
En ordlista med åtkomstprinciper som är associerade med kön.
Returtyp
get_queue_metadata
Hämtar användardefinierade metadata och köegenskaper i den angivna kön. Metadata associeras med kön som namn/värde-par.
get_queue_metadata(queue_name, timeout=None)Parametrar
Returer
En ordlista som representerar kömetadata med en approximate_message_count int-egenskap på diktaten som beräknar antalet meddelanden i kön.
Returtyp
get_queue_service_properties
Hämtar egenskaperna för ett lagringskontos kötjänst, inklusive loggning, analys och CORS-regler.
get_queue_service_properties(timeout=None)Parametrar
Returer
Kötjänstens egenskaper.
Returtyp
get_queue_service_stats
Hämtar statistik relaterad till replikering för kötjänsten. Den är endast tillgänglig när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot.
Med geo-redundant replikering underhåller Azure Storage dina data på två platser. På båda platserna upprätthåller Azure Storage ständigt flera felfria repliker av dina data. Den plats där du läser, skapar, uppdaterar eller tar bort data är den primära lagringskontoplatsen. Den primära platsen finns i den region som du väljer när du skapar ett konto via den klassiska Azure-portalen för Azure-hantering, till exempel USA, norra centrala. Platsen som dina data replikeras till är den sekundära platsen. Den sekundära platsen bestäms automatiskt baserat på platsen för den primära platsen. det finns i ett andra datacenter som finns i samma region som den primära platsen. Skrivskyddad åtkomst är tillgänglig från den sekundära platsen, om geo-redundant replikering med läsbehörighet är aktiverad för ditt lagringskonto.
get_queue_service_stats(timeout=None)Parametrar
Returer
Kötjänstens statistik.
Returtyp
list_queues
Returnerar en generator för att visa en lista över köerna. Generatorn följer lazily fortsättningstoken som returneras av tjänsten och stoppas när alla köer har returnerats eller num_results nås.
Om num_results anges och kontot har fler än det antalet köer har generatorn ett ifyllt next_marker fält när det är klart. Den här markören kan användas för att skapa en ny generator om fler resultat önskas.
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parametrar
- prefix
- str
Filtrerar resultatet så att endast köer returneras med namn som börjar med det angivna prefixet.
- marker
- str
En täckande fortsättningstoken. Det här värdet kan hämtas från fältet next_marker i ett tidigare generatorobjekt om num_results har angetts och generatorn har räknat upp resultat. Om den här generatorn anges börjar den returnera resultat från den punkt där den tidigare generatorn stoppades.
- timeout
- int
Serverns tidsgräns uttryckt i sekunder. Den här funktionen kan göra flera anrop till tjänsten. I så fall tillämpas det angivna tidsgränsvärdet på varje enskilt anrop.
peek_messages
Hämtar ett eller flera meddelanden längst fram i kön, men ändrar inte meddelandets synlighet.
Endast meddelanden som är synliga kan hämtas. När ett meddelande hämtas för första gången med ett anrop till get_messages anges dess egenskap dequeue_count till 1. Om den inte tas bort och sedan hämtas igen ökas egenskapen dequeue_count. Klienten kan använda det här värdet för att avgöra hur många gånger ett meddelande har hämtats. Observera att ett anrop till peek_messages inte ökar värdet för DequeueCount, utan returnerar det här värdet för klienten att läsa.
Om fältet key-encryption-key eller resolver har angetts för det lokala tjänstobjektet dekrypteras meddelandena innan de returneras.
peek_messages(queue_name, num_messages=None, timeout=None)Parametrar
- num_messages
- int
Ett heltalsvärde som inte är noll och som anger hur många meddelanden som ska granskas från kön, upp till högst 32. Som standard granskas ett enskilt meddelande från kön med den här åtgärden.
Returer
En lista över QueueMessage objekt. Observera att time_next_visible och pop_receipt inte fylls i eftersom peek inte visar meddelandet och bara kan hämta meddelanden som redan visas.
Returtyp
put_message
Lägger till ett nytt meddelande på baksidan av meddelandekön.
Tidsgränsen för synlighet anger den tid då meddelandet blir osynligt. När tidsgränsen går ut visas meddelandet. Om en tidsgräns för synlighet inte anges används standardvärdet 0.
Meddelandet time to live anger hur länge ett meddelande ska finnas kvar i kön. Meddelandet tas bort från kön när time to live-perioden upphör att gälla.
Om fältet key-encryption-key har angetts för det lokala tjänstobjektet krypterar den här metoden innehållet innan det laddas upp.
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)Parametrar
- content
- <xref:obj>
Meddelandeinnehåll. Den tillåtna typen bestäms av encode_function anges för tjänsten. Standardvärdet är str. Det kodade meddelandet kan vara upp till 64 kB stort.
- visibility_timeout
- int
Om det inte anges är standardvärdet 0. Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertiden. Värdet måste vara större än eller lika med 0 och får inte vara större än 7 dagar. Tidsgränsen för ett meddelandes synlighet kan inte anges till ett värde senare än förfallotiden. visibility_timeout ska anges till ett värde som är mindre än time to live-värdet.
- time_to_live
- int
Anger time to live-intervallet för meddelandet i sekunder. Time-to-live kan vara ett positivt tal eller -1 för oändligheten. Om den här parametern utelämnas är standardvärdet time to live 7 dagar.
Returer
Ett QueueMessage -objekt. Det här objektet fylls också med innehållet även om det inte returneras från tjänsten.
Returtyp
set_proxy
Anger proxyserverns värd och port för HTTP CONNECT-tunnlar.
set_proxy(host, port, user=None, password=None)Parametrar
set_queue_acl
Anger lagrade åtkomstprinciper för kön som kan användas med signaturer för delad åtkomst.
När du anger behörigheter för en kö ersätts de befintliga behörigheterna. Om du vill uppdatera köns behörigheter anropar get_queue_acl du för att hämta alla åtkomstprinciper som är associerade med kön, ändrar åtkomstprincipen som du vill ändra och anropar sedan den här funktionen med den fullständiga datauppsättningen för att utföra uppdateringen.
När du upprättar en lagrad åtkomstprincip i en kö kan det ta upp till 30 sekunder innan den börjar gälla. Under det här intervallet utlöser en signatur för delad åtkomst som är associerad med den lagrade åtkomstprincipen en <xref:azure.storage.queue.queueservice.AzureHttpError> tills åtkomstprincipen blir aktiv.
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)Parametrar
- signed_identifiers
- dict(str, AccessPolicy)
En ordlista med åtkomstprinciper som ska associeras med kön. Ordlistan kan innehålla upp till 5 element. En tom ordlista rensar de åtkomstprinciper som angetts för tjänsten.
set_queue_metadata
Anger användardefinierade metadata i den angivna kön. Metadata associeras med kön som namn/värde-par.
set_queue_metadata(queue_name, metadata=None, timeout=None)Parametrar
- metadata
- dict
En diktamen som innehåller namn/värde-par som ska associeras med kön som metadata.
set_queue_service_properties
Anger egenskaperna för ett lagringskontos kötjänst, inklusive Azure Lagringsanalys. Om ett element (t.ex. loggning) lämnas som Ingen bevaras de befintliga inställningarna för tjänsten för den funktionen. Mer information om Azure Lagringsanalys finns i 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)Parametrar
- logging
- <xref:Logging>
Loggningsinställningarna tillhandahåller begärandeloggar.
- hour_metrics
- <xref:Metrics>
Inställningarna för timmått ger en sammanfattning av begärandestatistik grupperad efter API i timaggregeringar för köer.
- minute_metrics
- <xref:Metrics>
Minutmåttinställningarna tillhandahåller begärandestatistik för varje minut för köer.
- cors
- list(CorsRule)
Du kan inkludera upp till fem CorsRule-element i listan. Om en tom lista anges tas alla CORS-regler bort och CORS inaktiveras för tjänsten. Detaljerad information om CORS-regler och utvärderingslogik finns i https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
update_message
Uppdateringar visningstimeout för ett meddelande. Du kan också använda den här åtgärden för att uppdatera innehållet i ett meddelande.
Den här åtgärden kan användas för att kontinuerligt utöka osynligheten för ett kömeddelande. Den här funktionen kan vara användbar om du vill att en arbetsroll ska "leasa" ett kömeddelande. Om en arbetsroll till exempel anropar get_messages och inser att den behöver mer tid för att bearbeta ett meddelande, kan den kontinuerligt utöka meddelandets osynlighet tills det bearbetas. Om arbetsrollen skulle misslyckas under bearbetningen blir meddelandet så småningom synligt igen och en annan arbetsroll kan bearbeta det.
Om fältet key-encryption-key har angetts för det lokala tjänstobjektet krypterar den här metoden innehållet innan det laddas upp.
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)Parametrar
- pop_receipt
- str
Ett giltigt popkvittovärde som returneras från ett tidigare anrop till get_messages åtgärden eller update_message .
- visibility_timeout
- int
Anger det nya tidsgränsvärdet för synlighet, i sekunder, i förhållande till servertiden. Det nya värdet måste vara större än eller lika med 0 och får inte vara större än 7 dagar. Tidsgränsen för ett meddelandes synlighet kan inte anges till ett värde senare än förfallotiden. Ett meddelande kan uppdateras tills det har tagits bort eller har upphört att gälla.
- content
- <xref:obj>
Meddelandeinnehåll. Den tillåtna typen bestäms av encode_function anges för tjänsten. Standardvärdet är str.
Returer
En lista över QueueMessage objekt. För enkelhetens skull fylls det här objektet också med innehållet, även om det inte returneras av tjänsten.
Returtyp
Attribut
protocol
request_session
socket_timeout
Azure SDK for Python