ServiceBusReceivedMessage interface

Paket:

@azure/service-bus

Beskriver meddelandet som togs emot från Service Bus under granskningsåtgärder och kan därför inte lösas.

Extends

ServiceBusMessage

Egenskaper

deadLetterErrorDescription	Felbeskrivningen för deadlettering av meddelandet.
deadLetterReason	Anledningen till att ta död på meddelandet.
deadLetterSource	Namnet på den kö eller prenumeration som det här meddelandet var placerat i, innan det var deadlettered. Ange endast meddelanden som har varit obeställbara och därefter automatiskt vidarebefordrade från delkön med obeställbara meddelanden till en annan entitet. Anger entiteten där meddelandet var obeställbara.
deliveryCount	Antal leveranser som har försökts för det här meddelandet. Antalet ökas när ett meddelandelås upphör att gälla, eller så avbryts meddelandet uttryckligen med hjälp av abandon() metoden i meddelandet.
enqueuedSequenceNumber	Det ursprungliga sekvensnumret för meddelandet. För meddelanden som har vidarebefordrats automatiskt återspeglar den här egenskapen det sekvensnummer som först hade tilldelats meddelandet vid den ursprungliga sändningspunkten.
enqueuedTimeUtc	UTC-ögonblick då meddelandet har accepterats och lagrats i Service Bus.
expiresAtUtc	UTC-ögonblick då meddelandet markeras för borttagning och inte längre är tillgängligt för hämtning från entiteten på grund av förfallodatum. Den här egenskapen beräknas från 2 andra egenskaper i meddelandet: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	UTC-ögonblick tills meddelandet hålls låst i kön/prenumerationen. När låset upphör att gälla ökas deliveryCount det och meddelandet är återigen tillgängligt för hämtning. Inte tillämpligt när meddelandet tas emot i receiveAndDelete mottagningsläge. Läge.
lockToken	Låstoken är en referens till låset som hålls av den asynkrona meddelandekön i peekLock mottagningsläge. Lås används internt för att reglera meddelanden enligt beskrivningen i produktdokumentationen i detalj Inte tillämpligt när meddelandet tas emot i receiveAndDelete mottagningsläge. Läge.
sequenceNumber	Det unika nummer som tilldelats ett meddelande av Service Bus. Sekvensnumret är ett unikt 64-bitars heltal som tilldelas till ett meddelande eftersom det accepteras och lagras av den asynkrona meddelandekön och fungerar som dess sanna identifierare. För partitionerade entiteter återspeglar de översta 16 bitarna partitionsidentifieraren. Sekvensnummer ökar monotont. De rullar över till 0 när 48-64-bitarsintervallet är uttömt. Maximalt säkert heltal som Javascript stöder för närvarande är 2^53 - 1. Sekvensnumret är en AMQP-typ Long som kan vara upp till 64 bitar långt. För att representera att vi använder ett bibliotek med namnet long.js. Vi förväntar oss att kunderna använder den typ som Long exporteras av det här biblioteket.
state	Meddelandets tillstånd kan vara aktivt, uppskjutet eller schemalagt. Uppskjutna meddelanden har uppskjutet tillstånd, schemalagda meddelanden har schemalagt tillstånd, alla andra meddelanden har aktivt tillstånd.

Ärvda egenskaper

