ServiceBusMessage interface

Paquete:

@azure/service-bus

Describe el mensaje que se va a enviar a Service Bus.

Propiedades

applicationProperties	Propiedades específicas de la aplicación que se pueden usar para metadatos de mensajes personalizados.
body	Cuerpo del mensaje que debe enviarse o recibirse. Si la aplicación que recibe el mensaje no usa este SDK, convierta la carga del cuerpo en una matriz de bytes o búfer para mejorar la compatibilidad entre idiomas.
contentType	Tipo de contenido del mensaje. Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato de RFC2045, sección 5, por ejemplo "application/json".
correlationId	Identificador de correlación que permite a una aplicación especificar un contexto para el mensaje con fines de correlación, por ejemplo, reflejando el MessageId de un mensaje al que se va a responder. Consulte enrutamiento de mensajes y correlación.
messageId	El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga. Nota: No se permiten números enteros que no son enteros.
partitionKey	Clave de partición para enviar un mensaje a una entidad con particiones. La longitud máxima es de 128 caracteres. Para entidades 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 se elige mediante una función hash sobre este valor y no se puede elegir directamente. En el caso de las entidades compatibles con la sesión, la propiedad sessionId invalida este valor. En el caso de las entidades sin particiones, se omitirá la clave de partición.
replyTo	Dirección de una entidad a la que se van a enviar respuestas. Este valor opcional y definido por la aplicación es una manera estándar de expresar una ruta 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 de mensajes y correlación.
replyToSessionId	Identificador de sesión que aumenta la dirección replyTo. La longitud máxima es de 128 caracteres. Este valor aumenta la información de ReplyTo y especifica qué SessionId se debe establecer para la respuesta cuando se envía a la entidad de respuesta. Consulte enrutamiento de mensajes y correlación.
scheduledEnqueueTimeUtc	Fecha y hora en UTC a la que se pondrá en cola el mensaje. Esta propiedad devuelve la hora en UTC; al establecer la propiedad , el valor DateTime proporcionado también debe estar en UTC. Este valor es para el envío de mensajes retrasados. Se utiliza para retrasar el envío de mensajes a un momento específico en el futuro. El tiempo de puesta en cola del mensaje no significa que el mensaje se enviará al mismo tiempo. Se pondrá en cola, pero el tiempo de envío real depende de la carga de trabajo de la cola y su estado.
sessionId	Identificador de sesión de una entidad compatible con sesión. La longitud máxima es de 128 caracteres. En el caso de las entidades compatibles con la 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 sujetos al bloqueo de resumen y habilitan el procesamiento y desmultiplexing exactos en orden. En el caso de las entidades que no son conscientes de la sesión, este valor se omite. sesiones de mensajes.
subject	Etiqueta específica de la aplicación. Esta propiedad permite a la aplicación indicar el propósito del mensaje al receptor en un estándar. moda, similar a una línea de asunto de correo electrónico. La propiedad AMQP asignada es "subject".
timeToLive	El tiempo de vida del mensaje. Este valor es la duración relativa después de la cual expira el mensaje, comenzando desde el momento en que el agente ha aceptado y almacenado el mensaje, como se captura en enqueuedTimeUtc. Cuando no se establece explícitamente, el valor asumido es DefaultTimeToLive para la cola o tema correspondientes. Un valor de timeToLive de nivel de mensaje no puede ser mayor que el valor DefaultTimeToLive de la entidad y se ajusta silenciosamente si lo hace. Consulte Expiración.
to	Dirección "to". Esta propiedad está reservada para su uso futuro en escenarios de enrutamiento y actualmente se omite por el propio agente. Las aplicaciones pueden usar este valor en escenarios de encadenamiento de reenvío automático controlado por reglas para indicar el destino lógico previsto del mensaje.

Detalles de las propiedades

applicationProperties

Propiedades específicas de la aplicación que se pueden usar para metadatos de mensajes personalizados.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Valor de propiedad

{[key: string]: number | boolean | string | Date | null}

body

