ReceivedEventData interface

套件:

@azure/event-hubs

介面，描述從事件中樞接收的事件結構。 當建立 processEvents 函式時，請使用這個作為參考，以在使用 EventHubConsumerClient時處理從事件中樞接收的事件。

屬性

body	需要傳送或接收的訊息本文。
contentType	訊息的內容類型。 選擇性地描述訊息的承載，其描述項會遵循第 5 節RFC2045的格式，例如“application/json”。
correlationId	可讓應用程式針對相互關聯目的指定訊息內容的相互關聯標識符，例如反映正在回復之訊息的 MessageId。
enqueuedTimeUtc	事件加入佇列的時間。
messageId	訊息標識碼是應用程式定義的值，可唯一識別訊息及其承載。
offset	事件的位移。
partitionKey	當指定的事件中樞將哈希處理至 partitionId 時。 它保證訊息最終會出現在事件中樞的特定分割區中。
properties	應用程式特定屬性。
sequenceNumber	事件的序號。
systemProperties	服務所設定的屬性。

方法

getRawAmqpMessage()

傳回基礎原始amqp訊息。

屬性詳細資料

body

需要傳送或接收的訊息本文。

body: any

屬性值

any

contentType

訊息的內容類型。 選擇性地描述訊息的承載，其描述項會遵循第 5 節RFC2045的格式，例如“application/json”。

contentType?: string

屬性值

string

correlationId

可讓應用程式針對相互關聯目的指定訊息內容的相互關聯標識符，例如反映正在回復之訊息的 MessageId。

correlationId?: string | number | Buffer

屬性值

string | number | Buffer

enqueuedTimeUtc

事件加入佇列的時間。

enqueuedTimeUtc: Date

屬性值

Date

messageId

訊息標識碼是應用程式定義的值，可唯一識別訊息及其承載。

messageId?: string | number | Buffer

屬性值

string | number | Buffer

offset

事件的位移。

offset: number

屬性值

number

partitionKey

當指定的事件中樞將哈希處理至 partitionId 時。 它保證訊息最終會出現在事件中樞的特定分割區中。

partitionKey: null | string

屬性值

null | string

properties

應用程式特定屬性。

properties?: {[key: string]: any}

屬性值

{[key: string]: any}

sequenceNumber

事件的序號。

sequenceNumber: number

屬性值

number

systemProperties

服務所設定的屬性。

systemProperties?: {[key: string]: any}

屬性值

{[key: string]: any}

方法詳細資料

getRawAmqpMessage()

傳回基礎原始amqp訊息。

function getRawAmqpMessage(): AmqpAnnotatedMessage

傳回

AmqpAnnotatedMessage