ServiceBusReceivedMessage interface

Paket:

@azure/service-bus

Beschreibt die Nachricht, die von Service Bus während Einsehen von Vorgängen empfangen wurde und daher nicht abgerechnet werden kann.

Extends

ServiceBusMessage

Eigenschaften

deadLetterErrorDescription	Die Fehlerbeschreibung für das Unzustellbare Senden der Nachricht.
deadLetterReason	Der Grund für das Unzustellbare Senden der Nachricht.
deadLetterSource	Der Name der Warteschlange oder des Abonnements, für die diese Nachricht in die Warteschlange eingereiht wurde, bevor sie unzustellbare Nachrichten gesendet wurde. Nur in Nachrichten festgelegt, die unzustellbar und anschließend automatisch von der Unterwarteschlange für unzustellbare Nachrichten an eine andere Entität weitergeleitet wurden. Gibt die Entität an, in der die Nachricht unzustellbar war.
deliveryCount	Anzahl der Zustellversuche dieser Nachricht. Die Anzahl wird erhöht, wenn eine Nachrichtensperre abläuft oder die Nachricht mithilfe der abandon() -Methode für die Nachricht explizit abgebrochen wird.
enqueuedSequenceNumber	Die ursprüngliche Sequenznummer der Nachricht. Bei Nachrichten, die automatisch weitergeleitet wurden, entspricht diese Eigenschaft der Sequenznummer, die der Nachricht zum Zeitpunkt ihrer ursprünglichen Übermittlung zugewiesen wurde.
enqueuedTimeUtc	Der UTC-Zeitpunkt, zu dem die Nachricht akzeptiert und in Service Bus gespeichert wurde.
expiresAtUtc	Der UTC-Moment, in dem die Nachricht zum Entfernen markiert wird und wegen Ablaufs nicht mehr von der Entität abgerufen werden kann. Diese Eigenschaft wird aus zwei anderen Eigenschaften für die Meldung berechnet: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Der UTC-Moment, bis zu dem die Nachricht in der Warteschlange/im Abonnement gesperrt gehalten wird. Wenn die Sperre abläuft, wird erhöht deliveryCount , und die Nachricht ist wieder für den Abruf verfügbar. Gilt nicht, wenn die Nachricht im receiveAndDelete Empfangsmodus empfangen wird. verbleibt.
lockToken	Das Sperrtoken ist ein Verweis auf die Sperre, die vom Broker im peekLock Empfangsmodus gehalten wird. Sperren werden intern verwendet, um Nachrichten abzugleichen, wie in der Produktdokumentation ausführlicher erläutert. Gilt nicht, wenn die Nachricht im receiveAndDelete Empfangsmodus empfangen wird. verbleibt.
sequenceNumber	Die eindeutige Nummer, die einer Nachricht von Service Bus zugewiesen ist. Die Sequenznummer ist eine eindeutige ganze 64-Bit-Zahl, die einer Nachricht zugeordnet wird, sobald sie vom Broker akzeptiert und gespeichert wird, und fungiert als ihr tatsächlicher Bezeichner. Bei partitionierte Entitäten stellen die obersten 16 Bits den Partitionsbezeichner dar. Sequenzzahlen werden monoton erhöht. Sie werden auf 0 zurückgesetzt, sobald der 48-64-Bit-Bereich ausgeschöpft ist. Die maximale sichere ganze Zahl , die Javascript derzeit unterstützt, ist 2^53 - 1. Die Sequenznummer ist ein AMQP-Typ Long , der bis zu 64 Bit lang sein kann. Um darzustellen, dass wir eine Bibliothek mit dem Namen long.jsverwenden. Wir erwarten, dass Kunden den Long von dieser Bibliothek exportierten Typ verwenden.
state	Der Status der Nachricht kann aktiv, verzögert oder geplant sein. Verzögerte Nachrichten verfügen über einen verzögerten Zustand, geplante Nachrichten haben einen geplanten Zustand, und alle anderen Nachrichten haben den aktiven Zustand.

Geerbte 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 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, beginnend mit dem Zeitpunkt, an dem die Nachricht akzeptiert und vom Broker 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 mit automatischer Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

Details zur Eigenschaft

deadLetterErrorDescription

Die Fehlerbeschreibung für das Unzustellbare Senden der Nachricht.

deadLetterErrorDescription?: string

Eigenschaftswert

string

deadLetterReason

Der Grund für das Unzustellbare Senden der Nachricht.

deadLetterReason?: string

Eigenschaftswert

string

deadLetterSource

Der Name der Warteschlange oder des Abonnements, für die diese Nachricht in die Warteschlange eingereiht wurde, bevor sie unzustellbare Nachrichten gesendet wurde. Nur in Nachrichten festgelegt, die unzustellbar und anschließend automatisch von der Unterwarteschlange für unzustellbare Nachrichten an eine andere Entität weitergeleitet wurden. Gibt die Entität an, in der die Nachricht unzustellbar war.

