ServiceBusReceivedMessage interface

Pakket:

@azure/service-bus

Beschrijft het bericht dat is ontvangen van Service Bus tijdens het weergeven en kan dus niet worden opgelost.

Uitbreiding

ServiceBusMessage

Eigenschappen

deadLetterErrorDescription	De beschrijving van de fout voor het doodletteren van het bericht.
deadLetterReason	De reden voor het doodletteren van het bericht.
deadLetterSource	De naam van de wachtrij of het abonnement waarvoor dit bericht is onderbroken, voordat het bericht in een impasse werd geplaatst. Alleen ingesteld in berichten die in een onbestelbare brief zijn geplaatst en vervolgens automatisch zijn doorgestuurd van de wachtrij met onbestelbare berichten naar een andere entiteit. Hiermee wordt de entiteit aangegeven waarin het bericht in een onbestelbare brief is geschreven.
deliveryCount	Aantal leveringen dat is geprobeerd voor dit bericht. Het aantal wordt verhoogd wanneer een berichtvergrendeling verloopt of wanneer het bericht expliciet wordt afgezien met behulp van de abandon() methode op het bericht.
enqueuedSequenceNumber	Het oorspronkelijke volgnummer van het bericht. Voor berichten die automatisch zijn doorgestuurd, geeft deze eigenschap het volgnummer weer dat voor het eerst aan het bericht was toegewezen op het oorspronkelijke moment van verzending.
enqueuedTimeUtc	Het UTC-moment waarop het bericht is geaccepteerd en opgeslagen in Service Bus.
expiresAtUtc	Het UTC-moment waarop het bericht is gemarkeerd voor verwijdering en niet meer kan worden opgehaald uit de entiteit vanwege de vervaldatum. Deze eigenschap wordt berekend op basis van 2 andere eigenschappen in het bericht: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Het UTC-moment totdat het bericht is vergrendeld in de wachtrij/het abonnement. Wanneer de vergrendeling verloopt, wordt de deliveryCount verhoogd en kan het bericht opnieuw worden opgehaald. Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete de ontvangstmodus. Modus.
lockToken	Het vergrendelingstoken is een verwijzing naar de vergrendeling die door de broker in peekLock de ontvangstmodus wordt gehouden. Vergrendelingen worden gebruikt om berichten intern te vereffenen, zoals uitgebreider wordt uitgelegd in de productdocumentatie Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete de ontvangstmodus. Modus.
sequenceNumber	Het unieke nummer dat door Service Bus aan een bericht is toegewezen. Het volgnummer is een uniek 64-bits geheel getal dat is toegewezen aan een bericht omdat het wordt geaccepteerd en opgeslagen door de broker en fungeert als de werkelijke id. Voor gepartitioneerde entiteiten weerspiegelen de bovenste 16 bits de partitie-id. Volgnummers nemen monotonisch toe. Ze rollen over naar 0 wanneer het 48-64-bits bereik is uitgeput. Het maximale veilige gehele getal dat momenteel door Javascript wordt ondersteund, is 2^53 - 1. Het volgnummer is een AMQP-type Long dat maximaal 64 bits lang kan zijn. Om aan te geven dat we een bibliotheek met de naam long.jsgebruiken. We verwachten dat klanten het Long type gebruiken dat door deze bibliotheek wordt geëxporteerd.
state	De status van het bericht kan actief, uitgesteld of gepland zijn. Uitgestelde berichten hebben een uitgestelde status, geplande berichten hebben de geplande status, alle andere berichten hebben de status Actief.

Overgenomen 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 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 waarop wordt gereageerd. 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 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 inzending 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 uit te drukken naar de ontvanger van het bericht. 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 vergroot. 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 ge-enqueued. 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 vertraagd verzenden van berichten. Het wordt gebruikt om het verzenden van berichten naar een bepaald tijdstip in de toekomst uit te stellen. Bericht enqueuing tijd betekent niet dat het bericht op hetzelfde moment 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 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 kan niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dat het geval is. Zie Verloopdatum.
to	Het 'aan'-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 automatisch doorsturen van ketens om de beoogde logische bestemming van het bericht aan te geven.

Eigenschapdetails

deadLetterErrorDescription

De beschrijving van de fout voor het doodletteren van het bericht.

deadLetterErrorDescription?: string

Waarde van eigenschap

string

deadLetterReason

De reden voor het doodletteren van het bericht.

deadLetterReason?: string

Waarde van eigenschap

string

deadLetterSource

De naam van de wachtrij of het abonnement waarvoor dit bericht is onderbroken, voordat het bericht in een impasse werd geplaatst. Alleen ingesteld in berichten die in een onbestelbare brief zijn geplaatst en vervolgens automatisch zijn doorgestuurd van de wachtrij met onbestelbare berichten naar een andere entiteit. Hiermee wordt de entiteit aangegeven waarin het bericht in een onbestelbare brief is geschreven.

deadLetterSource?: string

Waarde van eigenschap

string

deliveryCount

Aantal leveringen dat is geprobeerd voor dit bericht. Het aantal wordt verhoogd wanneer een berichtvergrendeling verloopt of wanneer het bericht expliciet wordt afgezien met behulp van de abandon() methode op het bericht.

