ServiceBusReceivedMessage Clase

Mensaje de Service Bus recibido del lado del servicio.

Herencia

azure.servicebus._common.message.ServiceBusMessage

ServiceBusReceivedMessage

Constructor

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

Parámetros

Nombre	Description
message Requerido
receive_mode	Valor predeterminado: ServiceBusReceiveMode.PEEK_LOCK
frame	Valor predeterminado: None

Ejemplos

Comprobar las propiedades de un mensaje recibido.

       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))

Variables

Nombre	Description
auto_renew_error	<xref:azure.servicebus.AutoLockRenewTimeout> o <xref:azure.servicebus.AutoLockRenewFailed> Error cuando se usa AutoLockRenewer y no se puede renovar el bloqueo del mensaje.

Atributos

application_properties

Propiedades definidas por el usuario en el mensaje.

Devoluciones

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

body

Cuerpo del mensaje. El formato puede variar en función del tipo de cuerpo: para DATA, el cuerpo podría ser bytes o iterable[bytes]. Para SEQUENCE, el cuerpo podría ser List o Iterable[List]. Para VALUE, el cuerpo podría ser cualquier tipo.

Devoluciones

Tipo	Description
Any

body_type

Tipo de cuerpo del mensaje AMQP subyacente.

Devoluciones

Tipo	Description
AmqpMessageBodyType

content_type

Descriptor de tipo de contenido.

Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo, "application/json".

Devoluciones

Tipo	Description
str, None

correlation_id

Identificador de correlación.

Permite que una aplicación especifique un contexto del mensaje con fines de correlación, por ejemplo, que refleje el MessageId de un mensaje que se ha respondido.

Consulte Enrutamiento y correlación de mensajes en https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluciones

Tipo	Description
str, None

dead_letter_error_description

Descripción del error de mensajes fallidos, cuando el mensaje se recibe de una subconsulta de mensajes fallidos de una entidad.

Devoluciones

Tipo	Description
str

dead_letter_reason

Motivo de mensajes fallidos, cuando el mensaje se recibe de una subconsulta de mensajes fallidos de una entidad.

Devoluciones

Tipo	Description
str

dead_letter_source

Nombre de la cola o suscripción en la que se puso en cola este mensaje, antes de que se haya producido un error. Esta propiedad solo se establece en mensajes fallidos y, posteriormente, reenviados automáticamente desde la cola de mensajes fallidos a otra entidad. Indica la entidad donde se encontraba el mensaje fallido.

Devoluciones

Tipo	Description
str

delivery_count

Número de entregas que se han intentado para este mensaje. El recuento se incrementa cuando expira un bloqueo de mensaje o el receptor abandona explícitamente el mensaje.

Devoluciones

Tipo	Description
int

enqueued_sequence_number

Para los mensajes que se reenvían de manera automática, esta propiedad refleja el número de secuencia que primero se había asignado al mensaje en su momento del envío original.

Devoluciones

Tipo	Description
int

enqueued_time_utc

Fecha y hora UTC en la que se ha aceptado y almacenado el mensaje en la entidad.

Devoluciones

Tipo	Description
datetime

expires_at_utc

Fecha y hora UTC en la que se marca el mensaje para su eliminación y ya no está disponible para la recuperación de la entidad debido a la expiración. La expiración se controla mediante la propiedad Message.time_to_live . Esta propiedad se calcula desde Message.enqueued_time_utc Message.time_to_live + .

Devoluciones

Tipo	Description
datetime

lock_token

Token de bloqueo del mensaje actual que sirve como referencia al bloqueo que mantiene el agente en PEEK_LOCK modo.

Devoluciones

Tipo	Description
UUID, str

locked_until_utc

Fecha y hora UTC hasta la que el mensaje se bloqueará en la cola o suscripción. Cuando expira el bloqueo, se incrementa el recuento de entregas del mensaje y el mensaje vuelve a estar disponible para su recuperación.

Devoluciones

Tipo	Description
datetime

message

Obtenga el objeto LegacyMessage subyacente. Esto está en desuso y se quitará en una versión posterior.

Devoluciones

Tipo	Description
<xref:LegacyMessage>

message_id

Identificador para identificar el mensaje.