applicationProperties	De programspecifika egenskaper som kan användas för anpassade meddelandemetadata.
body	Meddelandetexten som måste skickas eller tas emot. Om programmet som tar emot meddelandet inte använder denna SDK konverterar du brödtextnyttolasten till en bytematris eller buffert för bättre kompatibilitet mellan språk.
contentType	Meddelandets innehållstyp. Du kan också beskriva nyttolasten för meddelandet, med en beskrivning som följer formatet RFC2045, avsnitt 5, till exempel "application/json".
correlationId	Korrelationsidentifieraren som gör att ett program kan ange en kontext för meddelandet i samband med korrelation, till exempel som återspeglar MessageId för ett meddelande som besvaras. Se Meddelanderoutning och korrelation.
messageId	Meddelandeidentifieraren är ett programdefinierat värde som unikt identifierar meddelandet och dess nyttolast. Obs! Tal som inte är heltal tillåts inte.
partitionKey	Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet. Maxlängden är 128 tecken. Om du anger det här värdet för partitionerade entiteter kan du tilldela relaterade meddelanden till samma interna partition, så att sekvensordningen för överföring registreras korrekt. Partitionen väljs av en hash-funktion framför det här värdet och kan inte väljas direkt. För sessionsmedvetna entiteter sessionId åsidosätter egenskapen det här värdet. För icke-partitionerade entiteter ignoreras partitionsnyckeln
replyTo	Adressen till en entitet som svar ska skickas till. Det här valfria och programdefinierade värdet är ett standardsätt för att uttrycka en svarssökväg till mottagaren av meddelandet. När en avsändare förväntar sig ett svar anges värdet till den absoluta eller relativa sökvägen för kön eller ämnet som svaret ska skickas till. Se Meddelanderoutning och korrelation.
replyToSessionId	Sessionsidentifieraren som utökar replyTo adressen. Maxlängden är 128 tecken. Det här värdet utökar ReplyTo-informationen och anger vilket SessionId som ska anges för svaret när det skickas till svarsentiteten. Se Meddelanderoutning och korrelation.
scheduledEnqueueTimeUtc	Datum och tid i UTC som meddelandet ska placeras i kö. Den här egenskapen returnerar tiden i UTC; när du anger egenskapen måste det angivna DateTime-värdet också vara i UTC. Det här värdet är för fördröjd meddelandesändning. Den används för att fördröja meddelanden som skickas till en viss tid i framtiden. Tiden för att ställa in meddelanden innebär inte att meddelandet skickas samtidigt. Den placeras i kö, men den faktiska sändningstiden beror på köns arbetsbelastning och dess tillstånd.
sessionId	Sessionsidentifieraren för en sessionsmedveten entitet. Maxlängden är 128 tecken. För sessionsmedvetna entiteter anger det här programdefinierade värdet sessionstillhörigheten för meddelandet. Meddelanden med samma sessionsidentifierare omfattas av sammanfattningslåsning och möjliggör exakt bearbetning i ordning och demultiplexing. För entiteter som inte känner till sessioner ignoreras det här värdet. Meddelandesessioner.
subject	Den programspecifika etiketten. Den här egenskapen gör att programmet kan ange syftet med meddelandet till mottagaren i en standardiserad. på ett sätt som liknar ämnesraden för e-post. Den mappade AMQP-egenskapen är "ämne".
timeToLive	Meddelandets time to live-värde. Det här värdet är den relativa varaktigheten efter vilken meddelandet upphör att gälla, med början från det ögonblick då meddelandet har accepterats och lagrats av den asynkrona meddelandekön enligt .enqueuedTimeUtc När det inte anges explicit är det antagna värdet DefaultTimeToLive för respektive kö eller ämne. Ett meddelandenivåvärde timeToLive får inte vara längre än entitetens DefaultTimeToLive-inställning och det justeras tyst om det gör det. Se Förfallodatum.
to	"till"-adressen. Den här egenskapen är reserverad för framtida användning i routningsscenarier och ignoreras för närvarande av själva koordinatorn. Program kan använda det här värdet i regeldrivna scenarier för automatisk vidarebefordran av länkning för att ange meddelandets avsedda logiska mål.

Egenskapsinformation

deadLetterErrorDescription

Felbeskrivningen för deadlettering av meddelandet.

deadLetterErrorDescription?: string

Egenskapsvärde

string

deadLetterReason

Anledningen till att ta död på meddelandet.

deadLetterReason?: string

Egenskapsvärde

string

deadLetterSource

Namnet på den kö eller prenumeration som det här meddelandet var placerat i, innan det var deadlettered. Ange endast meddelanden som har varit obeställbara och därefter automatiskt vidarebefordrade från delkön med obeställbara meddelanden till en annan entitet. Anger entiteten där meddelandet var obeställbara.

deadLetterSource?: string

Egenskapsvärde

string

deliveryCount

