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 permettant de tuer le message.
deadLetterReason	Raison de la mort 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éfinissez uniquement les messages qui ont été mis en lettres mortes et transférés automatiquement à partir de la sous-file d’attente de lettres mortes vers une autre entité. Indique l’entité dans laquelle le message a été mis en lettres mortes.
deliveryCount	Nombre de remises tentées pour ce message. Le nombre est incrémenté lorsqu’un verrou de message expire ou que le message est explicitement abandonné à l’aide de la abandon() méthode du message.
enqueuedSequenceNumber	Numéro de séquence d’origine du message. Pour les messages qui ont été transférés automatiquement, cette propriété reflète le numéro de séquence qui avait d’abord été affecté au message à son point d’origine de soumission.
enqueuedTimeUtc	Instant UTC auquel le message a été accepté et stocké dans Service Bus.
expiresAtUtc	Instant UTC où le message est marqué pour suppression et n’est plus disponible pour la récupération de l’entité en raison de l’expiration. Cette propriété est calculée à partir de 2 autres propriétés sur le message : enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Instant UTC jusqu’à ce que le message soit verrouillé dans la file d’attente/abonnement. Lorsque le verrou expire, le deliveryCount est incrémenté et le message est à nouveau disponible pour la récupération. Ne s’applique pas lorsque le message est reçu en receiveAndDelete mode de réception. mode.
lockToken	Le jeton de verrou est une référence au verrou détenu par le broker en peekLock mode de réception. Les verrous sont utilisés en interne pour régler les messages, comme expliqué plus en détail dans la documentation du produit Ne s’applique pas lorsque le message est reçu en receiveAndDelete mode de réception. mode.
sequenceNumber	Numéro unique affecté à un message par Service Bus. Le numéro de séquence est un entier 64 bits unique affecté à un message tel qu’il est accepté et stocké par le répartiteur et fonctionne comme identificateur vrai. Pour les entités partitionnée, les 16 bits les plus grands reflètent l’identificateur de partition. Les nombres de séquences augmentent de façon monotonique. Ils passent à 0 lorsque la plage de 48-64 bits est épuisée. L’entier maximal que Javascript prend actuellement en charge est 2^53 - 1. Le numéro de séquence est de type AMQP Long qui peut avoir une longueur maximale de 64 bits. Pour représenter cela, nous utilisons une bibliothèque nommée long.js. Nous nous attendons à ce que les clients 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 de 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 recevant le message n’utilise pas ce Kit de développement logiciel (SDK), convertissez votre charge utile du corps en tableau d’octets ou en mémoire tampon pour une meilleure compatibilité inter-langage.
contentType	Type de contenu du message. Décrit éventuellement la charge utile du message, avec un descripteur suivant le format de 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 reflétant l’ID message d’un message auquel un message est répondu. Reportez-vous à la section 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 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 sur cette valeur et ne peut pas être choisie directement. Pour les entités prenant en charge la session, la sessionId propriété remplace cette valeur. Pour les entités non partitionnés, 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 de réponse au destinataire du message. Lorsqu’un expéditeur attend une réponse, il définit la valeur sur le chemin absolu ou relatif de la file d’attente ou de la rubrique à laquelle il attend que la réponse soit envoyée. Reportez-vous à la section Routage et corrélation des messages.
replyToSessionId	L’identificateur de session qui augmente l’adresse replyTo . La longueur maximale est de 128 caractères. Cette valeur augmente les informations ReplyTo et spécifie l’ID de session à définir pour la réponse lorsqu’elle est envoyée à l’entité de réponse. Reportez-vous à la section 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 au format UTC ; lors de la définition de la propriété, la valeur DateTime fournie doit également être au format 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 à l’avenir. 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. Pour les entités prenant en charge les sessions, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages avec le même identificateur de session sont soumis à un verrouillage récapitulative et activent le traitement et la démultiplexation exacts dans l’ordre. Pour les entités sans connaissance de session, cette valeur est ignorée. Sessions de messages.
subject	Étiquette spécifique à l’application. Cette propriété permet à l’application d’indiquer l’objectif du message au destinataire dans une norme. mode, similaire à une ligne d’objet e-mail. La propriété AMQP mappée est « subject ».
timeToLive	Temps de vie du message. Cette valeur est la durée relative après laquelle le message expire, à compter de l’instant où il a été accepté et stocké par le courtier, comme illustré dans enqueuedTimeUtc. Lorsqu’elle n’est pas définie explicitement, la valeur supposée est DefaultTimeToLive pour la file d’attente ou la rubrique correspondante. Une valeur au niveau timeToLive du message ne peut pas être supérieure au paramètre DefaultTimeToLive de l’entité, et elle est ajustée en mode silencieux si c’est le cas. Voir Expiration.
to	Adresse « à ». Cette propriété est réservée à une utilisation future dans les scénarios de routage et actuellement ignorée par le répartiteur lui-même. Les applications peuvent utiliser cette valeur dans des scénarios de chaînage de transfert 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 permettant de tuer le message.

