Compartilhar via

ServiceBusReceivedMessage Classe

  • Referência

Uma mensagem do Barramento de Serviço 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

Nome Description
message
Obrigatório
receive_mode
Valor padrão: ServiceBusReceiveMode.PEEK_LOCK
frame
Valor padrão: None

Exemplos

Verificando as propriedades em uma 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

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

Erro quando AutoLockRenewer é usado e falha ao renovar o bloqueio de mensagem.

Atributos

application_properties

As propriedades definidas pelo usuário na mensagem.

Retornos

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

body

O corpo da Mensagem. O formato pode variar dependendo do 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.

Retornos

Tipo Description
Any

body_type

O tipo de corpo da mensagem AMQP subjacente.

Retornos

Tipo Description
AmqpMessageBodyType

content_type

O descritor de tipo de conteúdo.

Opcionalmente, descreve o conteúdo da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo , "application/json".

Retornos

Tipo Description
str,
None

correlation_id

O identificador de correlação.

Permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida.

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

Retornos

Tipo Description
str,
None

dead_letter_error_description

Descrição do erro de mensagens mortas, quando a mensagem é recebida de uma subconsulta de mensagens mortas de uma entidade.

Retornos

Tipo Description
str

dead_letter_reason

Motivo da mensagem morta, quando a mensagem é recebida de uma subconsulta de mensagens mortas de uma entidade.

Retornos

Tipo Description
str

dead_letter_source

O nome da fila ou assinatura na qual essa mensagem foi enfileirada, antes de ser colocada em fila. Essa propriedade só é definida em mensagens que foram enviadas com mensagens mortas e, posteriormente, encaminhadas automaticamente da fila de mensagens mortas para outra entidade. Indica a entidade na qual a mensagem foi morta.

Retornos

Tipo Description
str

delivery_count

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

Retornos

Tipo Description
int

enqueued_sequence_number

Para mensagens que foram encaminhadas automaticamente, essa propriedade reflete o número de sequência que tinha sido atribuído primeiro à mensagem em seu ponto de envio original.

Retornos

Tipo Description
int

enqueued_time_utc

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

Retornos

Tipo Description
datetime

expires_at_utc

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

Retornos

Tipo Description
datetime

lock_token

O token de bloqueio da mensagem atual que serve como uma referência ao bloqueio que está sendo mantido pelo agente no modo PEEK_LOCK.

Retornos

Tipo Description
UUID,
str

locked_until_utc

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

Retornos

Tipo Description
datetime

message

Obtenha o LegacyMessage subjacente. Isso foi preterido e será removido em uma versão posterior.

Retornos

Tipo Description
<xref:LegacyMessage>

message_id

A ID para identificar a mensagem.

O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload. O identificador é uma cadeia de caracteres de forma livre e pode refletir um GUID ou um identificador derivado do contexto do aplicativo. Se habilitado, o recurso de detecção duplicada (consulte https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifica e remove o segundo e mais envios de mensagens com a mesma ID de mensagem.

Retornos

Tipo Description
str,
None

partition_key

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

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

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

Retornos

Tipo Description
str,
None

raw_amqp_message

Somente uso avançado. O conteúdo da mensagem AMQP interna que é enviado ou recebido. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

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

Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada.

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

Retornos

Tipo Description
str,
None

reply_to_session_id

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

Esse valor aumenta as informações de reply_to e especifica qual ID de sessão deve ser definida para a resposta quando enviada à entidade de resposta.

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

Retornos

Tipo Description
str,
None

scheduled_enqueue_time_utc

O horário de enfileiramento agendado utc para a mensagem.

Essa propriedade pode ser usada para agendamento ao enviar uma mensagem por meio do método ServiceBusSender.send . Se for necessário cancelar mensagens agendadas, você deverá usar o método ServiceBusSender.schedule , que retorna números de sequência que podem ser usados para cancelamento futuro. scheduled_enqueue_time_utc será Nenhum se não estiver definido.

Retornos

Tipo Description
datetime

sequence_number

O número exclusivo atribuído a uma mensagem pelo Barramento de Serviço. O número de sequência é um inteiro de 64 bits atribuído a uma mensagem conforme ela é aceita e armazenada pelo agente e por funções como seu identificador verdadeiro. Para entidades particionadas, os 16 bits de nível mais alto refletem o identificador da partição. Os números de sequência aumentam monotonicamente. Eles passam para 0 quando o intervalo de 48 a 64 bits é esgotado.

Retornos

Tipo Description
int

session_id

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

Para entidades com sessão, esse valor definido pelo aplicativo 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 permitem a demultiplexação e o processamento na ordem exata. Para entidades não sessões, esse valor é ignorado.

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

Retornos

Tipo Description
str,
None

state

O padrão é Ativo. Representa o estado da mensagem. Pode ser Ativo, Adiado. ou Agendado.

Retornos

Tipo Description
ServiceBusMessageState

subject

O assunto específico do aplicativo, às vezes chamado de rótulo.

Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o destinatário de maneira padronizada, semelhante a uma linha do assunto de email.

Retornos

Tipo Description
str

time_to_live

A duração da vida útil de uma mensagem.

Esse valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueued_time_utc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor de vida útil no nível da mensagem não pode ser maior do que a configuração de vida útil da entidade e é ajustado silenciosamente se isso acontecer.

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

Retornos

Tipo Description
timedelta

to

O endereço a ser endereçado.

Essa propriedade é reservada para uso futuro em cenários de roteamento e é atualmente ignorada pelo próprio agente. Os aplicativos podem usar esse valor em cenários de encadeamento de encaminhamento automático orientado à regra para indicar o destino lógico pretendido da mensagem.

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

Retornos

Tipo Description
str,
None