Antal leveranser som har försökts för det här meddelandet. Antalet ökas när ett meddelandelås upphör att gälla, eller så avbryts meddelandet uttryckligen med hjälp av abandon() metoden i meddelandet.

deliveryCount?: number

Egenskapsvärde

number

enqueuedSequenceNumber

Det ursprungliga sekvensnumret för meddelandet. För meddelanden som har vidarebefordrats automatiskt återspeglar den här egenskapen det sekvensnummer som först hade tilldelats meddelandet vid den ursprungliga sändningspunkten.

enqueuedSequenceNumber?: number

Egenskapsvärde

number

enqueuedTimeUtc

UTC-ögonblick då meddelandet har accepterats och lagrats i Service Bus.

enqueuedTimeUtc?: Date

Egenskapsvärde

Date

expiresAtUtc

UTC-ögonblick då meddelandet markeras för borttagning och inte längre är tillgängligt för hämtning från entiteten på grund av förfallodatum. Den här egenskapen beräknas från 2 andra egenskaper i meddelandet: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Egenskapsvärde

Date

lockedUntilUtc

UTC-ögonblick tills meddelandet hålls låst i kön/prenumerationen. När låset upphör att gälla ökas deliveryCount det och meddelandet är återigen tillgängligt för hämtning.

• Inte tillämpligt när meddelandet tas emot i receiveAndDelete mottagningsläge. Läge.

lockedUntilUtc?: Date

Egenskapsvärde

Date

lockToken

Låstoken är en referens till låset som hålls av den asynkrona meddelandekön i peekLock mottagningsläge. Lås används internt för att reglera meddelanden enligt beskrivningen i produktdokumentationen i detalj

• Inte tillämpligt när meddelandet tas emot i receiveAndDelete mottagningsläge. Läge.

lockToken?: string

Egenskapsvärde

string

sequenceNumber

Det unika nummer som tilldelats ett meddelande av Service Bus. Sekvensnumret är ett unikt 64-bitars heltal som tilldelas till ett meddelande eftersom det accepteras och lagras av den asynkrona meddelandekön och fungerar som dess sanna identifierare. För partitionerade entiteter återspeglar de översta 16 bitarna partitionsidentifieraren. Sekvensnummer ökar monotont. De rullar över till 0 när 48-64-bitarsintervallet är uttömt.

Maximalt säkert heltal som Javascript stöder för närvarande är 2^53 - 1. Sekvensnumret är en AMQP-typ Long som kan vara upp till 64 bitar långt. För att representera att vi använder ett bibliotek med namnet long.js. Vi förväntar oss att kunderna använder den typ som Long exporteras av det här biblioteket.

sequenceNumber?: Long

Egenskapsvärde

Long

state

Meddelandets tillstånd kan vara aktivt, uppskjutet eller schemalagt. Uppskjutna meddelanden har uppskjutet tillstånd, schemalagda meddelanden har schemalagt tillstånd, alla andra meddelanden har aktivt tillstånd.

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

Egenskapsvärde

"active" | "deferred" | "scheduled"

Information om ärvda egenskaper

applicationProperties

De programspecifika egenskaper som kan användas för anpassade meddelandemetadata.

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

Egenskapsvärde

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

Ärvd frånServiceBusMessage.applicationProperties

body

Meddelandetexten som måste skickas eller tas emot. Om programmet som tar emot meddelandet inte använder denna SDK konverterar du brödtextnyttolasten till en bytematris eller buffert för bättre kompatibilitet mellan språk.

body: any

Egenskapsvärde

any

Ärvd frånServiceBusMessage.body

contentType

Meddelandets innehållstyp. Du kan också beskriva nyttolasten för meddelandet, med en beskrivning som följer formatet RFC2045, avsnitt 5, till exempel "application/json".

contentType?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.contentType

correlationId

Korrelationsidentifieraren som gör att ett program kan ange en kontext för meddelandet i samband med korrelation, till exempel som återspeglar MessageId för ett meddelande som besvaras. Se Meddelanderoutning och korrelation.

correlationId?: string | number | Buffer

Egenskapsvärde

string | number | Buffer

