ServiceBusMessage interface

Paket:

@azure/service-bus

Beschreibt die Nachricht, die an Service Bus gesendet werden soll.

Eigenschaften

applicationProperties	Die anwendungsspezifischen Eigenschaften, die für benutzerdefinierte Nachrichtenmetadaten verwendet werden können.
body	Der Nachrichtentext, der gesendet oder empfangen werden muss. Wenn die Anwendung, die die Nachricht empfängt, dieses SDK nicht verwendet, konvertieren Sie Ihre Textnutzlast in ein Bytearray oder einen Puffer, um die sprachübergreifende Kompatibilität zu verbessern.
contentType	Der Inhaltstyp der Nachricht. Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format RFC2045, Abschnitt 5 folgt, z. B. "application/json".
correlationId	Der Korrelationsbezeichner, mit dem eine Anwendung einen Kontext für die Nachricht zum Zweck der Korrelation angeben kann, z. B. die MessageId einer Nachricht, auf die geantwortet wird. Siehe Nachrichtenrouting und Korrelation.
messageId	Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert. Hinweis: Zahlen, die keine ganzen ganzen Zahlen sind, sind nicht zulässig.
partitionKey	Der Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität. Die maximale Länge beträgt 128 Zeichen. Für partitionierte Entitäten ermöglicht das Festlegen dieses Werts, verwandte Nachrichten derselben internen Partition zuzuweisen, sodass die Reihenfolge der Übermittlung ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion über 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.
replyTo	Die Adresse einer Entität, an die Antworten gesendet werden sollen. Dieser optionale und von der Anwendung definierte Wert ist eine Standardmethode, einen Antwortpfad zum 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 bzw. das die Antwort gesendet werden soll. Siehe Nachrichtenrouting und Korrelation.
replyToSessionId	Der Sitzungsbezeichner, der die replyTo Adresse erweitert. Die maximale Länge beträgt 128 Zeichen. Dieser Wert ergänzt die ReplyTo-Informationen und gibt an, welche SessionId für die Antwort festgelegt werden soll, wenn sie an die Antwortentität gesendet wird. Siehe Nachrichtenrouting und Korrelation.
scheduledEnqueueTimeUtc	Das Datum und die Uhrzeit in UTC, zu dem die Nachricht in die Warteschlange eingereiht wird. Diese Eigenschaft gibt die Uhrzeit in UTC zurück. beim Festlegen der Eigenschaft muss auch der angegebene DateTime-Wert in UTC vorliegen. Dieser Wert gilt für verzögertes Senden von Nachrichten. Es wird verwendet, um das Senden von Nachrichten an einen bestimmten Zeitpunkt in der Zukunft zu verzögern. Das Inqueuieren der Nachrichtenzeit bedeutet nicht, dass die Nachricht gleichzeitig gesendet wird. Es wird in die Warteschlange gestellt, aber die tatsächliche Sendezeit hängt von der Workload der Warteschlange und ihrem Zustand ab.
sessionId	Der Sitzungsbezeichner für eine sitzungsfähige Entität. Die maximale Länge beträgt 128 Zeichen. Bei sitzungsabhängigen Entitäten gibt dieser von der Anwendung definierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen einer zusammenfassenden Sperre und ermöglichen eine Verarbeitung in exakter Reihenfolge und Demultiplexing. Bei nicht sitzungsabhängigen Entitäten wird dieser Wert ignoriert. Nachrichtensitzungen.
subject	Die anwendungsspezifische Bezeichnung. Mit dieser Eigenschaft kann die Anwendung den Zweck der Nachricht an den Empfänger in einem standardisierten angeben. mode, ähnlich einer E-Mail-Betreffzeile. Die zugeordnete AMQP-Eigenschaft ist "subject".
timeToLive	Der TTL-Wert der Nachricht. Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, ab dem Moment, an dem die Nachricht vom Broker akzeptiert und gespeichert wurde, wie in enqueuedTimeUtcerfasst. Falls nicht explizit festgelegt, ist der angenommene Wert der DefaultTimeToLive-Wert für die jeweilige Warteschlange oder das jeweilige Thema. Ein Wert auf Nachrichtenebene timeToLive darf nicht länger als die DefaultTimeToLive-Einstellung der Entität sein, und er wird automatisch angepasst, wenn dies der Fall ist. Weitere Informationen finden Sie unter Ablauf.
to	Die "to"-Adresse. Diese Eigenschaft ist für die künftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelgesteuerten Szenarien zur automatischen Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

