ServiceBusReceivedMessage interface

Csomag:

@azure/service-bus

A Service Bustól a betekintő műveletek során kapott üzenetet ismerteti, ezért nem lehet rendezni.

Extends

ServiceBusMessage

Tulajdonságok

deadLetterErrorDescription	Az üzenet holtpontra helyezésének hibaleírása.
deadLetterReason	Az üzenet holtpontra helyezésének oka.
deadLetterSource	Annak az üzenetsornak vagy előfizetésnek a neve, amelyen az üzenet le lett foglalva, mielőtt az üzenet elhalt lett volna. Csak olyan üzenetekben van beállítva, amelyek elhalt betűsek voltak, majd automatikusan továbbítva lettek a kézbesítetlen levelek alsorából egy másik entitásba. Azt az entitást jelzi, amelyben az üzenet elhalt betűs volt.
deliveryCount	Az üzenethez megkísérelt kézbesítések száma. A szám növekszik, ha egy üzenetzár lejár, vagy az üzenet explicit módon felhagy az üzenet abandon() metódusával.
enqueuedSequenceNumber	Az üzenet eredeti sorszáma. Az automatikusan továbbított üzenetek esetében ez a tulajdonság azt a sorszámot tükrözi, amelyet először hozzárendeltek az üzenethez az eredeti küldési ponton.
enqueuedTimeUtc	Az AZ UTC pillanat, amikor az üzenetet elfogadták és a Service Busban tárolták.
expiresAtUtc	Az a UTC-időpont, amelyen az üzenet eltávolításra van megjelölve, és a lejárat miatt már nem érhető el az entitásból való lekéréshez. Ez a tulajdonság az üzenet 2 másik tulajdonságából lesz kiszámítva: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Az UTC-pillanat, amíg az üzenet zárolva nem lesz az üzenetsorban/előfizetésben. Amikor a zárolás lejár, a deliveryCount növekszik, és az üzenet ismét elérhető lesz a lekéréshez. Nem alkalmazható, ha az üzenet receiveAndDelete fogadási módban érkezik. üzemmód.
lockToken	A zárolási jogkivonat arra a zárolásra utal, amelyet a közvetítő peekLock fogadási módban tart. A zárolások belsőleg rendezik az üzeneteket a termékdokumentációjában leírtak szerint, részletesebben Nem alkalmazható, ha az üzenet receiveAndDelete fogadási módban érkezik. üzemmód.
sequenceNumber	A Service Bus által egy üzenethez rendelt egyedi szám. A sorszám egy egyedi, 64 bites egész szám, amely egy üzenethez van rendelve, mivel a közvetítő elfogadja és tárolja, és valódi azonosítóként működik. Particionált entitások esetén a legfelső 16 bit a partícióazonosítót tükrözi. A sorszámok monoton módon növekednek. A 48–64 bites tartomány kimerülése esetén 0-ra gördülnek. Javascript által jelenleg támogatott maximális biztonságos egész szám2^53 - 1. A sorozatszám egy AMQP Long típus, amely legfeljebb 64 bites lehet. Azt jelzi, hogy egy long.jsnevű kódtárat használunk. Elvárjuk, hogy az ügyfelek a tár által exportált Long típust használják.
state	Az üzenet állapota lehet aktív, késleltetett vagy ütemezett. A halasztott üzenetek halasztott állapotúak, az ütemezett üzenetek ütemezett állapotúak, minden más üzenet aktív állapotú.

Örökölt tulajdonságok

