ServiceBusReceivedMessage interface

Paquete:

@azure/service-bus

Describe el mensaje recibido de Service Bus durante las operaciones de inspección, por lo que no se puede resolver.

Extends

ServiceBusMessage

Propiedades

deadLetterErrorDescription	Descripción del error para la creación de mensajes fallidos.
deadLetterReason	El motivo de que se interbloquee el mensaje.
deadLetterSource	El nombre de la cola o la suscripción en la que se puso en cola este mensaje, antes de que se intercaló. Solo se establece en mensajes fallidos y que posteriormente se reenvía automáticamente de la sub cola de mensajes fallidos a otra entidad. Indica la entidad donde se encontraba el mensaje fallido.
deliveryCount	Número de entregas que se han intentado para este mensaje. El recuento se incrementa cuando expira un bloqueo de mensaje o el mensaje se abandona explícitamente mediante el abandon() método en el mensaje.
enqueuedSequenceNumber	Número de secuencia original del mensaje. 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.
enqueuedTimeUtc	El instante UTC en el que se ha aceptado y almacenado el mensaje en Service Bus.
expiresAtUtc	El instante en hora UTC en el que el mensaje se marca para su eliminación y ya no está disponible para la recuperación de la entidad debido a la expiración. Esta propiedad se calcula a partir de 2 otras propiedades en el mensaje: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	El instante UTC hasta el que el mensaje se mantiene bloqueado en la cola o suscripción. Cuando el bloqueo expira, deliveryCount se incrementa y el mensaje vuelve a estar disponible para su recuperación. No es aplicable cuando el mensaje se recibe en receiveAndDelete modo de recepción. .
lockToken	El token de bloqueo es una referencia al bloqueo que el agente mantiene en peekLock modo de recepción. Los bloqueos se usan internamente para liquidar mensajes, como se explica en la documentación del producto con más detalle. No es aplicable cuando el mensaje se recibe en receiveAndDelete modo de recepción. .
sequenceNumber	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. Número entero máximo seguro que JavaScript admite actualmente es 2^53 - 1. El número de secuencia es un tipo AMQP Long que puede tener hasta 64 bits de longitud. Para representar que usamos una biblioteca denominada long.js. Esperamos que los clientes usen el Long tipo exportado por esta biblioteca.
state	El estado del mensaje puede estar activo, diferido o programado. Los mensajes diferidos tienen un estado diferido, los mensajes programados tienen estado programado, todos los demás mensajes tienen estado activo.

Propiedades heredadas

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	El tipo de contenido del mensaje. Opcionalmente, describe la carga del mensaje, con un descriptor que sigue el formato 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 responde. Consulte Enrutamiento y correlación de mensajes.
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 enteros.
partitionKey	Clave de partición para enviar un mensaje a una entidad con particiones. La longitud máxima es de 128 caracteres. En el caso de entidades con particiones, la configuración de este valor permite asignar mensajes relacionados a la misma partición interna, por lo que el orden de la secuencia de envío se registra correctamente. La partición la elige una función hash sobre este valor y no se puede seleccionar directamente. En el caso de las entidades compatibles con la sesión, la sessionId propiedad 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 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.
replyToSessionId	Identificador de sesión que aumenta la replyTo dirección. La longitud máxima es de 128 caracteres. Este valor aumenta la información de ReplyTo y especifica qué propiedad SessionId debe establecerse para la respuesta cuando se envió a la entidad de respuesta. Consulte Enrutamiento y correlación de mensajes.
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 envíe 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. Para entidades que tienen en cuenta 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 sujetas al bloqueo de resumen y habilitan el procesamiento en orden exacto y la desmultiplexación. Para las entidades que no tienen en cuenta 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. fashion, similar a una línea de asunto de correo electrónico. La propiedad AMQP asignada es "subject".
timeToLive	El valor de tiempo de vida del 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 enqueuedTimeUtc. Cuando no se establece explícitamente, el valor asumido es DefaultTimeToLive para la cola o tema correspondiente. Un valor de nivel timeToLive de mensaje no puede ser mayor que la configuración DefaultTimeToLive de la entidad y se ajusta silenciosamente si lo hace. Consulte Expiración.
to	Dirección "to". Esta propiedad está reservada para un uso futuro en escenarios de enrutamiento y actualmente la omite 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

deadLetterErrorDescription

Descripción del error para la creación de mensajes fallidos.

deadLetterErrorDescription?: string

Valor de propiedad

string

deadLetterReason

El motivo de que se interbloquee el mensaje.

deadLetterReason?: string

Valor de propiedad

string

deadLetterSource

El nombre de la cola o la suscripción en la que se puso en cola este mensaje, antes de que se intercaló. Solo se establece en mensajes fallidos y que posteriormente se reenvía automáticamente de la sub cola de mensajes fallidos a otra entidad. Indica la entidad donde se encontraba el mensaje fallido.

deadLetterSource?: string

Valor de propiedad

