QueueService Classe
Si tratta della classe principale che gestisce le risorse della coda.
Il servizio di accodamento archivia i messaggi. Una coda può contenere un numero illimitato di messaggi, ognuno dei quali può avere dimensioni fino a 64 KB. I messaggi vengono in genere aggiunti alla fine della coda e recuperati dall'inizio della coda, anche se il comportamento FIFO (first in, first out) non è garantito.
:type ~azure.storage.common.TokenCredential
- Ereditarietà
-
QueueService
Costruttore
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)Parametri
- account_name
- str
nome dell'account di archiviazione. Questa operazione viene usata per autenticare le richieste firmate con una chiave account e per costruire l'endpoint di archiviazione. È necessario a meno che non venga specificato un stringa di connessione.
- account_key
- str
Chiave dell'account di archiviazione. Questa operazione viene usata per l'autenticazione della chiave condivisa.
- sas_token
- str
Token di firma di accesso condiviso da usare per autenticare le richieste anziché la chiave dell'account. Se la chiave dell'account e il token sas sono entrambi specificati, la chiave dell'account verrà usata per firmare.
- is_emulated
- bool
Se usare l'emulatore. Il valore predefinito è False. Se specificato, eseguirà l'override di tutti gli altri parametri oltre a stringa di connessione e alla sessione di richiesta.
- protocol
- str
Protocollo da usare per le richieste. Impostazioni predefinite su https.
- endpoint_suffix
- str
Componente di base host dell'URL, meno il nome dell'account. Impostazione predefinita in Azure (core.windows.net). Eseguire l'override di questa opzione per usare il cloud cinese (core.chinacloudapi.cn).
- request_session
- <xref:requests.Session>
Oggetto sessione da usare per le richieste http.
- connection_string
- str
Se specificato, verrà eseguito l'override di tutti gli altri parametri oltre alla sessione di richiesta. Vedere http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ per il formato stringa di connessione.
- socket_timeout
- int
Se specificato, verrà eseguito l'override del timeout del socket predefinito. Il timeout specificato è in secondi. Vedere DEFAULT_SOCKET_TIMEOUT in _constants.py per il valore predefinito.
- token_credential
Credenziali del token usate per autenticare le richieste HTTPS. Il valore del token deve essere aggiornato prima della scadenza.
Variabili
- encode_function
- <xref:function>(<xref:data>)
Funzione usata per codificare i messaggi della coda. Accetta come parametro i dati passati all'API put_message e restituisce il messaggio codificato. L'impostazione predefinita accetta testo e codifica XML, ma è possibile usare byte e altre codifiche. Ad esempio, base64 può essere preferibile per lo sviluppo in più librerie di Archiviazione di Azure in linguaggi diversi. Vedere per QueueMessageFormat xml, base64 e nessun metodo di codifica, nonché equivalenti binari.
- decode_function
- <xref:function>(<xref:data>)
Funzione usata per codificare i messaggi di decodifica. Accetta come parametro i dati restituiti dalla get_messages e dalle API peek_messages e restituisce il messaggio decodificato. Per impostazione predefinita, viene restituito il testo e la decodifica xml, ma è possibile usare byte e altre decodifica. Ad esempio, base64 può essere preferibile per lo sviluppo in più librerie di Archiviazione di Azure in linguaggi diversi. Vedere per QueueMessageFormat xml, base64 e nessun metodo di decodifica, nonché equivalenti binari.
- key_encryption_key
- object
Chiave di crittografia della chiave fornita facoltativamente dall'utente. Se specificato, verrà usato per crittografare/decrittografare nei metodi supportati. Per i metodi che richiedono la decrittografia, è necessario specificare il key_encryption_key O il sistema di risoluzione. Se vengono forniti entrambi, il sistema di risoluzione avrà la precedenza. Deve implementare i metodi seguenti per le API che richiedono la crittografia: wrap_key(key)-esegue il wrapping della chiave specificata (byte) usando un algoritmo scelto dall'utente. Restituisce la chiave crittografata come byte. get_key_wrap_algorithm():restituisce l'algoritmo usato per eseguire il wrapping della chiave simmetrica specificata. get_kid()-restituisce un ID chiave stringa per questa chiave-crittografia-chiave. Deve implementare i metodi seguenti per le API che richiedono la decrittografia: unwrap_key(chiave, algoritmo)- restituisce la forma non di cui è stato fatto il wrapping della chiave simmetrica specificata usando l'algoritmo specificato dalla stringa. get_kid()-restituisce un ID chiave stringa per questa chiave-crittografia-chiave.
- key_resolver_function
- kid) (<xref:function>
Funzione per risolvere le chiavi fornite facoltativamente dall'utente. Se specificato, verrà usato per decrittografare nei metodi supportati. Per i metodi che richiedono la decrittografia, è necessario specificare il key_encryption_key O il sistema di risoluzione. Se vengono forniti entrambi, il sistema di risoluzione avrà la precedenza. Usa la stringa kid per restituire una chiave-crittografia-chiave che implementa l'interfaccia definita in precedenza.
- require_encryption
- bool
Flag che può essere impostato per garantire che tutti i messaggi caricati nella coda e tutti i messaggi scaricati e letti correttamente dalla coda siano/sono stati crittografati durante il server. Se questo flag è impostato, è necessario specificare tutti i parametri necessari per la crittografia/decrittografia. Vedere i commenti precedenti sull'key_encryption_key e sul sistema di risoluzione.
Metodi
| clear_messages |
Elimina tutti i messaggi dalla coda specificata. |
| create_queue |
Crea una coda nell'account specificato. |
| delete_message |
Elimina il messaggio specificato. Normalmente dopo che un client recupera un messaggio con l'operazione di get_messages, il client deve elaborare ed eliminare il messaggio. Per eliminare il messaggio, è necessario disporre di due elementi di dati: ID e pop_receipt. L'ID viene restituito dall'operazione di get_messages precedente. Il pop_receipt viene restituito dall'operazione o update_message dall'operazione più recenteget_messages. Affinché l'operazione di delete_message abbia esito positivo, il pop_receipt specificato nella richiesta deve corrispondere alla pop_receipt restituita dall'operazione get_messages o update_message . |
| delete_queue |
Elimina la coda specificata e tutti i messaggi contenuti. Quando una coda viene eliminata correttamente, viene contrassegnata immediatamente per l'eliminazione e non è più accessibile ai client. La coda verrà rimossa in seguito dal servizio di accodamento durante un'operazione di Garbage Collection. Si noti che l'eliminazione di una coda richiede almeno 40 secondi per completare. Se un'operazione viene tentata rispetto alla coda durante l'eliminazione, verrà generata un'operazione <xref:azure.storage.queue.queueservice.AzureConflictHttpError> . |
| exists |
Restituisce un valore booleano che indica se esiste la coda. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Genera una firma di accesso condiviso per il servizio code. Usare la firma restituita con il parametro sas_token di QueueService. |
| generate_queue_shared_access_signature |
Genera una firma di accesso condiviso per la coda. Usare la firma restituita con il parametro sas_token di QueueService. |
| get_messages |
Recupera uno o più messaggi dalla parte anteriore della coda. Quando un messaggio viene recuperato dalla coda, la risposta include il contenuto del messaggio e un valore pop_receipt, necessario per eliminare il messaggio. Il messaggio non viene eliminato automaticamente dalla coda, ma dopo che è stato recuperato, non è visibile ad altri client per l'intervallo di tempo specificato dal parametro visibility_timeout. Se il campo key-encryption-key o resolver è impostato sull'oggetto servizio locale, i messaggi verranno decrittografati prima di essere restituiti. |
| get_queue_acl |
Restituisce informazioni dettagliate sui criteri di accesso archiviati specificati nella coda che possono essere usati con firme di accesso condiviso. |
| get_queue_metadata |
Recupera le proprietà dei metadati e delle code definite dall'utente nella coda specificata. I metadati vengono associati alla coda come coppie nome-valore. |
| get_queue_service_properties |
Ottiene le proprietà del servizio code di un account di archiviazione, tra cui la registrazione, l'analisi e le regole CORS. |
| get_queue_service_stats |
Recupera le statistiche correlate alla replica per il servizio di accodamento. È disponibile solo quando la replica con ridondanza geografica di accesso in lettura è abilitata per l'account di archiviazione. Con la replica geograficamente ridondante, Archiviazione di Azure mantiene i dati durevoli in due posizioni. In entrambe le posizioni Archiviazione di Azure gestisce costantemente più repliche integre dei dati. La posizione in cui si leggono, creano, aggiornano o eliminano i dati è la posizione dell'account di archiviazione primaria. La posizione primaria esiste nell'area scelta al momento della creazione di un account tramite il portale di Azure Management Azure classico, ad esempio Stati Uniti centro-settentrionali. La posizione in cui i dati vengono replicati è la posizione secondaria. La posizione secondaria viene determinata automaticamente in base alla posizione primaria. Si tratta di un secondo data center che risiede nella stessa area geografica della posizione primaria. Dalla posizione secondaria è disponibile l'accesso in sola lettura se la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione. |
| list_queues |
Restituisce un generatore per elencare le code. Il generatore seguirà in modo pigro i token di continuazione restituiti dal servizio e arresterà quando tutte le code sono state restituite o num_results viene raggiunto. Se num_results è specificato e l'account ha più di quel numero di code, il generatore avrà un campo next_marker popolato al termine. Questo marcatore può essere usato per creare un nuovo generatore se sono desiderati altri risultati. |
| peek_messages |
Recupera uno o più messaggi dalla parte anteriore della coda, ma non modifica la visibilità del messaggio. È possibile recuperare solo i messaggi visibili. Quando un messaggio viene recuperato per la prima volta con una chiamata a get_messages, la relativa proprietà dequeue_count è impostata su 1. Se non viene eliminato e viene recuperato di nuovo, la proprietà dequeue_count viene incrementata. Il client può utilizzare questo valore per determinare quante volte è stato recuperato un messaggio. Si noti che una chiamata a peek_messages non incrementa il valore di DequeueCount, ma restituisce questo valore per il client da leggere. Se il campo key-encryption-key o resolver è impostato sull'oggetto servizio locale, i messaggi verranno decrittografati prima di essere restituiti. |
| put_message |
Aggiunge un nuovo messaggio alla parte posteriore della coda dei messaggi. Il timeout della visibilità specifica l'ora in cui il messaggio sarà invisibile. Alla scadenza del timeout, il messaggio diventerà visibile. Se non viene specificato alcun timeout di visibilità, viene usato il valore predefinito 0. Il time-to-live del messaggio specifica per quanto tempo un messaggio rimarrà nella coda. Il messaggio verrà eliminato dalla coda alla scadenza del periodo TTL. Se il campo key-encryption-key è impostato nell'oggetto servizio locale, questo metodo crittograferà il contenuto prima del caricamento. |
| set_proxy |
Imposta l'host del server proxy e la porta per il tunneling HTTP CONNECT. |
| set_queue_acl |
Imposta i criteri di accesso archiviati per la coda da utilizzare con firme di accesso condiviso. Quando si impostano le autorizzazioni per una coda, le autorizzazioni esistenti vengono sostituite. Per aggiornare le autorizzazioni della coda, chiamare get_queue_acl per recuperare tutti i criteri di accesso associati alla coda, modificare i criteri di accesso da modificare e quindi chiamare questa funzione con il set completo di dati per eseguire l'aggiornamento. La creazione di un criterio di accesso archiviato in una coda potrebbe richiedere fino a 30 secondi. Durante questo intervallo, una firma di accesso condiviso associata ai criteri di accesso archiviati genererà un'eccezione <xref:azure.storage.queue.queueservice.AzureHttpError> fino a quando i criteri di accesso non diventano attivi. |
| set_queue_metadata |
Imposta i metadati definiti dall'utente nella coda specificata. I metadati vengono associati alla coda come coppie nome-valore. |
| set_queue_service_properties |
Imposta le proprietà del servizio di accodamento di un account di archiviazione, incluso Azure Analisi archiviazione. Se un elemento (ad esempio Logging) viene lasciato come Nessuno, le impostazioni esistenti nel servizio per tale funzionalità vengono mantenute. Per altre informazioni su Azure Analisi archiviazione, vedere https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx. |
| update_message |
Aggiornamenti il timeout di visibilità di un messaggio. È anche possibile usare questa operazione per aggiornare il contenuto di un messaggio. Questa operazione può essere usata per estendere continuamente l'invisibilità di un messaggio della coda. Questa funzionalità può essere utile se si vuole che un ruolo di lavoro "lease" un messaggio della coda. Ad esempio, se un ruolo di lavoro chiama get_messages e riconosce che richiede più tempo per elaborare un messaggio, può estendere continuamente l'invisibilità del messaggio fino a quando non viene elaborata. Se il ruolo di lavoro restituisse un errore durante l'elaborazione, il messaggio diventerebbe nuovamente visibile e verrebbe elaborato da un altro ruolo di lavoro. Se il campo key-encryption-key è impostato nell'oggetto servizio locale, questo metodo crittograferà il contenuto prima del caricamento. |
clear_messages
Elimina tutti i messaggi dalla coda specificata.
clear_messages(queue_name, timeout=None)Parametri
create_queue
Crea una coda nell'account specificato.
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)Parametri
- queue_name
- str
Nome della coda da creare. Un nome della coda deve essere compreso tra 3 e 63 caratteri e può contenere solo lettere minuscole, numeri e carattere trattino (-). La prima e l'ultima lettera nella coda devono essere alfanumerici. Il trattino (-) non può essere né il primo né l'ultimo carattere. Non è consentito utilizzare caratteri di trattino consecutivi in un nome di coda.
Un dict contenente coppie nome-valore da associare alla coda come metadati. Si noti che i nomi dei metadati mantengono la distinzione tra maiuscole e minuscole con cui sono stati creati, ma quando vengono impostati o letti tale distinzione è irrilevante.
- fail_on_exist
- bool
Specifica se generare un'eccezione se la coda esiste già.
Restituisce
Valore booleano che indica se è stata creata la coda. Se fail_on_exist è stato impostato su True, verrà generata invece di restituire false.
Tipo restituito
delete_message
Elimina il messaggio specificato.
Normalmente dopo che un client recupera un messaggio con l'operazione di get_messages, il client deve elaborare ed eliminare il messaggio. Per eliminare il messaggio, è necessario disporre di due elementi di dati: ID e pop_receipt. L'ID viene restituito dall'operazione di get_messages precedente. Il pop_receipt viene restituito dall'operazione o update_message dall'operazione più recenteget_messages. Affinché l'operazione di delete_message abbia esito positivo, il pop_receipt specificato nella richiesta deve corrispondere alla pop_receipt restituita dall'operazione get_messages o update_message .
delete_message(queue_name, message_id, pop_receipt, timeout=None)Parametri
- pop_receipt
- str
Valore della ricevuta pop valido restituito da una chiamata precedente all'oggetto get_messages o update_message.
delete_queue
Elimina la coda specificata e tutti i messaggi contenuti.
Quando una coda viene eliminata correttamente, viene contrassegnata immediatamente per l'eliminazione e non è più accessibile ai client. La coda verrà rimossa in seguito dal servizio di accodamento durante un'operazione di Garbage Collection.
Si noti che l'eliminazione di una coda richiede almeno 40 secondi per completare. Se un'operazione viene tentata rispetto alla coda durante l'eliminazione, verrà generata un'operazione <xref:azure.storage.queue.queueservice.AzureConflictHttpError> .
delete_queue(queue_name, fail_not_exist=False, timeout=None)Parametri
- fail_not_exist
- bool
Specifica se generare un'eccezione se la coda non esiste.
Restituisce
Valore booleano che indica se la coda è stata eliminata. Se fail_not_exist è stato impostato su True, verrà generata invece di restituire false.
Tipo restituito
exists
Restituisce un valore booleano che indica se esiste la coda.
exists(queue_name, timeout=None)Parametri
Restituisce
Valore booleano che indica se esiste la coda.
Tipo restituito
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parametri
- retry_context
generate_account_shared_access_signature
Genera una firma di accesso condiviso per il servizio code. Usare la firma restituita con il parametro sas_token di QueueService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parametri
- resource_types
- <xref:ResourceTypes>
Specifica i tipi di risorse accessibili con la firma di accesso condiviso dell'account.
- permission
- <xref:AccountPermissions>
Le autorizzazioni associate alla firma di accesso condiviso. L'utente può eseguire solo le operazioni consentite dalle autorizzazioni. Obbligatorio a meno che non venga specificato un ID che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati.
Ora in cui la firma di accesso condiviso non è valida. Obbligatorio a meno che non venga specificato un ID che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.
Ora in cui la firma di accesso condiviso diventa valida. Se omesso, come ora di inizio di questa chiamata verrà considerata l'ora in cui il servizio di archiviazione riceve la richiesta. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.
- ip
- str
Specifica un indirizzo IP o un intervallo di indirizzi IP da cui accettare le richieste. Se l'indirizzo IP da cui proviene la richiesta non corrisponde all'indirizzo IP o all'intervallo di indirizzi specificato nel token di firma di accesso condiviso, la richiesta non viene autenticata. Ad esempio, specificando sip=168.1.5.65 o sip=168.1.5.60-168.1.5.70 sulla firma di accesso condiviso limita la richiesta a tali indirizzi IP.
- protocol
- str
Specifica il protocollo consentito per una richiesta effettuata. Il valore predefinito è https,http. Per i valori possibili, vedere Protocol.
Restituisce
Token firma di accesso condiviso (sas).
Tipo restituito
generate_queue_shared_access_signature
Genera una firma di accesso condiviso per la coda. Usare la firma restituita con il parametro sas_token di QueueService.
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)Parametri
- permission
- QueuePermissions
Le autorizzazioni associate alla firma di accesso condiviso. L'utente può eseguire solo le operazioni consentite dalle autorizzazioni. Obbligatorio a meno che non venga specificato un ID che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati.
Ora in cui la firma di accesso condiviso non è valida. Obbligatorio a meno che non venga specificato un ID che fa riferimento a un criterio di accesso archiviato che contiene questo campo. Questo campo deve essere omesso se è stato specificato nei criteri di accesso archiviati associati. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.
Ora in cui la firma di accesso condiviso diventa valida. Se omesso, come ora di inizio di questa chiamata verrà considerata l'ora in cui il servizio di archiviazione riceve la richiesta. Azure converte sempre i valori in FORMATO UTC. Se una data viene passata senza informazioni sul fuso orario, si presuppone che sia UTC.
- id
- str
Valore univoco fino a 64 caratteri di lunghezza che correla a un criterio di accesso archiviato. Per creare criteri di accesso archiviati, usare set_queue_acl.
- ip
- str
Specifica un indirizzo IP o un intervallo di indirizzi IP da cui accettare le richieste. Se l'indirizzo IP da cui proviene la richiesta non corrisponde all'indirizzo IP o all'intervallo di indirizzi specificato nel token di firma di accesso condiviso, la richiesta non viene autenticata. Ad esempio, specificando sip='168.1.5.65' o sip='168.1.5.60-168.1.5.70' nella firma di accesso condiviso limita la richiesta a tali indirizzi IP.
- protocol
- str
Specifica il protocollo consentito per una richiesta effettuata. Il valore predefinito è https,http. Per i valori possibili, vedere Protocol.
Restituisce
Token firma di accesso condiviso (sas).
Tipo restituito
get_messages
Recupera uno o più messaggi dalla parte anteriore della coda.
Quando un messaggio viene recuperato dalla coda, la risposta include il contenuto del messaggio e un valore pop_receipt, necessario per eliminare il messaggio. Il messaggio non viene eliminato automaticamente dalla coda, ma dopo che è stato recuperato, non è visibile ad altri client per l'intervallo di tempo specificato dal parametro visibility_timeout.
Se il campo key-encryption-key o resolver è impostato sull'oggetto servizio locale, i messaggi verranno decrittografati prima di essere restituiti.
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)Parametri
- num_messages
- int
Valore intero diverso da zero che specifica il numero di messaggi da recuperare nella coda, fino a un massimo di 32. Verranno restituiti i messaggi visibili. Per impostazione predefinita, un singolo messaggio viene recuperato dalla coda con questa operazione.
- visibility_timeout
- int
Specifica il nuovo valore di timeout di visibilità, in secondi, rispetto all'ora del server. Il nuovo valore deve essere maggiore o uguale a 1 secondo e non può essere maggiore di 7 giorni. Il timeout di visibilità di un messaggio può essere impostato su un valore successivo all'ora di scadenza.
Restituisce
Oggetto QueueMessage che rappresenta le informazioni passate.
Tipo restituito
get_queue_acl
Restituisce informazioni dettagliate sui criteri di accesso archiviati specificati nella coda che possono essere usati con firme di accesso condiviso.
get_queue_acl(queue_name, timeout=None)Parametri
Restituisce
Dizionario dei criteri di accesso associati alla coda.
Tipo restituito
get_queue_metadata
Recupera le proprietà dei metadati e delle code definite dall'utente nella coda specificata. I metadati vengono associati alla coda come coppie nome-valore.
get_queue_metadata(queue_name, timeout=None)Parametri
Restituisce
Dizionario che rappresenta i metadati della coda con una proprietà approximate_message_count int nella dict stimando il numero di messaggi nella coda.
Tipo restituito
get_queue_service_properties
Ottiene le proprietà del servizio code di un account di archiviazione, tra cui la registrazione, l'analisi e le regole CORS.
get_queue_service_properties(timeout=None)Parametri
Restituisce
Proprietà del servizio di accodamento.
Tipo restituito
get_queue_service_stats
Recupera le statistiche correlate alla replica per il servizio di accodamento. È disponibile solo quando la replica con ridondanza geografica di accesso in lettura è abilitata per l'account di archiviazione.
Con la replica geograficamente ridondante, Archiviazione di Azure mantiene i dati durevoli in due posizioni. In entrambe le posizioni Archiviazione di Azure gestisce costantemente più repliche integre dei dati. La posizione in cui si leggono, creano, aggiornano o eliminano i dati è la posizione dell'account di archiviazione primaria. La posizione primaria esiste nell'area scelta al momento della creazione di un account tramite il portale di Azure Management Azure classico, ad esempio Stati Uniti centro-settentrionali. La posizione in cui i dati vengono replicati è la posizione secondaria. La posizione secondaria viene determinata automaticamente in base alla posizione primaria. Si tratta di un secondo data center che risiede nella stessa area geografica della posizione primaria. Dalla posizione secondaria è disponibile l'accesso in sola lettura se la replica geograficamente ridondante con accesso in lettura è abilitata per l'account di archiviazione.
get_queue_service_stats(timeout=None)Parametri
Restituisce
Statistiche del servizio di accodamento.
Tipo restituito
list_queues
Restituisce un generatore per elencare le code. Il generatore seguirà in modo pigro i token di continuazione restituiti dal servizio e arresterà quando tutte le code sono state restituite o num_results viene raggiunto.
Se num_results è specificato e l'account ha più di quel numero di code, il generatore avrà un campo next_marker popolato al termine. Questo marcatore può essere usato per creare un nuovo generatore se sono desiderati altri risultati.
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parametri
- prefix
- str
Filtra i risultati in modo che vengano restituite solo le code i cui nomi iniziano con il prefisso specificato.
- include_metadata
- bool
Specifica che i metadati del contenitore vengono restituiti nella risposta.
- marker
- str
Token di continuazione opaco. Questo valore può essere recuperato dal campo next_marker di un oggetto generatore precedente se è stato specificato num_results e che il generatore ha completato l'enumerazione dei risultati. Se specificato, questo generatore inizierà a restituire i risultati dal punto in cui è stato arrestato il generatore precedente.
- timeout
- int
Timeout del server espresso in secondi. Questa funzione può effettuare più chiamate al servizio in cui il valore di timeout specificato verrà applicato a ogni singola chiamata.
peek_messages
Recupera uno o più messaggi dalla parte anteriore della coda, ma non modifica la visibilità del messaggio.
È possibile recuperare solo i messaggi visibili. Quando un messaggio viene recuperato per la prima volta con una chiamata a get_messages, la relativa proprietà dequeue_count è impostata su 1. Se non viene eliminato e viene recuperato di nuovo, la proprietà dequeue_count viene incrementata. Il client può utilizzare questo valore per determinare quante volte è stato recuperato un messaggio. Si noti che una chiamata a peek_messages non incrementa il valore di DequeueCount, ma restituisce questo valore per il client da leggere.
Se il campo key-encryption-key o resolver è impostato sull'oggetto servizio locale, i messaggi verranno decrittografati prima di essere restituiti.
peek_messages(queue_name, num_messages=None, timeout=None)Parametri
- num_messages
- int
Valore intero diverso da zero che specifica il numero di messaggi da osservare nella coda, fino a un massimo di 32. Per impostazione predefinita, un singolo messaggio viene osservato dalla coda con questa operazione.
Restituisce
Elenco di oggetti QueueMessage. Si noti che time_next_visible e pop_receipt non verranno popolati come peek non popola il messaggio e può recuperare solo messaggi già visibili.
Tipo restituito
put_message
Aggiunge un nuovo messaggio alla parte posteriore della coda dei messaggi.
Il timeout della visibilità specifica l'ora in cui il messaggio sarà invisibile. Alla scadenza del timeout, il messaggio diventerà visibile. Se non viene specificato alcun timeout di visibilità, viene usato il valore predefinito 0.
Il time-to-live del messaggio specifica per quanto tempo un messaggio rimarrà nella coda. Il messaggio verrà eliminato dalla coda alla scadenza del periodo TTL.
Se il campo key-encryption-key è impostato nell'oggetto servizio locale, questo metodo crittograferà il contenuto prima del caricamento.
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)Parametri
- content
- <xref:obj>
Contenuto del messaggio. Il tipo consentito è determinato dal encode_function impostato nel servizio. Il valore predefinito è str. Il messaggio codificato può essere fino a 64 KB di dimensioni.
- visibility_timeout
- int
Il valore predefinito, utilizzato quando questo parametro non viene specificato, è 0. Specifica il nuovo valore di timeout di visibilità, in secondi, rispetto all'ora del server. Il valore deve essere maggiore o uguale a 0 e non può essere maggiore di 7 giorni. Il timeout di visibilità di un messaggio non può essere impostato su un valore successivo all'ora di scadenza. visibility_timeout deve essere impostato su un valore inferiore al valore tempo-to-live.
- time_to_live
- int
Specifica l'intervallo TTL del messaggio, in secondi. Il tempo da vivere può essere qualsiasi numero positivo o -1 per infinito. Se questo parametro viene omesso, il valore TTL predefinito è 7 giorni.
Restituisce
Un oggetto QueueMessage. Questo oggetto viene popolato anche con il contenuto anche se non viene restituito dal servizio.
Tipo restituito
set_proxy
Imposta l'host del server proxy e la porta per il tunneling HTTP CONNECT.
set_proxy(host, port, user=None, password=None)Parametri
set_queue_acl
Imposta i criteri di accesso archiviati per la coda da utilizzare con firme di accesso condiviso.
Quando si impostano le autorizzazioni per una coda, le autorizzazioni esistenti vengono sostituite. Per aggiornare le autorizzazioni della coda, chiamare get_queue_acl per recuperare tutti i criteri di accesso associati alla coda, modificare i criteri di accesso da modificare e quindi chiamare questa funzione con il set completo di dati per eseguire l'aggiornamento.
La creazione di un criterio di accesso archiviato in una coda potrebbe richiedere fino a 30 secondi. Durante questo intervallo, una firma di accesso condiviso associata ai criteri di accesso archiviati genererà un'eccezione <xref:azure.storage.queue.queueservice.AzureHttpError> fino a quando i criteri di accesso non diventano attivi.
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)Parametri
- signed_identifiers
- dict(str, AccessPolicy)
Dizionario dei criteri di accesso da associare alla coda. Il dizionario può contenere fino a 5 elementi. Un dizionario vuoto cancella i criteri di accesso impostati nel servizio.
set_queue_metadata
Imposta i metadati definiti dall'utente nella coda specificata. I metadati vengono associati alla coda come coppie nome-valore.
set_queue_metadata(queue_name, metadata=None, timeout=None)Parametri
- metadata
- dict
Dict contenente coppie nome-valore da associare alla coda come metadati.
set_queue_service_properties
Imposta le proprietà del servizio di accodamento di un account di archiviazione, incluso Azure Analisi archiviazione. Se un elemento (ad esempio Logging) viene lasciato come Nessuno, le impostazioni esistenti nel servizio per tale funzionalità vengono mantenute. Per altre informazioni su Azure Analisi archiviazione, vedere 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)Parametri
- logging
- <xref:Logging>
Le impostazioni di registrazione forniscono i log delle richieste.
- hour_metrics
- <xref:Metrics>
Le impostazioni delle metriche orarie forniscono un riepilogo delle statistiche delle richieste raggruppate per API in aggregazioni orarie per le code.
- minute_metrics
- <xref:Metrics>
Le impostazioni delle metriche minuti forniscono le statistiche delle richieste per ogni minuto per le code.
- cors
- list(CorsRule)
È possibile includere fino a cinque elementi CorsRule nell'elenco. Se viene specificato un elenco vuoto, tutte le regole CORS verranno eliminate e CORS verrà disabilitato per il servizio. Per informazioni dettagliate sulle regole CORS e sulla logica di valutazione, vedere https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
update_message
Aggiornamenti il timeout di visibilità di un messaggio. È anche possibile usare questa operazione per aggiornare il contenuto di un messaggio.
Questa operazione può essere usata per estendere continuamente l'invisibilità di un messaggio della coda. Questa funzionalità può essere utile se si vuole che un ruolo di lavoro "lease" un messaggio della coda. Ad esempio, se un ruolo di lavoro chiama get_messages e riconosce che richiede più tempo per elaborare un messaggio, può estendere continuamente l'invisibilità del messaggio fino a quando non viene elaborata. Se il ruolo di lavoro restituisse un errore durante l'elaborazione, il messaggio diventerebbe nuovamente visibile e verrebbe elaborato da un altro ruolo di lavoro.
Se il campo key-encryption-key è impostato nell'oggetto servizio locale, questo metodo crittograferà il contenuto prima del caricamento.
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)Parametri
- pop_receipt
- str
Valore di ricezione valido restituito da una chiamata precedente all'operazione get_messages o update_message.
- visibility_timeout
- int
Specifica il nuovo valore di timeout di visibilità, in secondi, rispetto all'ora del server. Il nuovo valore deve essere maggiore o uguale a 0 e non può essere superiore a 7 giorni. Il timeout di visibilità di un messaggio non può essere impostato su un valore successivo all'ora di scadenza. È possibile aggiornare un messaggio finché non scade o non viene eliminato.
- content
- <xref:obj>
Contenuto del messaggio. Il tipo consentito è determinato dal encode_function impostato nel servizio. Il valore predefinito è str.
Restituisce
Elenco di oggetti QueueMessage. Per praticità, questo oggetto viene popolato anche con il contenuto, anche se non viene restituito dal servizio.
Tipo restituito
Attributi
protocol
request_session
socket_timeout
Azure SDK for Python