Share via

ServiceBusMessage Clase

  • Referencia

Un mensaje de Service Bus.

Herencia
builtins.object
ServiceBusMessage

Constructor

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

Parámetros

body
Optional[Union[str, bytes]]
Requerido

Datos que se van a enviar en un único mensaje.

application_properties
Dict[str, Union[int o float o bool o bytes o str o UUID o datetime o None]]

Propiedades definidas por el usuario en el mensaje.

session_id
Optional[str]

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

message_id
Optional[str]

Identificador para identificar el mensaje.

scheduled_enqueue_time_utc
Optional[datetime]

Hora de puesta en cola programada utc para el mensaje.

time_to_live
Optional[timedelta]

Duración de un mensaje.

content_type
Optional[str]

Descriptor de tipo de contenido.

correlation_id
Optional[str]

Identificador de correlación.

subject
Optional[str]

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

partition_key
Optional[str]

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

to
Optional[str]

que se va a abordar para auto_forward escenarios de encadenamiento.

reply_to
Optional[str]

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

reply_to_session_id
Optional[str]

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

Ejemplos

Envío de un mensaje con propiedades adicionales


   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

Atributos

application_properties

Propiedades definidas por el usuario en el mensaje.

Tipo de valor devuelto

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

body

El cuerpo del mensaje. El formato puede variar según el 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.

Tipo de valor devuelto

Any

body_type

Tipo de cuerpo del mensaje AMQP subyacente.

Tipo de valor devuelto

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".

Tipo de valor devuelto

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.

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

Tipo de valor devuelto

str,
None

message

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

Tipo de valor devuelto

<xref:uamqp.Message>,
<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 detección de duplicados (consulte 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.

Tipo de valor devuelto

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

Tipo de valor devuelto

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.

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

Tipo de valor devuelto

str,
None

reply_to_session_id

Identificador de sesión que aumenta la dirección de 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.

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

Tipo de valor devuelto

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 se requieren mensajes programados de cancelación, 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.

Tipo de valor devuelto

datetime

session_id

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

En el caso de 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 que no son de sesión, se omite este valor.

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

Tipo de valor devuelto

str,
None

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.

Tipo de valor devuelto

str

time_to_live

Duración 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 de forma silenciosa si lo hace.

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

Tipo de valor devuelto

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.

Tipo de valor devuelto

str,
None