deliveryCount?: number

Waarde van eigenschap

number

enqueuedSequenceNumber

Het oorspronkelijke volgnummer van het bericht. Voor berichten die automatisch zijn doorgestuurd, geeft deze eigenschap het volgnummer weer dat voor het eerst aan het bericht was toegewezen op het oorspronkelijke moment van verzending.

enqueuedSequenceNumber?: number

Waarde van eigenschap

number

enqueuedTimeUtc

Het UTC-moment waarop het bericht is geaccepteerd en opgeslagen in Service Bus.

enqueuedTimeUtc?: Date

Waarde van eigenschap

Date

expiresAtUtc

Het UTC-moment waarop het bericht is gemarkeerd voor verwijdering en niet meer kan worden opgehaald uit de entiteit vanwege de vervaldatum. Deze eigenschap wordt berekend op basis van 2 andere eigenschappen in het bericht: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Waarde van eigenschap

Date

lockedUntilUtc

Het UTC-moment totdat het bericht is vergrendeld in de wachtrij/het abonnement. Wanneer de vergrendeling verloopt, wordt de deliveryCount verhoogd en kan het bericht opnieuw worden opgehaald.

• Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete de ontvangstmodus. Modus.

lockedUntilUtc?: Date

Waarde van eigenschap

Date

lockToken

Het vergrendelingstoken is een verwijzing naar de vergrendeling die door de broker in peekLock de ontvangstmodus wordt gehouden. Vergrendelingen worden gebruikt om berichten intern te vereffenen, zoals uitgebreider wordt uitgelegd in de productdocumentatie

• Niet van toepassing wanneer het bericht wordt ontvangen in receiveAndDelete de ontvangstmodus. Modus.

lockToken?: string

Waarde van eigenschap

string

sequenceNumber

Het unieke nummer dat door Service Bus aan een bericht is toegewezen. Het volgnummer is een uniek 64-bits geheel getal dat is toegewezen aan een bericht omdat het wordt geaccepteerd en opgeslagen door de broker en fungeert als de werkelijke id. Voor gepartitioneerde entiteiten weerspiegelen de bovenste 16 bits de partitie-id. Volgnummers nemen monotonisch toe. Ze rollen over naar 0 wanneer het 48-64-bits bereik is uitgeput.

Het maximale veilige gehele getal dat momenteel door Javascript wordt ondersteund, is 2^53 - 1. Het volgnummer is een AMQP-type Long dat maximaal 64 bits lang kan zijn. Om aan te geven dat we een bibliotheek met de naam long.jsgebruiken. We verwachten dat klanten het Long type gebruiken dat door deze bibliotheek wordt geëxporteerd.

sequenceNumber?: Long

Waarde van eigenschap

Long

state

De status van het bericht kan actief, uitgesteld of gepland zijn. Uitgestelde berichten hebben een uitgestelde status, geplande berichten hebben de geplande status, alle andere berichten hebben de status Actief.

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

Waarde van eigenschap

"active" | "deferred" | "scheduled"

Details van overgenomen eigenschap

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}

Overgenomen vanServiceBusMessage.applicationProperties

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 betere compatibiliteit tussen talen.

body: any

Waarde van eigenschap

any

Overgenomen vanServiceBusMessage.body

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

Overgenomen vanServiceBusMessage.contentType

correlationId

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

correlationId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

Overgenomen vanServiceBusMessage.correlationId

messageId

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

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

messageId?: string | number | Buffer

Waarde van eigenschap

string | number | Buffer

Overgenomen vanServiceBusMessage.messageId

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 inzending 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

Overgenomen vanServiceBusMessage.partitionKey

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 uit te drukken naar de ontvanger van het bericht. 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

Overgenomen vanServiceBusMessage.replyTo

replyToSessionId

De sessie-id die het replyTo adres vergroot. 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

Overgenomen vanServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

De datum en tijd in UTC waarop het bericht wordt ge-enqueued. 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 vertraagd verzenden van berichten. Het wordt gebruikt om het verzenden van berichten naar een bepaald tijdstip in de toekomst uit te stellen. Bericht enqueuing tijd betekent niet dat het bericht op hetzelfde moment wordt verzonden. De werkelijke verzendtijd is afhankelijk van de workload en de status van de wachtrij.

scheduledEnqueueTimeUtc?: Date

Waarde van eigenschap

Date

Overgenomen vanServiceBusMessage.scheduledEnqueueTimeUtc

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 en demultiplexing mogelijk. Voor entiteiten die geen sessie hebben, wordt deze waarde genegeerd. Berichtsessies.

sessionId?: string

Waarde van eigenschap

string

Overgenomen vanServiceBusMessage.sessionId

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

Overgenomen vanServiceBusMessage.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 kan niet langer zijn dan de instelling DefaultTimeToLive van de entiteit en wordt op de achtergrond aangepast als dat het geval is. Zie Verloopdatum.

timeToLive?: number

Waarde van eigenschap

number

Overgenomen vanServiceBusMessage.timeToLive

to

Het 'aan'-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 automatisch doorsturen van ketens om de beoogde logische bestemming van het bericht aan te geven.

to?: string

Waarde van eigenschap

string

Overgenomen vanServiceBusMessage.to