applicationProperties	Az egyéni üzenet metaadataihoz használható alkalmazásspecifikus tulajdonságok.
body	Az elküldendő vagy fogadott üzenet törzse. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbre vagy pufferre a jobb nyelvközi kompatibilitás érdekében.
contentType	Az üzenet tartalomtípusa. Opcionálisan az üzenet hasznos adatait írja le egy leíróval, amely a RFC2045 5. szakaszának formátumát követi, például "application/json".
correlationId	Az a korrelációs azonosító, amely lehetővé teszi az alkalmazás számára az üzenet kontextusának megadását korreláció céljából, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenet útválasztása és korrelációs.
messageId	Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és a hasznos adatokat. Megjegyzés: A nem egész egész számokat tartalmazó számok nem engedélyezettek.
partitionKey	A particionált entitásnak küldött üzenet partíciókulcsa. A maximális hossz 128 karakter. Az particionált entitásokbeállításával a kapcsolódó üzenetek ugyanahhoz a belső partícióhoz rendelhetők, így a rendszer helyesen rögzíti a küldési sorrendet. A partíciót egy kivonatfüggvény választja ki ezen az értéken keresztül, és nem választható ki közvetlenül. A munkamenet-tudatos entitások esetében a sessionId tulajdonság felülírja ezt az értéket. Nem particionált entitások esetén a partíciókulcs figyelmen kívül lesz hagyva
replyTo	Egy entitás címe, amelybe válaszokat szeretne küldeni. Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet fogadójának válaszútvonalának kifejezésére. Amikor a feladó választ vár, az értéket annak az üzenetsornak vagy témakörnek az abszolút vagy relatív elérési útjára állítja be, amelyre a válasz elküldése várható. Lásd: Üzenet útválasztása és korrelációs.
replyToSessionId	A replyTo címet bővítő munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-adatokat, és meghatározza, hogy a válasz entitásnak küldött válaszhoz melyik SessionId legyen beállítva. Lásd: Üzenet útválasztása és korrelációs.
scheduledEnqueueTimeUtc	Az a dátum és idő UTC-ben, amikor az üzenet le lesz iktatva. Ez a tulajdonság utc-ben adja vissza az időt; a tulajdonság beállításakor a megadott DateTime értéknek IS UTC-ben kell lennie. Ez az érték késleltetett üzenetküldésre használható. A későbbiekben egy adott időpontra küldött üzenetek késleltetésére használható. Az üzenet lekérdezési ideje nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer lekéri, de a tényleges küldési idő az üzenetsor számítási feladatától és állapotától függ.
sessionId	Egy munkamenet-tudatos entitás munkamenet-azonosítója. A maximális hossz 128 karakter. A munkamenet-tudatos entitások esetében ez az alkalmazás által definiált érték határozza meg az üzenet munkamenet-kapcsolatát. Az azonos munkamenet-azonosítóval rendelkező üzenetekre összefoglaló zárolás vonatkozik, és lehetővé teszik a pontos sorrendben történő feldolgozást és a demultiplexinget. A munkamenet-nem tudó entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket. üzenet-munkamenetek.
subject	Az alkalmazásspecifikus címke. Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított formátumban jelezze az üzenet célját a fogadónak. divat, hasonló egy e-mail tárgysor. A hozzárendelt AMQP tulajdonság "subject".
timeToLive	Az üzenet ideje az élő értékre. Ez az érték az a relatív időtartam, amely után az üzenet lejár, kezdve attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet, amint az enqueuedTimeUtcrögzítette. Ha nincs explicit módon beállítva, a feltételezett érték a megfelelő üzenetsor vagy témakör DefaultTimeToLive értéke. Az üzenetszintű timeToLive érték nem lehet hosszabb az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosul. Lásd: Lejárati.
to	A "címzett" cím. Ez a tulajdonság az útválasztási forgatókönyvekben való jövőbeli használatra van fenntartva, és jelenleg maga a közvetítő figyelmen kívül hagyja. Az alkalmazások ezt az értéket a szabályalapú automatikus továbbítási láncolás forgatókönyvekben használhatják az üzenet kívánt logikai célhelyének jelzésére.

Tulajdonság adatai

deadLetterErrorDescription

Az üzenet holtpontra helyezésének hibaleírása.

deadLetterErrorDescription?: string

Tulajdonság értéke

string

deadLetterReason

Az üzenet holtpontra helyezésének oka.

deadLetterReason?: string

Tulajdonság értéke

string

deadLetterSource

Annak az üzenetsornak vagy előfizetésnek a neve, amelyen az üzenet le lett foglalva, mielőtt az üzenet elhalt lett volna. Csak olyan üzenetekben van beállítva, amelyek elhalt betűsek voltak, majd automatikusan továbbítva lettek a kézbesítetlen levelek alsorából egy másik entitásba. Azt az entitást jelzi, amelyben az üzenet elhalt betűs volt.

deadLetterSource?: string

Tulajdonság értéke

string

deliveryCount

Az üzenethez megkísérelt kézbesítések száma. A szám növekszik, ha egy üzenetzár lejár, vagy az üzenet explicit módon felhagy az üzenet abandon() metódusával.

deliveryCount?: number

Tulajdonság értéke

number

enqueuedSequenceNumber

Az üzenet eredeti sorszáma. Az automatikusan továbbított üzenetek esetében ez a tulajdonság azt a sorszámot tükrözi, amelyet először hozzárendeltek az üzenethez az eredeti küldési ponton.

