ServiceBusReceivedMessage interface

Felbeskrivningen för deadlettering av meddelandet.

deadLetterErrorDescription?: string

Egenskapsvärde

Anledningen till att ta död på meddelandet.

deadLetterReason?: string

Egenskapsvärde

Namnet på kön eller prenumerationen som det här meddelandet angavs för, innan det var deadlettered. Ange endast meddelanden som har obeställts och därefter automatiskt vidarebefordrats från delkön med obeställbara bokstäver till en annan entitet. Anger entiteten där meddelandet var obeställt.

deadLetterSource?: string

Egenskapsvärde

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 metoden abandon() i meddelandet.

deliveryCount?: number

Egenskapsvärde

Meddelandets ursprungliga sekvensnummer. 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

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

enqueuedTimeUtc?: Date

Egenskapsvärde

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 två andra egenskaper i meddelandet: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Egenskapsvärde

UTC-ögonblick tills meddelandet hålls låst i kön/prenumerationen. När låset upphör att gälla ökas deliveryCount 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

Låstoken är en referens till låset som hålls av mäklaren i peekLock mottagningsläge. Lås används internt för att reglera meddelanden enligt beskrivningen i produktdokumentation mer detaljerat

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

lockToken?: string

Egenskapsvärde

Det unika nummer som tilldelats ett meddelande av Service Bus. Sekvensnumret är ett unikt 64-bitars heltal som tilldelats ett meddelande eftersom det accepteras och lagras av asynkron meddelandekö 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-Long typ som kan vara upp till 64 bitar lång. För att representera att vi använder ett bibliotek med namnet long.js. Vi förväntar oss att kunderna använder den Long typ som exporteras av det här biblioteket.

sequenceNumber?: Long

Egenskapsvärde

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

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

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

Egenskapsvärde

ärvs frånServiceBusMessage.applicationProperties

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

body: any

Egenskapsvärde

ärvd frånServiceBusMessage.body

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

contentType?: string

Egenskapsvärde

ärvd frånServiceBusMessage.contentType

Korrelationsidentifieraren som gör det möjligt för ett program att 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

ärvd frånServiceBusMessage.correlationId

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

ärvs frånServiceBusMessage.messageId

Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet. Maximal längd är 128 tecken. För partitionerade entiteterkan du tilldela relaterade meddelanden till samma interna partition genom att ange det här värdet 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 åsidosätter egenskapen sessionId det här värdet.
• För icke-partitionerade entiteter ignoreras partitionsnyckeln

partitionKey?: string

Egenskapsvärde

ärvd frånServiceBusMessage.partitionKey

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 den förväntar sig att svaret ska skickas till. Se meddelanderoutning och korrelation.

replyTo?: string

Egenskapsvärde

ärvd frånServiceBusMessage.replyTo

Sessionsidentifieraren som utökar replyTo-adressen. Maximal längd är 128 tecken. Det här värdet ö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

ärvd frånServiceBusMessage.replyToSessionId

Datum och tid i UTC där meddelandet ska anges. 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. Meddelandekqueuing-tid innebär inte att meddelandet skickas samtidigt. Den kommer att skickas, men den faktiska sändningstiden beror på köns arbetsbelastning och dess tillstånd.

scheduledEnqueueTimeUtc?: Date

Egenskapsvärde

ärvd frånServiceBusMessage.scheduledEnqueueTimeUtc

Sessionsidentifieraren för en sessionsmedveten entitet. Maximal längd ä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

Ärvd frånServiceBusMessage.sessionId

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

subject?: string

Egenskapsvärde

ärvs frånServiceBusMessage.subject

Meddelandets tid till live-värde. Det här värdet är den relativa varaktigheten efter vilken meddelandet upphör att gälla, från och med det ögonblick då meddelandet har accepterats och lagrats av asynkron meddelandekö, enligt enqueuedTimeUtc. När det inte anges explicit är det antagna värdet DefaultTimeToLive för respektive kö eller ämne. Ett timeToLive värde på meddelandenivå 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

ärvd frånServiceBusMessage.timeToLive

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

to?: string

Egenskapsvärde

ärvd frånServiceBusMessage.to