QueueService Classe
Esta é a classe principal que gere os recursos de fila.
O serviço Fila armazena mensagens. Uma fila pode conter um número ilimitado de mensagens, cada uma das quais pode ter até 64 KB de tamanho. Geralmente, as mensagens são adicionadas ao final da fila e obtidas a partir da frente da fila, embora o comportamento do primeiro a entrar e primeiro a sair (FIFO) não seja garantido.
:type ~azure.storage.common.TokenCredential
- Herança
-
QueueService
Construtor
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)Parâmetros
- account_name
- str
O nome da conta de armazenamento. Isto é utilizado para autenticar pedidos assinados com uma chave de conta e para construir o ponto final de armazenamento. É necessário, a menos que seja dado um cadeia de ligação.
- account_key
- str
A chave da conta de armazenamento. Isto é utilizado para autenticação de chave partilhada.
- sas_token
- str
Um token de assinatura de acesso partilhado a utilizar para autenticar pedidos em vez da chave de conta. Se a chave da conta e o token sas forem ambos especificados, a chave de conta será utilizada para assinar.
- is_emulated
- bool
Se pretende utilizar o emulador. A predefinição é Falso. Se especificado, substituirá todos os outros parâmetros para além da sessão de pedido e cadeia de ligação.
- endpoint_suffix
- str
O componente base do anfitrião do URL, menos o nome da conta. É predefinida para o Azure (core.windows.net). Substitua esta opção para utilizar a cloud da China (core.chinacloudapi.cn).
- request_session
- <xref:requests.Session>
O objeto de sessão a utilizar para pedidos http.
- connection_string
- str
Se for especificado, esta ação substituirá todos os outros parâmetros para além da sessão de pedido. Veja http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ o formato cadeia de ligação.
- socket_timeout
- int
Se for especificado, isto substituirá o tempo limite do socket predefinido. O tempo limite especificado é em segundos. Veja DEFAULT_SOCKET_TIMEOUT em _constants.py para obter o valor predefinido.
- token_credential
Uma credencial de token utilizada para autenticar pedidos HTTPS. O valor do token deve ser atualizado antes da expiração.
Variáveis
- encode_function
- <xref:function>(<xref:data>)
Uma função utilizada para codificar mensagens de fila. Utiliza como parâmetro os dados transmitidos à API de put_message e devolve a mensagem codificada. A predefinição é utilizar texto e codificação xml, mas podem ser utilizados bytes e outras codificações. Por exemplo, a base64 pode ser preferível para desenvolver em várias bibliotecas de Armazenamento do Azure em idiomas diferentes. Veja os QueueMessageFormat métodos para xml, base64 e sem codificação, bem como equivalentes binários.
- decode_function
- <xref:function>(<xref:data>)
Uma função utilizada para codificar mensagens descodificação. Utiliza como parâmetro os dados devolvidos pelas APIs get_messages e peek_messages e devolve a mensagem descodificada. As predefinições para devolver texto e xml descodificam, mas podem ser utilizados bytes e outras descodificação. Por exemplo, a base64 pode ser preferível para desenvolver em várias bibliotecas de Armazenamento do Azure em idiomas diferentes. Veja os QueueMessageFormat métodos para xml, base64 e sem descodificação, bem como equivalentes binários.
- key_encryption_key
- object
A chave-encriptação-chave opcionalmente fornecida pelo utilizador. Se for fornecido, será utilizado para encriptar/desencriptar em métodos suportados. Para métodos que exijam a desencriptação, o key_encryption_key OU a resolução tem de ser fornecida. Se ambos forem fornecidos, a resolução terá precedência. Tem de implementar os seguintes métodos para APIs que requerem encriptação: wrap_key(chave)– molda a chave especificada (bytes) com um algoritmo à escolha do utilizador. Devolve a chave encriptada como bytes. get_key_wrap_algorithm()– devolve o algoritmo utilizado para moldar a chave simétrica especificada. get_kid()– devolve um ID de chave de cadeia para esta chave de encriptação de chave. Tem de implementar os seguintes métodos para APIs que requerem desencriptação: unwrap_key(chave, algoritmo)– devolve a forma desembrulhada da chave simétrica especificada com o algoritmo especificado pela cadeia. get_kid()– devolve um ID de chave de cadeia para esta chave de encriptação de chave.
- key_resolver_function
- kid) (<xref:function>
Uma função para resolver as chaves opcionalmente fornecidas pelo utilizador. Se for fornecido, será utilizado para desencriptar em métodos suportados. Para métodos que exijam a desencriptação, o key_encryption_key OU a resolução tem de ser fornecida. Se ambos forem fornecidos, a resolução terá precedência. Utiliza a cadeia de carateres para devolver uma chave de encriptação de chaves que implementa a interface definida acima.
- require_encryption
- bool
Um sinalizador que pode ser definido para garantir que todas as mensagens carregadas com êxito para a fila e todas as que foram transferidas e lidas com êxito a partir da fila são/foram encriptadas enquanto estavam no servidor. Se este sinalizador estiver definido, todos os parâmetros necessários para encriptação/desencriptação têm de ser fornecidos. Veja os comentários acima no key_encryption_key e resolver.
Métodos
| clear_messages |
Elimina todas as mensagens da fila especificada. |
| create_queue |
Cria uma fila na conta especificada. |
| delete_message |
Elimina a mensagem especificada. Normalmente, depois de um cliente obter uma mensagem com a operação de get_messages, espera-se que o cliente processe e elimine a mensagem. Para eliminar a mensagem, tem de ter dois itens de dados: id e pop_receipt. O ID é devolvido da operação de get_messages anterior. O pop_receipt é devolvido da operação ou update_message mais recenteget_messages. Para que a operação de delete_message seja bem-sucedida, o pop_receipt especificado no pedido tem de corresponder ao pop_receipt devolvido da get_messages operação ou update_message . |
| delete_queue |
Elimina a fila especificada e quaisquer mensagens que contenha. Quando uma fila é eliminada com êxito, é imediatamente marcada para eliminação e já não está acessível aos clientes. A fila é posteriormente removida do serviço Fila durante a libertação da memória. Tenha em atenção que a eliminação de uma fila poderá demorar, pelo menos, 40 segundos a ser concluída. Se for tentada uma operação na fila enquanto esta estava a ser eliminada, será emitida uma <xref:azure.storage.queue.queueservice.AzureConflictHttpError> . |
| exists |
Devolve um valor booleano que indica se a fila existe. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Gera uma assinatura de acesso partilhado para o serviço de fila. Utilize a assinatura devolvida com o parâmetro sas_token de QueueService. |
| generate_queue_shared_access_signature |
Gera uma assinatura de acesso partilhado para a fila. Utilize a assinatura devolvida com o parâmetro sas_token de QueueService. |
| get_messages |
Obtém uma ou mais mensagens a partir da frente da fila. Quando uma mensagem é obtida da fila, a resposta inclui o conteúdo da mensagem e um valor de pop_receipt, que é necessário para eliminar a mensagem. A mensagem não é eliminada automaticamente da fila, mas depois de ser obtida, não é visível para outros clientes para o intervalo de tempo especificado pelo parâmetro visibility_timeout. Se o campo key-encryption-key ou resolver estiver definido no objeto de serviço local, as mensagens serão desencriptadas antes de serem devolvidas. |
| get_queue_acl |
Devolve detalhes sobre quaisquer políticas de acesso armazenadas especificadas na fila que possam ser utilizadas com Assinaturas de Acesso Partilhado. |
| get_queue_metadata |
Obtém os metadados definidos pelo utilizador e as propriedades da fila na fila especificada. Os metadados estão associados à fila como pares nome-valor. |
| get_queue_service_properties |
Obtém as propriedades do serviço Fila de uma conta de armazenamento, incluindo regras de registo, análise e CORS. |
| get_queue_service_stats |
Obtém estatísticas relacionadas com a replicação do serviço Fila. Só está disponível quando a replicação georredundante de acesso de leitura está ativada para a conta de armazenamento. Com a replicação georredundante, o Armazenamento do Azure mantém os seus dados duráveis em duas localizações. Em ambas as localizações, o Armazenamento do Azure mantém constantemente múltiplas réplicas em bom estado de funcionamento dos seus dados. A localização onde lê, cria, atualiza ou elimina dados é a localização da conta de armazenamento principal. A localização primária existe na região que escolher no momento em que cria uma conta através do portal clássico do Azure Management do Azure, por exemplo, E.U.A. Centro-Norte. A localização para a qual os seus dados são replicados é a localização secundária. A localização secundária é determinada automaticamente com base na localização da localização primária; é num segundo datacenter que reside na mesma região que a localização primária. O acesso só de leitura está disponível a partir da localização secundária, se a replicação georredundante de acesso de leitura estiver ativada para a sua conta de armazenamento. |
| list_queues |
Devolve um gerador para listar as filas. O gerador irá seguir preguiçosamente os tokens de continuação devolvidos pelo serviço e parar quando todas as filas tiverem sido devolvidas ou num_results for atingido. Se num_results for especificado e a conta tiver mais do que esse número de filas, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados. |
| peek_messages |
Obtém uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem. Apenas as mensagens visíveis podem ser obtidas. Quando uma mensagem é obtida pela primeira vez com uma chamada para get_messages, a propriedade dequeue_count está definida como 1. Se não for eliminado e for obtido novamente, a propriedade dequeue_count é incrementada. O cliente pode utilizar este valor para determinar quantas vezes uma mensagem foi obtida. Tenha em atenção que uma chamada para peek_messages não incrementa o valor de DequeueCount, mas devolve este valor para o cliente ler. Se o campo key-encryption-key ou resolver estiver definido no objeto de serviço local, as mensagens serão desencriptadas antes de serem devolvidas. |
| put_message |
Adiciona uma nova mensagem à parte de trás da fila de mensagens. O tempo limite de visibilidade especifica a hora em que a mensagem será invisível. Depois de expirar o tempo limite, a mensagem ficará visível. Se não for especificado um tempo limite de visibilidade, é utilizado o valor predefinido de 0. A mensagem time-to-live especifica quanto tempo uma mensagem permanecerá na fila. A mensagem será eliminada da fila quando o período de tempo de vida expirar. Se o campo chave-encriptação-chave estiver definido no objeto de serviço local, este método encriptará o conteúdo antes de carregar. |
| set_proxy |
Define o anfitrião e a porta do servidor proxy para o Túnel HTTP CONNECT. |
| set_queue_acl |
Define políticas de acesso armazenadas para a fila que pode ser utilizada com Assinaturas de Acesso Partilhado. Quando define permissões para uma fila, as permissões existentes são substituídas. Para atualizar as permissões da fila, chame get_queue_acl para obter todas as políticas de acesso associadas à fila, modifique a política de acesso que pretende alterar e, em seguida, chame esta função com o conjunto completo de dados para efetuar a atualização. Quando estabelece uma política de acesso armazenado numa fila, pode demorar até 30 segundos a entrar em vigor. Durante este intervalo, uma assinatura de acesso partilhado associada à política de acesso armazenado irá gerar uma <xref:azure.storage.queue.queueservice.AzureHttpError> até a política de acesso ficar ativa. |
| set_queue_metadata |
Define metadados definidos pelo utilizador na fila especificada. Os metadados estão associados à fila como pares nome-valor. |
| set_queue_service_properties |
Define as propriedades do serviço Fila de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento. Se um elemento (ex Registo) for deixado como Nenhum, as definições existentes no serviço para essa funcionalidade serão preservadas. Para obter mais informações sobre o Azure Análise de Armazenamento, consulte https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx. |
| update_message |
Atualizações o tempo limite de visibilidade de uma mensagem. Também pode utilizar esta operação para atualizar o conteúdo de uma mensagem. Esta operação pode ser utilizada para expandir continuamente a invisibilidade de uma mensagem de fila. Esta funcionalidade pode ser útil se quiser que uma função de trabalho "arrende" uma mensagem de fila. Por exemplo, se uma função de trabalho chamar get_messages e reconhecer que precisa de mais tempo para processar uma mensagem, pode prolongar continuamente a invisibilidade da mensagem até ser processada. Se a função de trabalho falhasse durante o processamento, eventualmente a mensagem voltaria a ficar visível e outra função de trabalho poderia processá-la. Se o campo chave-encriptação-chave estiver definido no objeto de serviço local, este método encriptará o conteúdo antes de carregar. |
clear_messages
Elimina todas as mensagens da fila especificada.
clear_messages(queue_name, timeout=None)Parâmetros
create_queue
Cria uma fila na conta especificada.
create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None)Parâmetros
- queue_name
- str
O nome da fila a criar. Um nome de fila tem de ter entre 3 e 63 carateres e pode conter apenas letras minúsculas, números e o caráter de travessão (-). A primeira e a última letras na fila têm de ser alfanuméricas. O caráter de travessão (-) não pode ser o primeiro ou o último caráter. Os carateres de travessão consecutivos não são permitidos no nome da fila.
Um ditado que contém pares nome-valor para associar à fila como metadados. Tenha em atenção que os nomes de metadados preservam o caso com o qual foram criados, mas não são sensíveis a maiúsculas e minúsculas quando definidos ou lidos.
- fail_on_exist
- bool
Especifica se pretende gerar uma exceção se a fila já existir.
Devoluções
Um booleano que indica se a fila foi criada. Se fail_on_exist foi definido como Verdadeiro, esta ação será emitida em vez de devolver falso.
Tipo de retorno
delete_message
Elimina a mensagem especificada.
Normalmente, depois de um cliente obter uma mensagem com a operação de get_messages, espera-se que o cliente processe e elimine a mensagem. Para eliminar a mensagem, tem de ter dois itens de dados: id e pop_receipt. O ID é devolvido da operação de get_messages anterior. O pop_receipt é devolvido da operação ou update_message mais recenteget_messages. Para que a operação de delete_message seja bem-sucedida, o pop_receipt especificado no pedido tem de corresponder ao pop_receipt devolvido da get_messages operação ou update_message .
delete_message(queue_name, message_id, pop_receipt, timeout=None)Parâmetros
- pop_receipt
- str
Um valor de recibo pop válido devolvido de uma chamada anterior para o get_messages ou update_message.
delete_queue
Elimina a fila especificada e quaisquer mensagens que contenha.
Quando uma fila é eliminada com êxito, é imediatamente marcada para eliminação e já não está acessível aos clientes. A fila é posteriormente removida do serviço Fila durante a libertação da memória.
Tenha em atenção que a eliminação de uma fila poderá demorar, pelo menos, 40 segundos a ser concluída. Se for tentada uma operação na fila enquanto esta estava a ser eliminada, será emitida uma <xref:azure.storage.queue.queueservice.AzureConflictHttpError> .
delete_queue(queue_name, fail_not_exist=False, timeout=None)Parâmetros
- fail_not_exist
- bool
Especifica se pretende emitir uma exceção se a fila não existir.
Devoluções
Um booleano que indica se a fila foi eliminada. Se fail_not_exist foi definido como Verdadeiro, será emitida em vez de devolver falso.
Tipo de retorno
exists
Devolve um valor booleano que indica se a fila existe.
exists(queue_name, timeout=None)Parâmetros
Devoluções
Um booleano que indica se a fila existe.
Tipo de retorno
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parâmetros
- retry_context
generate_account_shared_access_signature
Gera uma assinatura de acesso partilhado para o serviço de fila. Utilize a assinatura devolvida com o parâmetro sas_token de QueueService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parâmetros
- resource_types
- <xref:ResourceTypes>
Especifica os tipos de recursos que estão acessíveis com a SAS da conta.
- permission
- <xref:AccountPermissions>
As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.
O momento em que a assinatura de acesso partilhado se torna inválida. Obrigatório, a menos que seja fornecido um ID que referencie uma política de acesso armazenada que contenha este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.
O momento em que a assinatura de acesso partilhado se torna válida. Se for omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se for transmitida uma data sem informações de fuso horário, assume-se que é UTC.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP a partir do qual aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 no SAS restringe o pedido a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para um pedido feito. O valor predefinido é https,http. Veja Protocol os valores possíveis.
Devoluções
Um token de Assinatura de Acesso Partilhado (sas).
Tipo de retorno
generate_queue_shared_access_signature
Gera uma assinatura de acesso partilhado para a fila. Utilize a assinatura devolvida com o parâmetro sas_token de QueueService.
generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None)Parâmetros
- permission
- QueuePermissions
As permissões associadas à assinatura de acesso partilhado. O utilizador está restrito a operações permitidas pelas permissões. Necessário, a menos que seja fornecido um ID que referencia uma política de acesso armazenado que contém este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada.
O momento em que a assinatura de acesso partilhado se torna inválida. Necessário, a menos que seja fornecido um ID que referencia uma política de acesso armazenado que contém este campo. Este campo tem de ser omitido se tiver sido especificado numa política de acesso armazenada associada. O Azure irá sempre converter valores em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
O momento em que a assinatura de acesso partilhado se torna válida. Se omitido, assume-se que a hora de início desta chamada é a hora em que o serviço de armazenamento recebe o pedido. O Azure irá sempre converter valores em UTC. Se uma data for transmitida sem informações de fuso horário, assume-se que é UTC.
- id
- str
Um valor exclusivo com até 64 carateres de comprimento que se correlaciona com uma política de acesso armazenada. Para criar uma política de acesso armazenada, utilize set_queue_acl.
- ip
- str
Especifica um endereço IP ou um intervalo de endereços IP a partir dos quais aceitar pedidos. Se o endereço IP a partir do qual o pedido é originado não corresponder ao endereço IP ou intervalo de endereços especificado no token de SAS, o pedido não é autenticado. Por exemplo, especificar sip='168.1.5.65' ou sip='168.1.5.60-168.1.5.70' no SAS restringe o pedido a esses endereços IP.
- protocol
- str
Especifica o protocolo permitido para um pedido feito. O valor predefinido é https,http. Veja Protocol os valores possíveis.
Devoluções
Um token de Assinatura de Acesso Partilhado (sas).
Tipo de retorno
get_messages
Obtém uma ou mais mensagens a partir da frente da fila.
Quando uma mensagem é obtida da fila, a resposta inclui o conteúdo da mensagem e um valor de pop_receipt, que é necessário para eliminar a mensagem. A mensagem não é eliminada automaticamente da fila, mas depois de ser obtida, não é visível para outros clientes para o intervalo de tempo especificado pelo parâmetro visibility_timeout.
Se o campo key-encryption-key ou resolver estiver definido no objeto de serviço local, as mensagens serão desencriptadas antes de serem devolvidas.
get_messages(queue_name, num_messages=None, visibility_timeout=None, timeout=None)Parâmetros
- num_messages
- int
Um valor inteiro nãozero que especifica o número de mensagens a obter da fila, até um máximo de 32. Se menos estiverem visíveis, serão devolvidas as mensagens visíveis. Por predefinição, é obtida uma única mensagem da fila com esta operação.
- visibility_timeout
- int
Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação à hora do servidor. O novo valor tem de ser maior ou igual a 1 segundo e não pode ser superior a 7 dias. O tempo limite de visibilidade de uma mensagem pode ser definido para um valor posterior ao tempo de expiração.
Devoluções
Um QueueMessage objeto que representa as informações transmitidas.
Tipo de retorno
get_queue_acl
Devolve detalhes sobre quaisquer políticas de acesso armazenadas especificadas na fila que possam ser utilizadas com Assinaturas de Acesso Partilhado.
get_queue_acl(queue_name, timeout=None)Parâmetros
Devoluções
Um dicionário de políticas de acesso associadas à fila.
Tipo de retorno
get_queue_metadata
Obtém os metadados definidos pelo utilizador e as propriedades da fila na fila especificada. Os metadados estão associados à fila como pares nome-valor.
get_queue_metadata(queue_name, timeout=None)Parâmetros
Devoluções
Um dicionário que representa os metadados da fila com uma propriedade int approximate_message_count no ditado estimando o número de mensagens na fila.
Tipo de retorno
get_queue_service_properties
Obtém as propriedades do serviço Fila de uma conta de armazenamento, incluindo regras de registo, análise e CORS.
get_queue_service_properties(timeout=None)Parâmetros
Devoluções
As propriedades do serviço de fila.
Tipo de retorno
get_queue_service_stats
Obtém estatísticas relacionadas com a replicação do serviço Fila. Só está disponível quando a replicação georredundante de acesso de leitura está ativada para a conta de armazenamento.
Com a replicação georredundante, o Armazenamento do Azure mantém os seus dados duráveis em duas localizações. Em ambas as localizações, o Armazenamento do Azure mantém constantemente múltiplas réplicas em bom estado de funcionamento dos seus dados. A localização onde lê, cria, atualiza ou elimina dados é a localização da conta de armazenamento principal. A localização primária existe na região que escolher no momento em que cria uma conta através do portal clássico do Azure Management do Azure, por exemplo, E.U.A. Centro-Norte. A localização para a qual os seus dados são replicados é a localização secundária. A localização secundária é determinada automaticamente com base na localização da localização primária; é num segundo datacenter que reside na mesma região que a localização primária. O acesso só de leitura está disponível a partir da localização secundária, se a replicação georredundante de acesso de leitura estiver ativada para a sua conta de armazenamento.
get_queue_service_stats(timeout=None)Parâmetros
Devoluções
As estatísticas do serviço de fila.
Tipo de retorno
list_queues
Devolve um gerador para listar as filas. O gerador irá seguir preguiçosamente os tokens de continuação devolvidos pelo serviço e parar quando todas as filas tiverem sido devolvidas ou num_results for atingido.
Se num_results for especificado e a conta tiver mais do que esse número de filas, o gerador terá um campo de next_marker preenchido assim que terminar. Este marcador pode ser utilizado para criar um novo gerador se forem desejados mais resultados.
list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parâmetros
- prefix
- str
Filtra os resultados para devolver apenas filas com nomes que começam com o prefixo especificado.
- include_metadata
- bool
Especifica que os metadados de contentor são devolvidos na resposta.
- marker
- str
Um token de continuação opaco. Este valor pode ser obtido a partir do campo next_marker de um objeto gerador anterior se num_results tiver sido especificado e esse gerador tiver concluído a enumeração de resultados. Se especificado, este gerador começará a devolver resultados do ponto em que o gerador anterior parou.
- timeout
- int
O tempo limite do servidor, expresso em segundos. Esta função pode fazer várias chamadas para o serviço, caso em que o valor de tempo limite especificado será aplicado a cada chamada individual.
peek_messages
Obtém uma ou mais mensagens da frente da fila, mas não altera a visibilidade da mensagem.
Apenas as mensagens visíveis podem ser obtidas. Quando uma mensagem é obtida pela primeira vez com uma chamada para get_messages, a propriedade dequeue_count está definida como 1. Se não for eliminado e for obtido novamente, a propriedade dequeue_count é incrementada. O cliente pode utilizar este valor para determinar quantas vezes uma mensagem foi obtida. Tenha em atenção que uma chamada para peek_messages não incrementa o valor de DequeueCount, mas devolve este valor para o cliente ler.
Se o campo key-encryption-key ou resolver estiver definido no objeto de serviço local, as mensagens serão desencriptadas antes de serem devolvidas.
peek_messages(queue_name, num_messages=None, timeout=None)Parâmetros
- num_messages
- int
Um valor inteiro nãozero que especifica o número de mensagens a pré-visualizar da fila, até um máximo de 32. Por predefinição, é apresentada uma única mensagem da fila com esta operação.
Devoluções
Uma lista de QueueMessage objetos. Tenha em atenção que time_next_visible e pop_receipt não serão preenchidos, uma vez que a pré-visualização não apresenta a mensagem e só pode obter mensagens já visíveis.
Tipo de retorno
put_message
Adiciona uma nova mensagem à parte de trás da fila de mensagens.
O tempo limite de visibilidade especifica a hora em que a mensagem será invisível. Depois de expirar o tempo limite, a mensagem ficará visível. Se não for especificado um tempo limite de visibilidade, é utilizado o valor predefinido de 0.
A mensagem time-to-live especifica quanto tempo uma mensagem permanecerá na fila. A mensagem será eliminada da fila quando o período de tempo de vida expirar.
Se o campo chave-encriptação-chave estiver definido no objeto de serviço local, este método encriptará o conteúdo antes de carregar.
put_message(queue_name, content, visibility_timeout=None, time_to_live=None, timeout=None)Parâmetros
- content
- <xref:obj>
Conteúdo da mensagem. O tipo permitido é determinado pelo encode_function definido no serviço. A predefinição é str. A mensagem codificada pode ter até 64 KB de tamanho.
- visibility_timeout
- int
Se não for especificado, o valor predefinido é 0. Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação à hora do servidor. O valor tem de ser maior ou igual a 0 e não pode ser superior a 7 dias. O tempo limite de visibilidade de uma mensagem não pode ser definido para um valor posterior ao tempo de expiração. visibility_timeout deve ser definido como um valor menor do que o valor time-to-live.
- time_to_live
- int
Especifica o intervalo de tempo em direto para a mensagem, em segundos. O tempo de vida pode ser qualquer número positivo ou -1 para o infinito. Se este parâmetro for omitido, o tempo de vida predefinido é de 7 dias.
Devoluções
Um QueueMessage objeto. Este objeto também é preenchido com o conteúdo, embora não seja devolvido do serviço.
Tipo de retorno
set_proxy
Define o anfitrião e a porta do servidor proxy para o Túnel HTTP CONNECT.
set_proxy(host, port, user=None, password=None)Parâmetros
set_queue_acl
Define políticas de acesso armazenadas para a fila que pode ser utilizada com Assinaturas de Acesso Partilhado.
Quando define permissões para uma fila, as permissões existentes são substituídas. Para atualizar as permissões da fila, chame get_queue_acl para obter todas as políticas de acesso associadas à fila, modifique a política de acesso que pretende alterar e, em seguida, chame esta função com o conjunto completo de dados para efetuar a atualização.
Quando estabelece uma política de acesso armazenado numa fila, pode demorar até 30 segundos a entrar em vigor. Durante este intervalo, uma assinatura de acesso partilhado associada à política de acesso armazenado irá gerar uma <xref:azure.storage.queue.queueservice.AzureHttpError> até a política de acesso ficar ativa.
set_queue_acl(queue_name, signed_identifiers=None, timeout=None)Parâmetros
- signed_identifiers
- dict(str, AccessPolicy)
Um dicionário de políticas de acesso a associar à fila. O dicionário pode conter até 5 elementos. Um dicionário vazio limpará as políticas de acesso definidas no serviço.
set_queue_metadata
Define metadados definidos pelo utilizador na fila especificada. Os metadados estão associados à fila como pares nome-valor.
set_queue_metadata(queue_name, metadata=None, timeout=None)Parâmetros
- metadata
- dict
Um ditado que contém pares nome-valor para associar à fila como metadados.
set_queue_service_properties
Define as propriedades do serviço Fila de uma conta de armazenamento, incluindo o Azure Análise de Armazenamento. Se um elemento (ex Registo) for deixado como Nenhum, as definições existentes no serviço para essa funcionalidade serão preservadas. Para obter mais informações sobre o Azure Análise de Armazenamento, consulte 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)Parâmetros
- logging
- <xref:Logging>
As definições de registo fornecem registos de pedidos.
- hour_metrics
- <xref:Metrics>
As definições de métricas de hora fornecem um resumo das estatísticas de pedidos agrupadas pela API em agregações por hora para filas.
- minute_metrics
- <xref:Metrics>
As definições de métricas de minutos fornecem estatísticas de pedidos para cada minuto para filas.
- cors
- list(CorsRule)
Pode incluir até cinco elementos CorsRule na lista. Se for especificada uma lista vazia, todas as regras CORS serão eliminadas e o CORS será desativado para o serviço. Para obter informações detalhadas sobre as regras CORS e a lógica de avaliação, consulte https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
update_message
Atualizações o tempo limite de visibilidade de uma mensagem. Também pode utilizar esta operação para atualizar o conteúdo de uma mensagem.
Esta operação pode ser utilizada para expandir continuamente a invisibilidade de uma mensagem de fila. Esta funcionalidade pode ser útil se quiser que uma função de trabalho "arrende" uma mensagem de fila. Por exemplo, se uma função de trabalho chamar get_messages e reconhecer que precisa de mais tempo para processar uma mensagem, pode prolongar continuamente a invisibilidade da mensagem até ser processada. Se a função de trabalho falhasse durante o processamento, eventualmente a mensagem voltaria a ficar visível e outra função de trabalho poderia processá-la.
Se o campo chave-encriptação-chave estiver definido no objeto de serviço local, este método encriptará o conteúdo antes de carregar.
update_message(queue_name, message_id, pop_receipt, visibility_timeout, content=None, timeout=None)Parâmetros
- pop_receipt
- str
Um valor de recibo pop válido devolvido a partir de uma chamada anterior à get_messages operação ou update_message .
- visibility_timeout
- int
Especifica o novo valor de tempo limite de visibilidade, em segundos, em relação à hora do servidor. O novo valor tem de ser maior ou igual a 0 e não pode ser superior a 7 dias. O tempo limite de visibilidade de uma mensagem não pode ser definido para um valor posterior ao tempo de expiração. Uma mensagem pode ser atualizada até que tenha sido eliminada ou expirada.
- content
- <xref:obj>
Conteúdo da mensagem. O tipo permitido é determinado pelo encode_function definido no serviço. A predefinição é str.
Devoluções
Uma lista de QueueMessage objetos. Por conveniência, este objeto também é preenchido com o conteúdo, embora não seja devolvido pelo serviço.
Tipo de retorno
Atributos
protocol
request_session
socket_timeout
Azure SDK for Python
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários