ServiceBusMessage interface

Die anwendungsspezifischen Eigenschaften, die für benutzerdefinierte Nachrichtenmetadaten verwendet werden können.

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

Eigenschaftswert

Der Nachrichtentext, der gesendet oder empfangen werden muss. Wenn die Anwendung, die die Nachricht empfängt, dieses SDK nicht verwendet, konvertieren Sie Die Body-Nutzlast in ein Bytearray oder Puffer, um die sprachübergreifende Kompatibilität zu verbessern.

body: any

Eigenschaftswert

Der Inhaltstyp der Nachricht. Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor nach dem Format von RFC2045, Abschnitt 5, z. B. "application/json", folgt.

contentType?: string

Eigenschaftswert

Der Korrelationsbezeichner, der es einer Anwendung ermöglicht, einen Kontext für die Nachricht für die Zwecke der Korrelation anzugeben, z. B. die MessageId einer Nachricht, auf die geantwortet wird. Siehe Nachrichtenweiterleitung und Korrelation.

correlationId?: string | number | Buffer

Eigenschaftswert

Der Nachrichtenbezeichner ist ein anwendungsdefinierter Wert, der die Nachricht und deren Nutzlast eindeutig identifiziert.

Hinweis: Zahlen, die keine ganzen Zahlen sind, sind nicht zulässig.

messageId?: string | number | Buffer

Eigenschaftswert

Der Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität. Die maximale Länge beträgt 128 Zeichen. Bei partitionierten Entitätenermöglicht das Festlegen dieses Werts das Zuweisen verwandter Nachrichten derselben internen Partition, sodass die Reihenfolge der Übermittlungssequenz ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion für diesen Wert ausgewählt und kann nicht direkt ausgewählt werden.

• Bei sitzungsfähigen Entitäten überschreibt die sessionId-Eigenschaft diesen Wert.
• Bei nicht partitionierten Entitäten wird der Partitionsschlüssel ignoriert.

partitionKey?: string

Eigenschaftswert

Die Adresse einer Entität, an die Antworten gesendet werden sollen. Dieser optionale und anwendungsdefinierte Wert ist eine Standardmethode, um einen Antwortpfad für den Empfänger der Nachricht auszudrücken. Wenn ein Absender eine Antwort erwartet, legt er den Wert auf den absoluten oder relativen Pfad der Warteschlange oder des Themas fest, an den die Antwort gesendet werden soll. Siehe Nachrichtenweiterleitung und Korrelation.

replyTo?: string

Eigenschaftswert

Der Sitzungsbezeichner, der die replyTo Adresse erweitert. Die maximale Länge beträgt 128 Zeichen. Dieser Wert erweitert die ReplyTo-Informationen und gibt an, welche SessionId für die Antwort festgelegt werden soll, wenn sie an die Antwortentität gesendet wird. Siehe Nachrichtenweiterleitung und Korrelation.

replyToSessionId?: string

Eigenschaftswert

Das Datum und die Uhrzeit in UTC, zu dem die Nachricht abgefragt wird. Diese Eigenschaft gibt die Uhrzeit in UTC zurück; Beim Festlegen der Eigenschaft muss der angegebene DateTime-Wert auch in UTC sein. Dieser Wert dient zum Senden verzögerter Nachrichten. Es wird verwendet, um Nachrichten zu verzögern, die in Zukunft an eine bestimmte Zeit gesendet werden. Die Zeit für die Queuierung von Nachrichten bedeutet nicht, dass die Nachricht gleichzeitig gesendet wird. Es wird abgefragt, aber die tatsächliche Sendezeit hängt von der Arbeitsauslastung der Warteschlange und ihrem Zustand ab.

scheduledEnqueueTimeUtc?: Date

Eigenschaftswert

Der Sitzungsbezeichner für eine sitzungsfähige Entität. Die maximale Länge beträgt 128 Zeichen. Für sitzungsfähige Entitäten gibt dieser anwendungsdefinierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen der Zusammenfassungssperre und ermöglichen eine genaue Inreihenfolgenverarbeitung und -demultiplexing. Bei nicht erkannten Entitäten wird dieser Wert ignoriert. Nachrichtensitzungen.

sessionId?: string

Eigenschaftswert

Die anwendungsspezifische Bezeichnung. Mit dieser Eigenschaft kann die Anwendung den Zweck der Nachricht an den Empfänger in einer standardisierten Datei angeben. mode, ähnlich einer E-Mail-Betreffzeile. Die zugeordnete AMQP-Eigenschaft ist "subject".

subject?: string

Eigenschaftswert

Die Zeit für den Livewert der Nachricht. Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, beginnend mit der Sofortnachricht, die vom Broker akzeptiert und gespeichert wurde, wie in enqueuedTimeUtcerfasst. Wenn dieser Wert nicht explizit festgelegt wird, ist der angenommene Wert "DefaultTimeToLive" für die jeweilige Warteschlange oder das jeweilige Thema. Ein Wert auf Nachrichtenebene timeToLive darf nicht länger sein als die DefaultTimeToLive-Einstellung der Entität und wird automatisch angepasst, wenn dies der Fall ist. Siehe Ablauf.

timeToLive?: number

Eigenschaftswert

Die "an"-Adresse. Diese Eigenschaft ist für die zukünftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelgesteuerten automatischen Weiterleitungsverkettung Szenarien verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

to?: string

Eigenschaftswert