Partilhar via

ServiceBusReceivedMessage Classe

  • Referência

Uma Mensagem do Service Bus recebida do lado do serviço.

Herança
azure.servicebus._common.message.ServiceBusMessage
ServiceBusReceivedMessage

Construtor

ServiceBusReceivedMessage(message: 'Message' | 'pyamqp_Message', receive_mode: ServiceBusReceiveMode | str = ServiceBusReceiveMode.PEEK_LOCK, frame: 'TransferFrame' | None = None, **kwargs: Any)

Parâmetros

Name Description
message
Necessário
receive_mode
Default value: ServiceBusReceiveMode.PEEK_LOCK
frame
Default value: None

Exemplos

Verificar as propriedades numa mensagem recebida.


       from typing import List
       from azure.servicebus import ServiceBusReceivedMessage
       messages_complex: List[ServiceBusReceivedMessage] = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages_complex:
           print("Receiving: {}".format(message))
           print("Time to live: {}".format(message.time_to_live))
           print("Sequence number: {}".format(message.sequence_number))
           print("Enqueued Sequence number: {}".format(message.enqueued_sequence_number))
           print("Partition Key: {}".format(message.partition_key))
           print("Application Properties: {}".format(message.application_properties))
           print("Delivery count: {}".format(message.delivery_count))
           print("Message ID: {}".format(message.message_id))
           print("Locked until: {}".format(message.locked_until_utc))
           print("Lock Token: {}".format(message.lock_token))
           print("Enqueued time: {}".format(message.enqueued_time_utc))

Variáveis

Name Description
auto_renew_error
<xref:azure.servicebus.AutoLockRenewTimeout> ou <xref:azure.servicebus.AutoLockRenewFailed>

Erro quando o AutoLockRenewer é utilizado e não renova o bloqueio da mensagem.

Atributos

application_properties

As propriedades definidas pelo utilizador na mensagem.

Devoluções

Tipo Description
dict[str,
bytes, <xref:PrimitiveTypes>],
None

body

O corpo da Mensagem. O formato pode variar consoante o tipo de corpo: para DATA, o corpo pode ser bytes ou Iterable[bytes]. Para SEQUENCE, o corpo pode ser List ou Iterable[List]. Para VALUE, o corpo pode ser qualquer tipo.

Devoluções

Tipo Description
Any

body_type

O tipo de corpo da mensagem AMQP subjacente.

Devoluções

Tipo Description
AmqpMessageBodyType

content_type

O descritor do tipo de conteúdo.

Opcionalmente, descreve o payload da mensagem, com um descritor a seguir ao formato de RFC2045, Secção 5, por exemplo "application/json".

Devoluções

Tipo Description
str,
None

correlation_id

O identificador de correlação.

Permite que uma aplicação especifique um contexto para a mensagem para efeitos de correlação, por exemplo, refletindo o MessageId de uma mensagem a que está a ser respondida.

Veja Encaminhamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluções

Tipo Description
str,
None

dead_letter_error_description

Descrição do erro de letra não entregue, quando a mensagem é recebida de um subconjunto de uma entidade sem saída.

Devoluções

Tipo Description
str

dead_letter_reason

Motivo da letra incorrida, quando a mensagem é recebida de uma subconsulta de uma entidade.

Devoluções

Tipo Description
str

dead_letter_source

O nome da fila ou subscrição em que esta mensagem foi colocada em fila, antes de ser colocada em fila de espera. Esta propriedade só é definida em mensagens que tenham sido escritas sem letra e posteriormente reencaminhadas automaticamente da fila de letras não entregues para outra entidade. Indica a entidade na qual a mensagem foi não entregue.

Devoluções

Tipo Description
str

delivery_count

Número de entregas que foram tentadas para esta mensagem. A contagem é incrementada quando um bloqueio de mensagem expira ou a mensagem é explicitamente abandonada pelo recetor.

Devoluções

Tipo Description
int

enqueued_sequence_number

Para mensagens que foram reencaminhadas automaticamente, esta propriedade reflete o número de sequência que tinha sido atribuído pela primeira vez à mensagem no ponto original de submissão.

Devoluções

Tipo Description
int

enqueued_time_utc

O datetime UTC no qual a mensagem foi aceite e armazenada na entidade.

Devoluções

Tipo Description
datetime

expires_at_utc

O datetime UTC no qual a mensagem está marcada para remoção e já não está disponível para obtenção da entidade devido à expiração. A expiração é controlada pela propriedade Message.time_to_live . Esta propriedade é calculada a partir de Message.enqueued_time_utc + Message.time_to_live.

Devoluções

Tipo Description
datetime

lock_token

O token de bloqueio da mensagem atual que serve como referência ao bloqueio que está a ser mantido pelo mediador no modo de PEEK_LOCK.

