ServiceBusReceivedMessage interface

Paquet:

@azure/service-bus

Décrit le message reçu de Service Bus pendant les opérations d’aperçu et ne peut donc pas être réglé.

Extends

ServiceBusMessage

Propriétés

deadLetterErrorDescription	Description de l’erreur pour le courrier mort du message.
deadLetterReason	Raison de la lettre morte du message.
deadLetterSource	Nom de la file d’attente ou de l’abonnement sur lequel ce message a été mis en file d’attente, avant qu’il ne soit mis en file d’attente. Défini uniquement dans les messages qui ont été mis en lettres mortes et transférés automatiquement par la suite de la sous-file d’attente de lettres mortes vers une autre entité. Elle indique l’entité dans laquelle le message a été placé comme message de lettres mortes.
deliveryCount	Cette propriété indique le nombre de tentatives de remise de ce message. Le nombre est incrémenté lorsqu’un verrou de message expire, ou le message est explicitement abandonné à l’aide de la abandon() méthode sur le message.
enqueuedSequenceNumber	Numéro de séquence d’origine du message. Dans le cas des messages qui ont été transférés automatiquement, cette propriété reflète le numéro de séquence qui avait été initialement attribué au message à son point d’envoi d’origine.
enqueuedTimeUtc	Instant UTC auquel le message a été accepté et stocké dans Service Bus.
expiresAtUtc	Cette propriété indique l’heure UTC à laquelle le message est marqué pour suppression et n’est plus récupérable à partir de l’entité en raison de son arrivée à expiration. Cette propriété est calculée à partir de 2 autres propriétés du message : enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Instant UTC jusqu’à ce que le message soit verrouillé dans la file d’attente/l’abonnement. Lorsque le verrou expire, le deliveryCount est incrémenté et le message est à nouveau disponible pour récupération. Non applicable lorsque le message est reçu en receiveAndDelete mode réception. .
lockToken	Le jeton de verrou est une référence au verrou détenu par le répartiteur en peekLock mode de réception. Les verrous sont utilisés pour régler les messages en interne, comme expliqué plus en détail dans la documentation du produit Non applicable lorsque le message est reçu en receiveAndDelete mode réception. .
sequenceNumber	Numéro unique attribué à un message par Service Bus. Le numéro de séquence est un entier 64 bits unique attribué à un message lorsque celui-ci est accepté et stocké par le répartiteur, et fait office de véritable identificateur du message. Pour les entités partitionnées, les 16 premiers bits correspondent à l’identificateur de la partition. Les nombres de séquences augmentent de façon monotone. Ils repassent à 0 lorsque la plage 48 à 64 bits est épuisée. L’entier maximal sécurisé pris en charge par Javascript est 2^53 - 1. Le numéro de séquence est un type AMQP Long qui peut atteindre jusqu’à 64 bits. Pour représenter que nous utilisons une bibliothèque nommée long.js. Nous attendons des clients qu’ils utilisent le Long type exporté par cette bibliothèque.
state	L’état du message peut être actif, différé ou planifié. Les messages différés ont un état différé, les messages planifiés ont un état planifié, tous les autres messages ont un état actif.

Propriétés héritées