enqueuedSequenceNumber?: number

Tulajdonság értéke

number

enqueuedTimeUtc

Az AZ UTC pillanat, amikor az üzenetet elfogadták és a Service Busban tárolták.

enqueuedTimeUtc?: Date

Tulajdonság értéke

Date

expiresAtUtc

Az a UTC-időpont, amelyen az üzenet eltávolításra van megjelölve, és a lejárat miatt már nem érhető el az entitásból való lekéréshez. Ez a tulajdonság az üzenet 2 másik tulajdonságából lesz kiszámítva: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Tulajdonság értéke

Date

lockedUntilUtc

Az UTC-pillanat, amíg az üzenet zárolva nem lesz az üzenetsorban/előfizetésben. Amikor a zárolás lejár, a deliveryCount növekszik, és az üzenet ismét elérhető lesz a lekéréshez.

• Nem alkalmazható, ha az üzenet receiveAndDelete fogadási módban érkezik. üzemmód.

lockedUntilUtc?: Date

Tulajdonság értéke

Date

lockToken

A zárolási jogkivonat arra a zárolásra utal, amelyet a közvetítő peekLock fogadási módban tart. A zárolások belsőleg rendezik az üzeneteket a termékdokumentációjában leírtak szerint, részletesebben

• Nem alkalmazható, ha az üzenet receiveAndDelete fogadási módban érkezik. üzemmód.

lockToken?: string

Tulajdonság értéke

string

sequenceNumber

A Service Bus által egy üzenethez rendelt egyedi szám. A sorszám egy egyedi, 64 bites egész szám, amely egy üzenethez van rendelve, mivel a közvetítő elfogadja és tárolja, és valódi azonosítóként működik. Particionált entitások esetén a legfelső 16 bit a partícióazonosítót tükrözi. A sorszámok monoton módon növekednek. A 48–64 bites tartomány kimerülése esetén 0-ra gördülnek.

Javascript által jelenleg támogatott maximális biztonságos egész szám2^53 - 1. A sorozatszám egy AMQP Long típus, amely legfeljebb 64 bites lehet. Azt jelzi, hogy egy long.jsnevű kódtárat használunk. Elvárjuk, hogy az ügyfelek a tár által exportált Long típust használják.

sequenceNumber?: Long

Tulajdonság értéke

Long

state

Az üzenet állapota lehet aktív, késleltetett vagy ütemezett. A halasztott üzenetek halasztott állapotúak, az ütemezett üzenetek ütemezett állapotúak, minden más üzenet aktív állapotú.

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

Tulajdonság értéke

"active" | "deferred" | "scheduled"

Örökölt tulajdonság részletei

applicationProperties

Az egyéni üzenet metaadataihoz használható alkalmazásspecifikus tulajdonságok.

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

Tulajdonság értéke

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

ÖrököltServiceBusMessage.applicationProperties

body

Az elküldendő vagy fogadott üzenet törzse. Ha az üzenetet fogadó alkalmazás nem ezt az SDK-t használja, konvertálja a törzs hasznos adatait bájttömbre vagy pufferre a jobb nyelvközi kompatibilitás érdekében.

body: any

Tulajdonság értéke

any

ServiceBusMessage.bodyörökölt

contentType

Az üzenet tartalomtípusa. Opcionálisan az üzenet hasznos adatait írja le egy leíróval, amely a RFC2045 5. szakaszának formátumát követi, például "application/json".

contentType?: string

Tulajdonság értéke

string

ÖrököltServiceBusMessage.contentType

correlationId

Az a korrelációs azonosító, amely lehetővé teszi az alkalmazás számára az üzenet kontextusának megadását korreláció céljából, például egy megválaszolt üzenet MessageId azonosítóját tükrözi. Lásd: Üzenet útválasztása és korrelációs.

correlationId?: string | number | Buffer

Tulajdonság értéke

string | number | Buffer

ÖrököltServiceBusMessage.correlationId

messageId

Az üzenetazonosító egy alkalmazás által definiált érték, amely egyedileg azonosítja az üzenetet és a hasznos adatokat.

Megjegyzés: A nem egész egész számokat tartalmazó számok nem engedélyezettek.

messageId?: string | number | Buffer

Tulajdonság értéke

string | number | Buffer

ÖrököltServiceBusMessage.messageId

partitionKey