Devoluções

Tipo Description
UUID,
str

locked_until_utc

O datetime UTC até ao qual a mensagem será bloqueada na fila/subscrição. Quando o bloqueio expira, a contagem de entrega da mensagem é incrementada e a mensagem está novamente disponível para obtenção.

Devoluções

Tipo Description
datetime

message

Obtenha o LegacyMessage subjacente. Esta situação foi preterida e será removida numa versão posterior.

Devoluções

Tipo Description
<xref:LegacyMessage>

message_id

O ID para identificar a mensagem.

O identificador de mensagens é um valor definido pela aplicação que identifica exclusivamente a mensagem e o respetivo payload. O identificador é uma cadeia de forma livre e pode refletir um GUID ou um identificador derivado do contexto da aplicação. Se estiver ativada, a funcionalidade de deteção duplicada (ver https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifica e remove a segunda e mais submissões de mensagens com o mesmo ID de mensagem.

Devoluções

Tipo Description
str,
None

partition_key

A chave de partição para enviar uma mensagem para uma entidade particionada.

Definir este valor permite atribuir mensagens relacionadas à mesma partição interna, para que a sequência de submissão seja gravada corretamente. A partição é escolhida por uma função hash sobre este valor e não pode ser escolhida diretamente.

Veja Filas e tópicos particionados em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Devoluções

Tipo Description
str,
None

raw_amqp_message

Apenas utilização avançada. O payload de mensagens AMQP interno que é enviado ou recebido. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

O endereço de uma entidade para a qual enviar respostas.

Este valor opcional e definido pela aplicação é uma forma padrão de expressar um caminho de resposta para o recetor da mensagem. Quando um remetente espera uma resposta, define o valor para o caminho absoluto ou relativo da fila ou tópico para o qual espera que a resposta seja enviada.

Veja Encaminhamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluções

Tipo Description
str,
None

reply_to_session_id

O identificador de sessão aumenta o endereço reply_to .

Este valor aumenta as informações do reply_to e especifica qual o ID da sessão que deve ser definido para a resposta quando enviado para a entidade de resposta.

Veja Encaminhamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluções

Tipo Description
str,
None

scheduled_enqueue_time_utc

A hora de fila agendada utc para a mensagem.

Esta propriedade pode ser utilizada para agendar ao enviar uma mensagem através do método ServiceBusSender.send . Se for necessário cancelar mensagens agendadas, deve utilizar o método ServiceBusSender.schedule , que devolve números de sequência que podem ser utilizados para cancelamento futuro. scheduled_enqueue_time_utc é Nenhuma se não estiver definida.

Devoluções

Tipo Description
datetime

sequence_number

O número exclusivo atribuído a uma mensagem pelo Service Bus. O número de sequência é um número inteiro exclusivo de 64 bits atribuído a uma mensagem, uma vez que é aceite e armazenado pelo mediador e pelas funções como o seu verdadeiro identificador. Para entidades particionadas, os 16 bits mais altos refletem o identificador de partição. Os números de sequência aumentam monotonicamente. Passam para 0 quando o intervalo de 48-64 bits está esgotado.

Devoluções

Tipo Description
int

session_id

O identificador de sessão da mensagem para uma entidade com sessão.

Para entidades com sessão, este valor definido pela aplicação especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e ativam o processamento e a desmultiplexing exatos. Para entidades sem sessão, este valor é ignorado.

Veja Sessões de Mensagens em https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Devoluções

Tipo Description
str,
None

state

Predefinições para Ativo. Representa o estado da mensagem. Pode ser Ativo, Diferido. ou Agendado.

Devoluções

Tipo Description
ServiceBusMessageState

subject

O assunto específico da aplicação, por vezes referido como uma etiqueta.

Esta propriedade permite que a aplicação indique o objetivo da mensagem ao recetor de forma padronizada, semelhante a uma linha de assunto de e-mail.

Devoluções

Tipo Description
str

time_to_live

A duração de vida de uma mensagem.

Este valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceite e armazenada pelo mediador, conforme capturado em enqueued_time_utc. Quando não estiver definido explicitamente, o valor assumido é DefaultTimeToLive para a respetiva fila ou tópico. Um valor time-to-live ao nível da mensagem não pode ser maior do que a definição de tempo de vida da entidade e é ajustado silenciosamente se o fizer.

Ver Expiração em https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Devoluções

Tipo Description
timedelta

to

O endereço para .

Esta propriedade está reservada para utilização futura em cenários de encaminhamento e atualmente ignorada pelo próprio mediador. As aplicações podem utilizar este valor em cenários de encadeamento automático orientados por regras para indicar o destino lógico pretendido da mensagem.

Veja https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding para obter mais detalhes.

Devoluções

Tipo Description
str,
None