deadLetterSource?: string

Eigenschaftswert

string

deliveryCount

Anzahl der Zustellversuche dieser Nachricht. Die Anzahl wird erhöht, wenn eine Nachrichtensperre abläuft oder die Nachricht mithilfe der abandon() -Methode für die Nachricht explizit abgebrochen wird.

deliveryCount?: number

Eigenschaftswert

number

enqueuedSequenceNumber

Die ursprüngliche Sequenznummer der Nachricht. Bei Nachrichten, die automatisch weitergeleitet wurden, entspricht diese Eigenschaft der Sequenznummer, die der Nachricht zum Zeitpunkt ihrer ursprünglichen Übermittlung zugewiesen wurde.

enqueuedSequenceNumber?: number

Eigenschaftswert

number

enqueuedTimeUtc

Der UTC-Zeitpunkt, zu dem die Nachricht akzeptiert und in Service Bus gespeichert wurde.

enqueuedTimeUtc?: Date

Eigenschaftswert

Date

expiresAtUtc

Der UTC-Moment, in dem die Nachricht zum Entfernen markiert wird und wegen Ablaufs nicht mehr von der Entität abgerufen werden kann. Diese Eigenschaft wird aus zwei anderen Eigenschaften für die Meldung berechnet: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Eigenschaftswert

Date

lockedUntilUtc

Der UTC-Moment, bis zu dem die Nachricht in der Warteschlange/im Abonnement gesperrt gehalten wird. Wenn die Sperre abläuft, wird erhöht deliveryCount , und die Nachricht ist wieder für den Abruf verfügbar.

• Gilt nicht, wenn die Nachricht im receiveAndDelete Empfangsmodus empfangen wird. verbleibt.

lockedUntilUtc?: Date

Eigenschaftswert

Date

lockToken

Das Sperrtoken ist ein Verweis auf die Sperre, die vom Broker im peekLock Empfangsmodus gehalten wird. Sperren werden intern verwendet, um Nachrichten abzugleichen, wie in der Produktdokumentation ausführlicher erläutert.

• Gilt nicht, wenn die Nachricht im receiveAndDelete Empfangsmodus empfangen wird. verbleibt.

lockToken?: string

Eigenschaftswert

string

sequenceNumber

Die eindeutige Nummer, die einer Nachricht von Service Bus zugewiesen ist. Die Sequenznummer ist eine eindeutige ganze 64-Bit-Zahl, die einer Nachricht zugeordnet wird, sobald sie vom Broker akzeptiert und gespeichert wird, und fungiert als ihr tatsächlicher Bezeichner. Bei partitionierte Entitäten stellen die obersten 16 Bits den Partitionsbezeichner dar. Sequenzzahlen werden monoton erhöht. Sie werden auf 0 zurückgesetzt, sobald der 48-64-Bit-Bereich ausgeschöpft ist.

Die maximale sichere ganze Zahl , die Javascript derzeit unterstützt, ist 2^53 - 1. Die Sequenznummer ist ein AMQP-Typ Long , der bis zu 64 Bit lang sein kann. Um darzustellen, dass wir eine Bibliothek mit dem Namen long.jsverwenden. Wir erwarten, dass Kunden den Long von dieser Bibliothek exportierten Typ verwenden.

sequenceNumber?: Long

Eigenschaftswert

Long

state

Der Status der Nachricht kann aktiv, verzögert oder geplant sein. Verzögerte Nachrichten verfügen über einen verzögerten Zustand, geplante Nachrichten haben einen geplanten Zustand, und alle anderen Nachrichten haben den aktiven Zustand.

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

Eigenschaftswert

"active" | "deferred" | "scheduled"

Geerbte Eigenschaftsdetails

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}

Geerbt vonServiceBusMessage.applicationProperties

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 Puffer, um die sprachübergreifende Kompatibilität zu verbessern.

body: any

Eigenschaftswert

any

Geerbt vonServiceBusMessage.body

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

Geerbt vonServiceBusMessage.contentType

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

Geerbt vonServiceBusMessage.correlationId

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

Geerbt vonServiceBusMessage.messageId

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

Geerbt vonServiceBusMessage.partitionKey

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

Geerbt vonServiceBusMessage.replyTo

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

Geerbt vonServiceBusMessage.replyToSessionId

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

Geerbt vonServiceBusMessage.scheduledEnqueueTimeUtc

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

Geerbt vonServiceBusMessage.sessionId

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

Geerbt vonServiceBusMessage.subject

timeToLive

Der TTL-Wert der Nachricht. Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, beginnend mit dem Zeitpunkt, an dem die Nachricht akzeptiert und vom Broker 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

Geerbt vonServiceBusMessage.timeToLive

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 mit automatischer Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

to?: string

Eigenschaftswert

string

Geerbt vonServiceBusMessage.to