El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga. El identificador es una cadena de forma libre y puede reflejar un GUID o un identificador que se deriva del contexto de la aplicación. Si está habilitada, la característica de detección de duplicados (vea https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifica y quita los envíos de segundo y posteriores de mensajes con el mismo identificador de mensaje.

Devoluciones

Tipo	Description
str, None

partition_key

Clave de partición para enviar un mensaje a una entidad con particiones.

Establecer este valor permite asignar mensajes relacionados a la misma partición interna, de modo que el orden de la secuencia de envío se registre correctamente. La partición la elige una función hash sobre este valor y no se puede seleccionar directamente.

Consulte Colas y temas con particiones en https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Devoluciones

Tipo	Description
str, None

raw_amqp_message

Solo uso avanzado. Carga interna del mensaje AMQP que se envía o recibe. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

Dirección de una entidad a la que se van a enviar respuestas.

Este valor opcional y definido por la aplicación es un método estándar de expresar una ruta de acceso de respuesta al receptor del mensaje. Cuando un remitente espera una respuesta, establece el valor en la ruta de acceso absoluta o relativa de la cola o tema al que espera que se envíe la respuesta.

Consulte Enrutamiento y correlación de mensajes en https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluciones

Tipo	Description
str, None

reply_to_session_id

Identificador de sesión que aumenta la dirección reply_to .

Este valor aumenta la información de reply_to y especifica qué identificador de sesión se debe establecer para la respuesta cuando se envía a la entidad de respuesta.

Consulte Enrutamiento y correlación de mensajes en https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Devoluciones

Tipo	Description
str, None

scheduled_enqueue_time_utc

Hora de puesta en cola programada utc para el mensaje.

Esta propiedad se puede usar para programar al enviar un mensaje a través del método ServiceBusSender.send . Si es necesario cancelar mensajes programados, debe usar el método ServiceBusSender.schedule , que devuelve números de secuencia que se pueden usar para la cancelación futura. scheduled_enqueue_time_utc es None si no se establece.

Devoluciones

Tipo	Description
datetime

sequence_number

Número único asignado a un mensaje por Service Bus. El número de secuencia es un entero de 64 bits único asignado a un mensaje cuando el agente lo acepta y lo almacena, y funciona como su verdadero identificador. Para entidades con particiones, los 16 bits superiores reflejan el identificador de la partición. Los números de secuencia aumentan de forma monotónica. Vuelven a 0 cuando se agota el intervalo de 48-64 bits.

Devoluciones

Tipo	Description
int

session_id

Identificador de sesión del mensaje para una entidad con sesión.

Para las entidades con sesión, este valor definido por la aplicación especifica la afiliación de sesión del mensaje. Los mensajes con el mismo identificador de sesión están sujetas al bloqueo de resumen y habilitan el procesamiento en orden exacto y la desmultiplexación. En el caso de las entidades no con sesión, este valor se omite.

Vea Sesiones de mensajes en https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Devoluciones

Tipo	Description
str, None

state

El valor predeterminado es Activo. Representa el estado del mensaje del mensaje. Puede ser Activo, Diferido. o Programado.

Devoluciones

Tipo	Description
ServiceBusMessageState

subject

El asunto específico de la aplicación, a veces denominado etiqueta.

Esta propiedad permite a la aplicación indicar el propósito del mensaje al receptor de modo estandarizado, similar a una línea de asunto de correo electrónico.

Devoluciones

Tipo	Description
str

time_to_live

Duración de la vida de un mensaje.

Este valor es la duración relativa después de la cual expira el mensaje, comenzando desde el instante en que el agente ha aceptado y almacenado el mensaje, como se captura en enqueued_time_utc. Cuando no se establece explícitamente, el valor asumido es DefaultTimeToLive para la cola o tema correspondiente. Un valor de período de vida de nivel de mensaje no puede ser mayor que la configuración de período de vida de la entidad y se ajusta silenciosamente si lo hace.

Consulte Expiración en https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Devoluciones

Tipo	Description
timedelta

to

que se va a dirigir.

Esta propiedad está reservada para un uso futuro en escenarios de enrutamiento y actualmente la omite el propio agente. Las aplicaciones pueden utilizar este valor en escenarios de encadenamiento de reenvío automático controlados por reglas para indicar el destino lógico previsto del mensaje.

Para obtener más información, consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding.

Devoluciones

Tipo	Description
str, None