你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ReceivedEventData interface

包:

@azure/event-hubs

描述从事件中心接收的事件的结构的接口。 使用 processEvents 函数时使用此函数来处理使用 EventHubConsumerClient时从事件中心接收的事件。

属性

body	需要发送或接收的消息正文。
contentType	消息的内容类型。 （可选）描述消息的有效负载，其描述符遵循RFC2045（第 5 节）的格式，例如“application/json”。
correlationId	允许应用程序为相关目的指定消息的上下文的相关标识符，例如反映正在答复的消息的 MessageId。
enqueuedTimeUtc	事件的排队时间。
messageId	消息标识符是一个应用程序定义的值，用于唯一标识消息及其有效负载。
offset	事件的偏移量。
partitionKey	指定的事件中心将对此进行哈希处理到 partitionId。 它保证消息最终出现在事件中心的特定分区中。
properties	应用程序特定的属性。
sequenceNumber	事件的序列号。
systemProperties	服务设置的属性。

方法

getRawAmqpMessage()

返回基础原始 amqp 消息。

属性详细信息

body

需要发送或接收的消息正文。

body: any

属性值

any

contentType

消息的内容类型。 （可选）描述消息的有效负载，其描述符遵循RFC2045（第 5 节）的格式，例如“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