deadLetterErrorDescription?: string

Valeur de propriété

string

deadLetterReason

Raison de la mort 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éfinissez uniquement les messages qui ont été mis en lettres mortes et transférés automatiquement à partir de la sous-file d’attente de lettres mortes vers une autre entité. Indique l’entité dans laquelle le message a été mis en lettres mortes.

deadLetterSource?: string

Valeur de propriété

string

deliveryCount

Nombre de remises tentées pour ce message. Le nombre est incrémenté lorsqu’un verrou de message expire ou que le message est explicitement abandonné à l’aide de la abandon() méthode du message.

deliveryCount?: number

Valeur de propriété

number

enqueuedSequenceNumber

Numéro de séquence d’origine du message. Pour les messages qui ont été transférés automatiquement, cette propriété reflète le numéro de séquence qui avait d’abord été affecté au message à son point d’origine de soumission.

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

Instant UTC où le message est marqué pour suppression et n’est plus disponible pour la récupération de l’entité en raison de l’expiration. Cette propriété est calculée à partir de 2 autres propriétés sur le 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/abonnement. Lorsque le verrou expire, le deliveryCount est incrémenté et le message est à nouveau disponible pour la récupération.

• Ne s’applique pas lorsque le message est reçu en receiveAndDelete mode de réception. mode.

lockedUntilUtc?: Date

Valeur de propriété

Date

lockToken

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

• Ne s’applique pas lorsque le message est reçu en receiveAndDelete mode de réception. mode.

lockToken?: string

Valeur de propriété

string

sequenceNumber

Numéro unique affecté à un message par Service Bus. Le numéro de séquence est un entier 64 bits unique affecté à un message tel qu’il est accepté et stocké par le répartiteur et fonctionne comme identificateur vrai. Pour les entités partitionnée, les 16 bits les plus grands reflètent l’identificateur de partition. Les nombres de séquences augmentent de façon monotonique. Ils passent à 0 lorsque la plage de 48-64 bits est épuisée.

L’entier maximal que Javascript prend actuellement en charge est 2^53 - 1. Le numéro de séquence est de type AMQP Long qui peut avoir une longueur maximale de 64 bits. Pour représenter cela, nous utilisons une bibliothèque nommée long.js. Nous nous attendons à ce que les clients 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 de 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é deServiceBusMessage.applicationProperties

body

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

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 suivant le format de 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 reflétant l’ID message d’un message auquel un message est répondu. Reportez-vous à la section Routage et corrélation des messages.

correlationId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

Hérité 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 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 sur cette valeur et ne peut pas être choisie directement.

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

partitionKey?: string

Valeur de propriété

string

Hérité 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 de réponse au destinataire du message. Lorsqu’un expéditeur attend une réponse, il définit la valeur sur le chemin absolu ou relatif de la file d’attente ou de la rubrique à laquelle il attend que la réponse soit envoyée. Reportez-vous à la section Routage et corrélation des messages.

replyTo?: string

Valeur de propriété

string

Hérité deServiceBusMessage.replyTo

replyToSessionId

L’identificateur de session qui augmente l’adresse replyTo . La longueur maximale est de 128 caractères. Cette valeur augmente les informations ReplyTo et spécifie l’ID de session à définir pour la réponse lorsqu’elle est envoyée à l’entité de réponse. Reportez-vous à la section 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 au format UTC ; lors de la définition de la propriété, la valeur DateTime fournie doit également être au format 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 à l’avenir. 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. Pour les entités prenant en charge les sessions, cette valeur définie par l’application spécifie l’affiliation de session du message. Les messages avec le même identificateur de session sont soumis à un verrouillage récapitulative et activent le traitement et la démultiplexation exacts dans l’ordre. Pour les entités sans connaissance de session, cette valeur est ignorée. Sessions de messages.

sessionId?: string

Valeur de propriété

string

Hérité deServiceBusMessage.sessionId

subject

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

subject?: string

Valeur de propriété

string

Hérité deServiceBusMessage.subject

timeToLive

Temps de vie du message. Cette valeur est la durée relative après laquelle le message expire, à compter de l’instant où il a été accepté et stocké par le courtier, comme illustré dans enqueuedTimeUtc. Lorsqu’elle n’est pas définie explicitement, la valeur supposée est DefaultTimeToLive pour la file d’attente ou la rubrique correspondante. Une valeur au niveau timeToLive du message ne peut pas être supérieure au paramètre DefaultTimeToLive de l’entité, et elle est ajustée en mode silencieux si c’est le cas. Voir Expiration.

timeToLive?: number

Valeur de propriété

number

Hérité deServiceBusMessage.timeToLive

to

Adresse « à ». Cette propriété est réservée à une utilisation future dans les scénarios de routage et actuellement ignorée par le répartiteur lui-même. Les applications peuvent utiliser cette valeur dans des scénarios de chaînage de transfert 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