A particionált entitásnak küldött üzenet partíciókulcsa. A maximális hossz 128 karakter. Az particionált entitásokbeállításával a kapcsolódó üzenetek ugyanahhoz a belső partícióhoz rendelhetők, így a rendszer helyesen rögzíti a küldési sorrendet. A partíciót egy kivonatfüggvény választja ki ezen az értéken keresztül, és nem választható ki közvetlenül.

• A munkamenet-tudatos entitások esetében a sessionId tulajdonság felülírja ezt az értéket.
• Nem particionált entitások esetén a partíciókulcs figyelmen kívül lesz hagyva

partitionKey?: string

Tulajdonság értéke

string

ÖrököltServiceBusMessage.partitionKey

replyTo

Egy entitás címe, amelybe válaszokat szeretne küldeni. Ez az opcionális és alkalmazás által definiált érték szabványos módszer az üzenet fogadójának válaszútvonalának kifejezésére. Amikor a feladó választ vár, az értéket annak az üzenetsornak vagy témakörnek az abszolút vagy relatív elérési útjára állítja be, amelyre a válasz elküldése várható. Lásd: Üzenet útválasztása és korrelációs.

replyTo?: string

Tulajdonság értéke

string

ÖrököltServiceBusMessage.replyTo

replyToSessionId

A replyTo címet bővítő munkamenet-azonosító. A maximális hossz 128 karakter. Ez az érték kibővíti a Válaszadat-adatokat, és meghatározza, hogy a válasz entitásnak küldött válaszhoz melyik SessionId legyen beállítva. Lásd: Üzenet útválasztása és korrelációs.

replyToSessionId?: string

Tulajdonság értéke

string

ÖrököltServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Az a dátum és idő UTC-ben, amikor az üzenet le lesz iktatva. Ez a tulajdonság utc-ben adja vissza az időt; a tulajdonság beállításakor a megadott DateTime értéknek IS UTC-ben kell lennie. Ez az érték késleltetett üzenetküldésre használható. A későbbiekben egy adott időpontra küldött üzenetek késleltetésére használható. Az üzenet lekérdezési ideje nem jelenti azt, hogy az üzenet egyszerre lesz elküldve. A rendszer lekéri, de a tényleges küldési idő az üzenetsor számítási feladatától és állapotától függ.

scheduledEnqueueTimeUtc?: Date

Tulajdonság értéke

Date

ÖrököltServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Egy munkamenet-tudatos entitás munkamenet-azonosítója. A maximális hossz 128 karakter. A munkamenet-tudatos entitások esetében ez az alkalmazás által definiált érték határozza meg az üzenet munkamenet-kapcsolatát. Az azonos munkamenet-azonosítóval rendelkező üzenetekre összefoglaló zárolás vonatkozik, és lehetővé teszik a pontos sorrendben történő feldolgozást és a demultiplexinget. A munkamenet-nem tudó entitások esetében a rendszer figyelmen kívül hagyja ezt az értéket. üzenet-munkamenetek.

sessionId?: string

Tulajdonság értéke

string

ÖrököltServiceBusMessage.sessionId

subject

Az alkalmazásspecifikus címke. Ez a tulajdonság lehetővé teszi, hogy az alkalmazás szabványosított formátumban jelezze az üzenet célját a fogadónak. divat, hasonló egy e-mail tárgysor. A hozzárendelt AMQP tulajdonság "subject".

subject?: string

Tulajdonság értéke

string

ServiceBusMessage.subjectörökölt

timeToLive

Az üzenet ideje az élő értékre. Ez az érték az a relatív időtartam, amely után az üzenet lejár, kezdve attól a pillanattól kezdve, amikor a közvetítő elfogadta és tárolta az üzenetet, amint az enqueuedTimeUtcrögzítette. Ha nincs explicit módon beállítva, a feltételezett érték a megfelelő üzenetsor vagy témakör DefaultTimeToLive értéke. Az üzenetszintű timeToLive érték nem lehet hosszabb az entitás DefaultTimeToLive beállításánál, és ha igen, csendesen módosul. Lásd: Lejárati.

timeToLive?: number

Tulajdonság értéke

number

ÖrököltServiceBusMessage.timeToLive

to

A "címzett" cím. Ez a tulajdonság az útválasztási forgatókönyvekben való jövőbeli használatra van fenntartva, és jelenleg maga a közvetítő figyelmen kívül hagyja. Az alkalmazások ezt az értéket a szabályalapú automatikus továbbítási láncolás forgatókönyvekben használhatják az üzenet kívánt logikai célhelyének jelzésére.

to?: string

Tulajdonság értéke

string

örököltServiceBusMessage.to