Cuerpo del mensaje que debe enviarse o recibirse. Si la aplicación que recibe el mensaje no usa este SDK, convierta la carga del cuerpo en una matriz de bytes o búfer para mejorar la compatibilidad entre idiomas.

body: any

Valor de propiedad

any

contentType

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

contentType?: string

Valor de propiedad

string

correlationId

Identificador de correlación que permite a una aplicación especificar un contexto para el mensaje con fines de correlación, por ejemplo, reflejando el MessageId de un mensaje al que se va a responder. Consulte enrutamiento de mensajes y correlación.

correlationId?: string | number | Buffer

Valor de propiedad

string | number | Buffer

messageId

El identificador del mensaje es un valor definido por la aplicación que identifica de forma única el mensaje y su carga.

Nota: No se permiten números enteros que no son enteros.

messageId?: string | number | Buffer

Valor de propiedad

string | number | Buffer

partitionKey

Clave de partición para enviar un mensaje a una entidad con particiones. La longitud máxima es de 128 caracteres. Para entidades 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 se elige mediante una función hash sobre este valor y no se puede elegir directamente.

• En el caso de las entidades compatibles con la sesión, la propiedad sessionId invalida este valor.
• En el caso de las entidades sin particiones, se omitirá la clave de partición.

partitionKey?: string

Valor de propiedad

string

replyTo

Dirección de una entidad a la que se van a enviar respuestas. Este valor opcional y definido por la aplicación es una manera estándar de expresar una ruta 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 de mensajes y correlación.

replyTo?: string

Valor de propiedad

string

replyToSessionId

Identificador de sesión que aumenta la dirección replyTo. La longitud máxima es de 128 caracteres. Este valor aumenta la información de ReplyTo y especifica qué SessionId se debe establecer para la respuesta cuando se envía a la entidad de respuesta. Consulte enrutamiento de mensajes y correlación.

replyToSessionId?: string

Valor de propiedad

string

scheduledEnqueueTimeUtc

Fecha y hora en UTC a la que se pondrá en cola el mensaje. Esta propiedad devuelve la hora en UTC; al establecer la propiedad , el valor DateTime proporcionado también debe estar en UTC. Este valor es para el envío de mensajes retrasados. Se utiliza para retrasar el envío de mensajes a un momento específico en el futuro. El tiempo de puesta en cola del mensaje no significa que el mensaje se enviará al mismo tiempo. Se pondrá en cola, pero el tiempo de envío real depende de la carga de trabajo de la cola y su estado.

scheduledEnqueueTimeUtc?: Date

Valor de propiedad

Date

sessionId

Identificador de sesión de una entidad compatible con sesión. La longitud máxima es de 128 caracteres. En el caso de las entidades compatibles con la 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 sujetos al bloqueo de resumen y habilitan el procesamiento y desmultiplexing exactos en orden. En el caso de las entidades que no son conscientes de la sesión, este valor se omite. sesiones de mensajes.

sessionId?: string

Valor de propiedad

string

subject

Etiqueta específica de la aplicación. Esta propiedad permite a la aplicación indicar el propósito del mensaje al receptor en un estándar. moda, similar a una línea de asunto de correo electrónico. La propiedad AMQP asignada es "subject".

subject?: string

Valor de propiedad

string

timeToLive

El tiempo de vida del mensaje. Este valor es la duración relativa después de la cual expira el mensaje, comenzando desde el momento en que el agente ha aceptado y almacenado el mensaje, como se captura en enqueuedTimeUtc. Cuando no se establece explícitamente, el valor asumido es DefaultTimeToLive para la cola o tema correspondientes. Un valor de timeToLive de nivel de mensaje no puede ser mayor que el valor DefaultTimeToLive de la entidad y se ajusta silenciosamente si lo hace. Consulte Expiración.

timeToLive?: number

Valor de propiedad

number

to

Dirección "to". Esta propiedad está reservada para su uso futuro en escenarios de enrutamiento y actualmente se omite por el propio agente. Las aplicaciones pueden usar este valor en escenarios de encadenamiento de reenvío automático controlado por reglas para indicar el destino lógico previsto del mensaje.

to?: string

Valor de propiedad

string