applicationProperties	Propriétés spécifiques à l’application qui peuvent être utilisées pour les métadonnées de message personnalisées.
body	Corps du message qui doit être envoyé ou reçu. Si l’application qui reçoit le message n’utilise pas ce Kit de développement logiciel (SDK), convertissez votre charge utile du corps en tableau d’octets ou mémoire tampon pour une meilleure compatibilité entre les langues.
contentType	Type de contenu du message. Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ».
correlationId	Identificateur de corrélation qui permet à une application de spécifier un contexte pour le message à des fins de corrélation, par exemple en reflétant le MessageId d’un message auquel une réponse est envoyée. Consultez Routage et corrélation des messages.
messageId	L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile. Remarque : Les nombres qui ne sont pas des entiers ne sont pas autorisés.
partitionKey	Clé de partition pour l’envoi d’un message à une entité partitionnée. La longueur maximale est de 128 caractères. Dans le cas des entités partitionnées, la définition de cette valeur permet d’attribuer des messages associés à la même partition interne, afin que l’ordre de séquence d’envoi soit correctement enregistré. La partition est choisie par une fonction de hachage prioritaire sur cette valeur et ne peut pas être sélectionnée directement. Pour les entités prenant en charge la session, la sessionId propriété remplace cette valeur. Pour les entités non partitionnée, la clé de partition est ignorée
replyTo	Adresse d’une entité à laquelle envoyer des réponses. Cette valeur facultative et définie par l’application est un moyen standard d’exprimer un chemin d’accès de réponse à l’intention du destinataire du message. Lorsqu’un expéditeur attend une réponse, cette propriété définit cette valeur sur le chemin d’accès absolu ou relatif de la file d’attente ou de la rubrique auxquelles la réponse doit être envoyée. Consultez Routage et corrélation des messages.
replyToSessionId	Identificateur de session qui augmente l’adresse replyTo . La longueur maximale est de 128 caractères. Cette valeur incrémente l’information ReplyTo et spécifie la valeur SessionId qui doit être définie pour la réponse lors de son envoi à l’entité de réponse. Consultez Routage et corrélation des messages.
scheduledEnqueueTimeUtc	Date et heure UTC auxquelles le message sera mis en file d’attente. Cette propriété retourne l’heure utc ; lors de la définition de la propriété, la valeur DateTime fournie doit également être utc. Cette valeur est destinée à l’envoi différé de messages. Il est utilisé pour retarder l’envoi de messages à une heure spécifique dans le futur. L’heure de mise en file d’attente du message ne signifie pas que le message sera envoyé en même temps. Il est mis en file d’attente, mais le temps d’envoi réel dépend de la charge de travail de la file d’attente et de son état.
sessionId	Identificateur de session pour une entité prenant en charge la session. La longueur maximale est de 128 caractères. Dans le cas des entités prenant en charge la session, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages dotés du même identificateur de session sont soumis à un verrouillage du résumé et permettent un traitement et un démultiplexage chronologiques. Dans le cas des entités ne prenant pas en charge la session, cette valeur est ignorée. Sessions de message.
subject	L’étiquette spécifique de l’application. Cette propriété permet à l’application d’indiquer l’objectif du message au récepteur dans un standard. mode, similaire à une ligne d’objet d’e-mail. La propriété AMQP mappée est « subject ».
timeToLive	Valeur de durée de vie du message. Cette valeur est la durée relative après laquelle le message expire, à partir de l’instant où le message a été accepté et stocké par le répartiteur, comme capturé dans enqueuedTimeUtc. Lorsque cette valeur n’est pas définie explicitement, la valeur prise en compte est celle du paramètre DefaultTimeToLive pour la file d’attente ou la rubrique concernées. Une valeur au niveau timeToLive du message ne peut pas dépasser le paramètre DefaultTimeToLive de l’entité, et elle est ajustée en mode silencieux si c’est le cas. Consultez Expiration.
to	Adresse « à ». Cette propriété est réservée pour une utilisation ultérieure dans les scénarios de routage et est actuellement ignorée par le répartiteur proprement dit. Les applications peuvent utiliser cette valeur dans les scénarios de chaînage automatique piloté par des règles pour indiquer la destination logique prévue du message.

Détails de la propriété

deadLetterErrorDescription

Description de l’erreur pour le courrier mort du message.

deadLetterErrorDescription?: string

Valeur de propriété

string

deadLetterReason

Raison de la lettre morte du message.

deadLetterReason?: string

Valeur de propriété

string

deadLetterSource

Nom de la file d’attente ou de l’abonnement sur lequel ce message a été mis en file d’attente, avant qu’il ne soit mis en file d’attente. Défini uniquement dans les messages qui ont été mis en lettres mortes et transférés automatiquement par la suite de la sous-file d’attente de lettres mortes vers une autre entité. Elle indique l’entité dans laquelle le message a été placé comme message de lettres mortes.

deadLetterSource?: string

Valeur de propriété

string

deliveryCount

Cette propriété indique le nombre de tentatives de remise de ce message. Le nombre est incrémenté lorsqu’un verrou de message expire, ou le message est explicitement abandonné à l’aide de la abandon() méthode sur le message.

