ServiceBusMessage interface

Pakket:

@azure/service-bus

Beschrijft het bericht dat naar Service Bus moet worden verzonden.

Eigenschappen

applicationProperties	De toepassingsspecifieke eigenschappen die kunnen worden gebruikt voor aangepaste berichtmetagegevens.
body	De berichttekst die moet worden verzonden of ontvangen. Als de toepassing die het bericht ontvangt, deze SDK niet gebruikt, converteert u de nettolading van de hoofdtekst naar een bytematrix of buffer voor een betere compatibiliteit tussen talen.
contentType	Het inhoudstype van het bericht. Beschrijft eventueel de nettolading van het bericht, met een descriptor volgens de indeling RFC2045, sectie 5, bijvoorbeeld 'application/json'.
correlationId	De correlatie-id waarmee een toepassing een context voor het bericht kan opgeven voor correlatiedoeleinden, bijvoorbeeld met de MessageId van een bericht dat wordt beantwoord. Zie Berichtroutering en -correlatie.
messageId	De bericht-id is een door de toepassing gedefinieerde waarde die het bericht en de nettolading uniek identificeert. Opmerking: getallen die geen gehele getallen zijn, zijn niet toegestaan.
partitionKey	De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit. De maximale lengte is 128 tekens. Als u deze waarde instelt voor gepartitioneerde entiteiten, kunt u gerelateerde berichten toewijzen aan dezelfde interne partitie, zodat de volgorde van de indieningsvolgorde correct wordt vastgelegd. De partitie wordt gekozen door een hash-functie boven deze waarde en kan niet rechtstreeks worden gekozen. Voor sessiebewuste entiteiten overschrijft de sessionId eigenschap deze waarde. Voor niet-gepartitioneerde entiteiten wordt de partitiesleutel genegeerd
replyTo	Het adres van een entiteit waarnaar u antwoorden wilt verzenden. Deze optionele en door de toepassing gedefinieerde waarde is een standaardmethode om een antwoordpad naar de ontvanger van het bericht uit te drukken. Wanneer een afzender een antwoord verwacht, wordt de waarde ingesteld op het absolute of relatieve pad van de wachtrij of het onderwerp waarnaar het antwoord moet worden verzonden. Zie Berichtroutering en -correlatie.
replyToSessionId	De sessie-id die het replyTo adres aangeeft. De maximale lengte is 128 tekens. Deze waarde vergroot de ReplyTo-informatie en geeft aan welke SessionId moet worden ingesteld voor het antwoord wanneer deze naar de antwoordentiteit wordt verzonden. Zie Berichtroutering en -correlatie.
scheduledEnqueueTimeUtc	De datum en tijd in UTC waarop het bericht wordt gewacht. Deze eigenschap retourneert de tijd in UTC; bij het instellen van de eigenschap moet de opgegeven datum/tijd-waarde ook in UTC zijn. Deze waarde is voor het verzenden van vertraagde berichten. Het wordt gebruikt om het verzenden van berichten naar een bepaald tijdstip in de toekomst te vertragen. De tijd van het verzenden van berichten betekent niet dat het bericht tegelijkertijd wordt verzonden. De werkelijke verzendtijd is afhankelijk van de workload en de status van de wachtrij.
sessionId	De sessie-id voor een sessiebewuste entiteit. De maximale lengte is 128 tekens. Voor sessiebewuste entiteiten geeft deze toepassingsgedefinieerde waarde de sessierelatie van het bericht op. Berichten met dezelfde sessie-id zijn onderhevig aan samenvattingsvergrendeling en maken exacte verwerking op volgorde en demultiplexing mogelijk. Voor entiteiten die geen sessie hebben, wordt deze waarde genegeerd. Berichtsessies.
subject	Het toepassingsspecifieke label. Met deze eigenschap kan de toepassing het doel van het bericht aan de ontvanger aangeven in een gestandaardiseerd. mode, vergelijkbaar met de onderwerpregel van een e-mail. De toegewezen AMQP-eigenschap is 'subject'.
timeToLive	De time-to-live-waarde van het bericht. Deze waarde is de relatieve duur waarna het bericht verloopt, te beginnen vanaf het moment dat het bericht is geaccepteerd en opgeslagen door de broker, zoals vastgelegd in enqueuedTimeUtc. Wanneer deze niet expliciet is ingesteld, is de veronderstelde waarde de DefaultTimeToLive voor de respectieve wachtrij of het betreffende onderwerp. Een waarde op berichtniveau timeToLive mag niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dat het geval is. Zie Vervaldatum.
to	Het 'naar'-adres. Deze eigenschap is gereserveerd voor toekomstig gebruik in routeringsscenario's en wordt momenteel genegeerd door de broker zelf. Toepassingen kunnen deze waarde gebruiken in regelgestuurde scenario's voor het automatisch doorsturen van ketens om de beoogde logische bestemming van het bericht aan te geven.

Eigenschapdetails

applicationProperties

De toepassingsspecifieke eigenschappen die kunnen worden gebruikt voor aangepaste berichtmetagegevens.

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

Waarde van eigenschap

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

body

