ServiceBusMessage interface

Paket:

@azure/service-bus

Beskriver meddelandet som ska skickas till Service Bus.

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. För | partitionerade entiteter kan du genom att ange det här värdet tilldela relaterade meddelanden till samma interna partition, så att överföringssekvensordningen 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

applicationProperties

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

applicationProperties?: [key: string]: function

Egenskapsvärde

[key: string]: function

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

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

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

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

partitionKey

Partitionsnyckeln för att skicka ett meddelande till en partitionerad entitet. Maxlängden är 128 tecken. För | partitionerade entiteter kan du genom att ange det här värdet tilldela relaterade meddelanden till samma interna partition, så att överföringssekvensordningen 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

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

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

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

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

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

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

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