ServiceBusMessage interface

Paquet:

@azure/service-bus

Décrit le message à envoyer à Service Bus.

Propriétés

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 suivant le 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 l’Id de message d’un message auquel est répondu. 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 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 correspond à l’envoi de messages différés. Il est utilisé pour retarder l’envoi des messages à une heure spécifique à l’avenir. L’heure de mise en file d’attente de message ne signifie pas que le message sera envoyé en même temps. Il sera 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 destinataire dans un standard. fashion, similaire à une ligne d’objet de courrier électronique. 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 être plus longue que 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és par des règles pour indiquer la destination logique prévue du message.

Détails de la propriété

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}

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

contentType

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

contentType?: string

Valeur de propriété

string

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 l’Id de message d’un message auquel est répondu. Consultez Routage et corrélation des messages.

correlationId?: string | number | Buffer

Valeur de propriété

string | number | Buffer

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

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

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

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

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 correspond à l’envoi de messages différés. Il est utilisé pour retarder l’envoi des messages à une heure spécifique à l’avenir. L’heure de mise en file d’attente de message ne signifie pas que le message sera envoyé en même temps. Il sera 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

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

subject

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

subject?: string

Valeur de propriété

string

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 être plus longue que 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

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és par des règles pour indiquer la destination logique prévue du message.

to?: string

Valeur de propriété

string