De berichttekst die moet worden verzonden of ontvangen. Als de toepassing die het bericht ontvangt, deze SDK niet gebruikt, converteert u de nettolading van de hoofdtekst naar een bytematrix of buffer voor een betere compatibiliteit tussen talen.

body: any

Waarde van eigenschap

any

contentType

Het inhoudstype van het bericht. Beschrijft eventueel de nettolading van het bericht, met een descriptor volgens de indeling RFC2045, sectie 5, bijvoorbeeld 'application/json'.

contentType?: string

Waarde van eigenschap

string

correlationId

De correlatie-id waarmee een toepassing een context voor het bericht kan opgeven voor correlatiedoeleinden, bijvoorbeeld met de MessageId van een bericht dat wordt beantwoord. Zie Berichtroutering en -correlatie.

correlationId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

messageId

De bericht-id is een door de toepassing gedefinieerde waarde die het bericht en de nettolading uniek identificeert.

Opmerking: getallen die geen gehele getallen zijn, zijn niet toegestaan.

messageId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

partitionKey

De partitiesleutel voor het verzenden van een bericht naar een gepartitioneerde entiteit. De maximale lengte is 128 tekens. Als u deze waarde instelt voor gepartitioneerde entiteiten, kunt u gerelateerde berichten toewijzen aan dezelfde interne partitie, zodat de volgorde van de indieningsvolgorde correct wordt vastgelegd. De partitie wordt gekozen door een hash-functie boven deze waarde en kan niet rechtstreeks worden gekozen.

• Voor sessiebewuste entiteiten overschrijft de sessionId eigenschap deze waarde.
• Voor niet-gepartitioneerde entiteiten wordt de partitiesleutel genegeerd

partitionKey?: string

Waarde van eigenschap

string

replyTo

Het adres van een entiteit waarnaar u antwoorden wilt verzenden. Deze optionele en door de toepassing gedefinieerde waarde is een standaardmethode om een antwoordpad naar de ontvanger van het bericht uit te drukken. Wanneer een afzender een antwoord verwacht, wordt de waarde ingesteld op het absolute of relatieve pad van de wachtrij of het onderwerp waarnaar het antwoord moet worden verzonden. Zie Berichtroutering en -correlatie.

replyTo?: string

Waarde van eigenschap

string

replyToSessionId

De sessie-id die het replyTo adres aangeeft. De maximale lengte is 128 tekens. Deze waarde vergroot de ReplyTo-informatie en geeft aan welke SessionId moet worden ingesteld voor het antwoord wanneer deze naar de antwoordentiteit wordt verzonden. Zie Berichtroutering en -correlatie.

replyToSessionId?: string

Waarde van eigenschap

string

scheduledEnqueueTimeUtc

De datum en tijd in UTC waarop het bericht wordt gewacht. Deze eigenschap retourneert de tijd in UTC; bij het instellen van de eigenschap moet de opgegeven datum/tijd-waarde ook in UTC zijn. Deze waarde is voor het verzenden van vertraagde berichten. Het wordt gebruikt om het verzenden van berichten naar een bepaald tijdstip in de toekomst te vertragen. De tijd van het verzenden van berichten betekent niet dat het bericht tegelijkertijd wordt verzonden. De werkelijke verzendtijd is afhankelijk van de workload en de status van de wachtrij.

scheduledEnqueueTimeUtc?: Date

Waarde van eigenschap

Date

sessionId

De sessie-id voor een sessiebewuste entiteit. De maximale lengte is 128 tekens. Voor sessiebewuste entiteiten geeft deze toepassingsgedefinieerde waarde de sessierelatie van het bericht op. Berichten met dezelfde sessie-id zijn onderhevig aan samenvattingsvergrendeling en maken exacte verwerking op volgorde en demultiplexing mogelijk. Voor entiteiten die geen sessie hebben, wordt deze waarde genegeerd. Berichtsessies.

sessionId?: string

Waarde van eigenschap

string

subject

Het toepassingsspecifieke label. Met deze eigenschap kan de toepassing het doel van het bericht aan de ontvanger aangeven in een gestandaardiseerd. mode, vergelijkbaar met de onderwerpregel van een e-mail. De toegewezen AMQP-eigenschap is 'subject'.

subject?: string

Waarde van eigenschap

string

timeToLive

De time-to-live-waarde van het bericht. Deze waarde is de relatieve duur waarna het bericht verloopt, te beginnen vanaf het moment dat het bericht is geaccepteerd en opgeslagen door de broker, zoals vastgelegd in enqueuedTimeUtc. Wanneer deze niet expliciet is ingesteld, is de veronderstelde waarde de DefaultTimeToLive voor de respectieve wachtrij of het betreffende onderwerp. Een waarde op berichtniveau timeToLive mag niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dat het geval is. Zie Vervaldatum.

timeToLive?: number

Waarde van eigenschap

number

to

Het 'naar'-adres. Deze eigenschap is gereserveerd voor toekomstig gebruik in routeringsscenario's en wordt momenteel genegeerd door de broker zelf. Toepassingen kunnen deze waarde gebruiken in regelgestuurde scenario's voor het automatisch doorsturen van ketens om de beoogde logische bestemming van het bericht aan te geven.

to?: string

Waarde van eigenschap

string