string

deliveryCount

Número de entregas que se han intentado para este mensaje. El recuento se incrementa cuando expira un bloqueo de mensaje o el mensaje se abandona explícitamente mediante el abandon() método en el mensaje.

deliveryCount?: number

Valor de propiedad

number

enqueuedSequenceNumber

Número de secuencia original del mensaje. 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.

enqueuedSequenceNumber?: number

Valor de propiedad

number

enqueuedTimeUtc

El instante UTC en el que se ha aceptado y almacenado el mensaje en Service Bus.

enqueuedTimeUtc?: Date

Valor de propiedad

Date

expiresAtUtc

El instante en hora UTC en el que el mensaje se marca para su eliminación y ya no está disponible para la recuperación de la entidad debido a la expiración. Esta propiedad se calcula a partir de 2 otras propiedades en el mensaje: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Valor de propiedad

Date

lockedUntilUtc

El instante UTC hasta el que el mensaje se mantiene bloqueado en la cola o suscripción. Cuando el bloqueo expira, deliveryCount se incrementa y el mensaje vuelve a estar disponible para su recuperación.

• No es aplicable cuando el mensaje se recibe en receiveAndDelete modo de recepción. .

lockedUntilUtc?: Date

Valor de propiedad

Date

lockToken

El token de bloqueo es una referencia al bloqueo que el agente mantiene en peekLock modo de recepción. Los bloqueos se usan internamente para liquidar mensajes, como se explica en la documentación del producto con más detalle.

• No es aplicable cuando el mensaje se recibe en receiveAndDelete modo de recepción. .

lockToken?: string

Valor de propiedad

string

sequenceNumber

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.

Número entero máximo seguro que JavaScript admite actualmente es 2^53 - 1. El número de secuencia es un tipo AMQP Long que puede tener hasta 64 bits de longitud. Para representar que usamos una biblioteca denominada long.js. Esperamos que los clientes usen el Long tipo exportado por esta biblioteca.

sequenceNumber?: Long

Valor de propiedad

Long

state

El estado del mensaje puede estar activo, diferido o programado. Los mensajes diferidos tienen un estado diferido, los mensajes programados tienen estado programado, todos los demás mensajes tienen estado activo.

state: "active" | "deferred" | "scheduled"

Valor de propiedad

"active" | "deferred" | "scheduled"

Detalles de las propiedades heredadas

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}

Heredado deServiceBusMessage.applicationProperties

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

Heredado deServiceBusMessage.body

contentType

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

contentType?: string

Valor de propiedad

string

Heredado deServiceBusMessage.contentType

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 responde. Consulte Enrutamiento y correlación de mensajes.

correlationId?: string | number | Buffer

Valor de propiedad

string | number | Buffer

Heredado deServiceBusMessage.correlationId

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

messageId?: string | number | Buffer

Valor de propiedad

string | number | Buffer

Heredado deServiceBusMessage.messageId

partitionKey

Clave de partición para enviar un mensaje a una entidad con particiones. La longitud máxima es de 128 caracteres. En el caso de entidades con particiones, la configuración de este valor permite asignar mensajes relacionados a la misma partición interna, por lo que el orden de la secuencia de envío se registra correctamente. La partición la elige una función hash sobre este valor y no se puede seleccionar directamente.

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

partitionKey?: string

Valor de propiedad

string

Heredado deServiceBusMessage.partitionKey

replyTo

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.

replyTo?: string

Valor de propiedad

string

Heredado deServiceBusMessage.replyTo

replyToSessionId

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

replyToSessionId?: string

Valor de propiedad

string

Heredado deServiceBusMessage.replyToSessionId

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 envíe 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

Heredado deServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identificador de sesión de una entidad compatible con sesión. La longitud máxima es de 128 caracteres. Para entidades que tienen en cuenta 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 sujetas al bloqueo de resumen y habilitan el procesamiento en orden exacto y la desmultiplexación. Para las entidades que no tienen en cuenta la sesión, este valor se omite. Sesiones de mensajes.

sessionId?: string

Valor de propiedad

string

Heredado deServiceBusMessage.sessionId

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. fashion, similar a una línea de asunto de correo electrónico. La propiedad AMQP asignada es "subject".

subject?: string

Valor de propiedad

string

Heredado deServiceBusMessage.subject

timeToLive

El valor de tiempo de vida del 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 enqueuedTimeUtc. Cuando no se establece explícitamente, el valor asumido es DefaultTimeToLive para la cola o tema correspondiente. Un valor de nivel timeToLive de mensaje no puede ser mayor que la configuración DefaultTimeToLive de la entidad y se ajusta silenciosamente si lo hace. Consulte Expiración.

timeToLive?: number

Valor de propiedad

number

Heredado deServiceBusMessage.timeToLive

to

Dirección "to". Esta propiedad está reservada para un uso futuro en escenarios de enrutamiento y actualmente la omite 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

Heredado deServiceBusMessage.to