Ärvd frånServiceBusMessage.correlationId

messageId

Meddelandeidentifieraren är ett programdefinierat värde som unikt identifierar meddelandet och dess nyttolast.

Obs! Tal som inte är heltal tillåts inte.

messageId?: string | number | Buffer

Egenskapsvärde

string | number | Buffer

Ärvd frånServiceBusMessage.messageId

partitionKey

Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet. Maxlängden är 128 tecken. Om du anger det här värdet för partitionerade entiteter kan du tilldela relaterade meddelanden till samma interna partition, så att sekvensordningen för överföring registreras korrekt. Partitionen väljs av en hash-funktion framför det här värdet och kan inte väljas direkt.

• För sessionsmedvetna entiteter sessionId åsidosätter egenskapen det här värdet.
• För icke-partitionerade entiteter ignoreras partitionsnyckeln

partitionKey?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.partitionKey

replyTo

Adressen till en entitet som svar ska skickas till. Det här valfria och programdefinierade värdet är ett standardsätt för att uttrycka en svarssökväg till mottagaren av meddelandet. När en avsändare förväntar sig ett svar anges värdet till den absoluta eller relativa sökvägen för kön eller ämnet som svaret ska skickas till. Se Meddelanderoutning och korrelation.

replyTo?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.replyTo

replyToSessionId

Sessionsidentifieraren som utökar replyTo adressen. Maxlängden är 128 tecken. Det här värdet utökar ReplyTo-informationen och anger vilket SessionId som ska anges för svaret när det skickas till svarsentiteten. Se Meddelanderoutning och korrelation.

replyToSessionId?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Datum och tid i UTC som meddelandet ska placeras i kö. Den här egenskapen returnerar tiden i UTC; när du anger egenskapen måste det angivna DateTime-värdet också vara i UTC. Det här värdet är för fördröjd meddelandesändning. Den används för att fördröja meddelanden som skickas till en viss tid i framtiden. Tiden för att ställa in meddelanden innebär inte att meddelandet skickas samtidigt. Den placeras i kö, men den faktiska sändningstiden beror på köns arbetsbelastning och dess tillstånd.

scheduledEnqueueTimeUtc?: Date

Egenskapsvärde

Date

Ärvd frånServiceBusMessage.scheduledEnqueueTimeUtc

sessionId

Sessionsidentifieraren för en sessionsmedveten entitet. Maxlängden är 128 tecken. För sessionsmedvetna entiteter anger det här programdefinierade värdet sessionstillhörigheten för meddelandet. Meddelanden med samma sessionsidentifierare omfattas av sammanfattningslåsning och möjliggör exakt bearbetning i ordning och demultiplexing. För entiteter som inte känner till sessioner ignoreras det här värdet. Meddelandesessioner.

sessionId?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.sessionId

subject

Den programspecifika etiketten. Den här egenskapen gör att programmet kan ange syftet med meddelandet till mottagaren i en standardiserad. på ett sätt som liknar ämnesraden för e-post. Den mappade AMQP-egenskapen är "ämne".

subject?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.subject

timeToLive

Meddelandets time to live-värde. Det här värdet är den relativa varaktigheten efter vilken meddelandet upphör att gälla, med början från det ögonblick då meddelandet har accepterats och lagrats av den asynkrona meddelandekön enligt .enqueuedTimeUtc När det inte anges explicit är det antagna värdet DefaultTimeToLive för respektive kö eller ämne. Ett meddelandenivåvärde timeToLive får inte vara längre än entitetens DefaultTimeToLive-inställning och det justeras tyst om det gör det. Se Förfallodatum.

timeToLive?: number

Egenskapsvärde

number

Ärvd frånServiceBusMessage.timeToLive

to

"till"-adressen. Den här egenskapen är reserverad för framtida användning i routningsscenarier och ignoreras för närvarande av själva koordinatorn. Program kan använda det här värdet i regeldrivna scenarier för automatisk vidarebefordran av länkning för att ange meddelandets avsedda logiska mål.

to?: string

Egenskapsvärde

string

Ärvd frånServiceBusMessage.to