Details zur Eigenschaft

applicationProperties

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

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

Eigenschaftswert

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

body

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

body: any

Eigenschaftswert

any

contentType

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

contentType?: string

Eigenschaftswert

string

correlationId

Der Korrelationsbezeichner, mit dem eine Anwendung einen Kontext für die Nachricht zum Zweck der Korrelation angeben kann, z. B. die MessageId einer Nachricht, auf die geantwortet wird. Siehe Nachrichtenrouting und Korrelation.

correlationId?: string | number | Buffer

Eigenschaftswert

string | number | Buffer

messageId

Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert.

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

messageId?: string | number | Buffer

Eigenschaftswert

string | number | Buffer

partitionKey

Der Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität. Die maximale Länge beträgt 128 Zeichen. Für partitionierte Entitäten ermöglicht das Festlegen dieses Werts, verwandte Nachrichten derselben internen Partition zuzuweisen, sodass die Reihenfolge der Übermittlung ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion über 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

string

replyTo

Die Adresse einer Entität, an die Antworten gesendet werden sollen. Dieser optionale und von der Anwendung definierte Wert ist eine Standardmethode, einen Antwortpfad zum 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 bzw. das die Antwort gesendet werden soll. Siehe Nachrichtenrouting und Korrelation.

replyTo?: string

Eigenschaftswert

string

replyToSessionId

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

replyToSessionId?: string

Eigenschaftswert

string

scheduledEnqueueTimeUtc

Das Datum und die Uhrzeit in UTC, zu dem die Nachricht in die Warteschlange eingereiht wird. Diese Eigenschaft gibt die Uhrzeit in UTC zurück. beim Festlegen der Eigenschaft muss auch der angegebene DateTime-Wert in UTC vorliegen. Dieser Wert gilt für verzögertes Senden von Nachrichten. Es wird verwendet, um das Senden von Nachrichten an einen bestimmten Zeitpunkt in der Zukunft zu verzögern. Das Inqueuieren der Nachrichtenzeit bedeutet nicht, dass die Nachricht gleichzeitig gesendet wird. Es wird in die Warteschlange gestellt, aber die tatsächliche Sendezeit hängt von der Workload der Warteschlange und ihrem Zustand ab.

scheduledEnqueueTimeUtc?: Date

Eigenschaftswert

Date

sessionId

Der Sitzungsbezeichner für eine sitzungsfähige Entität. Die maximale Länge beträgt 128 Zeichen. Bei sitzungsabhängigen Entitäten gibt dieser von der Anwendung definierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen einer zusammenfassenden Sperre und ermöglichen eine Verarbeitung in exakter Reihenfolge und Demultiplexing. Bei nicht sitzungsabhängigen Entitäten wird dieser Wert ignoriert. Nachrichtensitzungen.

sessionId?: string

Eigenschaftswert

string

subject

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

subject?: string

Eigenschaftswert

string

timeToLive

Der TTL-Wert der Nachricht. Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, ab dem Moment, an dem die Nachricht vom Broker akzeptiert und gespeichert wurde, wie in enqueuedTimeUtcerfasst. Falls nicht explizit festgelegt, ist der angenommene Wert der DefaultTimeToLive-Wert für die jeweilige Warteschlange oder das jeweilige Thema. Ein Wert auf Nachrichtenebene timeToLive darf nicht länger als die DefaultTimeToLive-Einstellung der Entität sein, und er wird automatisch angepasst, wenn dies der Fall ist. Weitere Informationen finden Sie unter Ablauf.

timeToLive?: number

Eigenschaftswert

number

to

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

to?: string

Eigenschaftswert

string