deliveryCount?: number

Valeur de propriété

number

enqueuedSequenceNumber

Numéro de séquence d’origine du message. Dans le cas des messages qui ont été transférés automatiquement, cette propriété reflète le numéro de séquence qui avait été initialement attribué au message à son point d’envoi d’origine.

enqueuedSequenceNumber?: number

Valeur de propriété

number

enqueuedTimeUtc

Instant UTC auquel le message a été accepté et stocké dans Service Bus.

enqueuedTimeUtc?: Date

Valeur de propriété

Date

expiresAtUtc

Cette propriété indique l’heure UTC à laquelle le message est marqué pour suppression et n’est plus récupérable à partir de l’entité en raison de son arrivée à expiration. Cette propriété est calculée à partir de 2 autres propriétés du message : enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Valeur de propriété

Date

lockedUntilUtc

Instant UTC jusqu’à ce que le message soit verrouillé dans la file d’attente/l’abonnement. Lorsque le verrou expire, le deliveryCount est incrémenté et le message est à nouveau disponible pour récupération.

• Non applicable lorsque le message est reçu en receiveAndDelete mode réception. .

lockedUntilUtc?: Date

Valeur de propriété

Date

lockToken

Le jeton de verrou est une référence au verrou détenu par le répartiteur en peekLock mode de réception. Les verrous sont utilisés pour régler les messages en interne, comme expliqué plus en détail dans la documentation du produit

• Non applicable lorsque le message est reçu en receiveAndDelete mode réception. .

lockToken?: string

Valeur de propriété

string

sequenceNumber

Numéro unique attribué à un message par Service Bus. Le numéro de séquence est un entier 64 bits unique attribué à un message lorsque celui-ci est accepté et stocké par le répartiteur, et fait office de véritable identificateur du message. Pour les entités partitionnées, les 16 premiers bits correspondent à l’identificateur de la partition. Les nombres de séquences augmentent de façon monotone. Ils repassent à 0 lorsque la plage 48 à 64 bits est épuisée.

L’entier maximal sécurisé pris en charge par Javascript est 2^53 - 1. Le numéro de séquence est un type AMQP Long qui peut atteindre jusqu’à 64 bits. Pour représenter que nous utilisons une bibliothèque nommée long.js. Nous attendons des clients qu’ils utilisent le Long type exporté par cette bibliothèque.

sequenceNumber?: Long

Valeur de propriété

Long

state

L’état du message peut être actif, différé ou planifié. Les messages différés ont un état différé, les messages planifiés ont un état planifié, tous les autres messages ont un état actif.

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

Valeur de propriété

"active" | "deferred" | "scheduled"

Détails de la propriété héritée

applicationProperties

Propriétés spécifiques à l’application qui peuvent être utilisées pour les métadonnées de message personnalisées.

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

Valeur de propriété

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

Héritée deServiceBusMessage.applicationProperties

body

Corps du message qui doit être envoyé ou reçu. Si l’application qui reçoit le message n’utilise pas ce Kit de développement logiciel (SDK), convertissez votre charge utile du corps en tableau d’octets ou mémoire tampon pour une meilleure compatibilité entre les langues.

body: any

Valeur de propriété

any

Hérité deServiceBusMessage.body

contentType

Type de contenu du message. Décrit éventuellement la charge utile du message, avec un descripteur au format RFC2045, Section 5, par exemple « application/json ».

contentType?: string

Valeur de propriété

string

Hérité deServiceBusMessage.contentType

correlationId

Identificateur de corrélation qui permet à une application de spécifier un contexte pour le message à des fins de corrélation, par exemple en reflétant le MessageId d’un message auquel une réponse est envoyée. Consultez Routage et corrélation des messages.

correlationId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

Héritée deServiceBusMessage.correlationId

messageId

L’identificateur de message est une valeur définie par l’application qui identifie de manière unique le message et sa charge utile.

Remarque : Les nombres qui ne sont pas des entiers ne sont pas autorisés.

messageId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

Hérité deServiceBusMessage.messageId

partitionKey

Clé de partition pour l’envoi d’un message à une entité partitionnée. La longueur maximale est de 128 caractères. Dans le cas des entités partitionnées, la définition de cette valeur permet d’attribuer des messages associés à la même partition interne, afin que l’ordre de séquence d’envoi soit correctement enregistré. La partition est choisie par une fonction de hachage prioritaire sur cette valeur et ne peut pas être sélectionnée directement.

• Pour les entités prenant en charge la session, la sessionId propriété remplace cette valeur.
• Pour les entités non partitionnée, la clé de partition est ignorée

partitionKey?: string

Valeur de propriété

string

Héritée deServiceBusMessage.partitionKey

replyTo

Adresse d’une entité à laquelle envoyer des réponses. Cette valeur facultative et définie par l’application est un moyen standard d’exprimer un chemin d’accès de réponse à l’intention du destinataire du message. Lorsqu’un expéditeur attend une réponse, cette propriété définit cette valeur sur le chemin d’accès absolu ou relatif de la file d’attente ou de la rubrique auxquelles la réponse doit être envoyée. Consultez Routage et corrélation des messages.

replyTo?: string

Valeur de propriété

string

Hérité deServiceBusMessage.replyTo

replyToSessionId

Identificateur de session qui augmente l’adresse replyTo . La longueur maximale est de 128 caractères. Cette valeur incrémente l’information ReplyTo et spécifie la valeur SessionId qui doit être définie pour la réponse lors de son envoi à l’entité de réponse. Consultez Routage et corrélation des messages.

replyToSessionId?: string

Valeur de propriété

string

Hérité deServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Date et heure UTC auxquelles le message sera mis en file d’attente. Cette propriété retourne l’heure utc ; lors de la définition de la propriété, la valeur DateTime fournie doit également être utc. Cette valeur est destinée à l’envoi différé de messages. Il est utilisé pour retarder l’envoi de messages à une heure spécifique dans le futur. L’heure de mise en file d’attente du message ne signifie pas que le message sera envoyé en même temps. Il est mis en file d’attente, mais le temps d’envoi réel dépend de la charge de travail de la file d’attente et de son état.

scheduledEnqueueTimeUtc?: Date

Valeur de propriété

Date

Hérité deServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identificateur de session pour une entité prenant en charge la session. La longueur maximale est de 128 caractères. Dans le cas des entités prenant en charge la session, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages dotés du même identificateur de session sont soumis à un verrouillage du résumé et permettent un traitement et un démultiplexage chronologiques. Dans le cas des entités ne prenant pas en charge la session, cette valeur est ignorée. Sessions de message.

sessionId?: string

Valeur de propriété

string

Hérité deServiceBusMessage.sessionId

subject

L’étiquette spécifique de l’application. Cette propriété permet à l’application d’indiquer l’objectif du message au récepteur dans un standard. mode, similaire à une ligne d’objet d’e-mail. La propriété AMQP mappée est « subject ».

subject?: string

Valeur de propriété

string

Hérité deServiceBusMessage.subject

timeToLive

Valeur de durée de vie du message. Cette valeur est la durée relative après laquelle le message expire, à partir de l’instant où le message a été accepté et stocké par le répartiteur, comme capturé dans enqueuedTimeUtc. Lorsque cette valeur n’est pas définie explicitement, la valeur prise en compte est celle du paramètre DefaultTimeToLive pour la file d’attente ou la rubrique concernées. Une valeur au niveau timeToLive du message ne peut pas dépasser le paramètre DefaultTimeToLive de l’entité, et elle est ajustée en mode silencieux si c’est le cas. Consultez Expiration.

timeToLive?: number

Valeur de propriété

number

Héritée deServiceBusMessage.timeToLive

to

Adresse « à ». Cette propriété est réservée pour une utilisation ultérieure dans les scénarios de routage et est actuellement ignorée par le répartiteur proprement dit. Les applications peuvent utiliser cette valeur dans les scénarios de chaînage automatique piloté par des règles pour indiquer la destination logique prévue du message.

to?: string

Valeur de propriété

string

Hérité deServiceBusMessage.to