EventGridEvent interface

Package:

@azure/functions

Link to docs and examples

Extends

EventGridPartialEvent

Properties

dataVersion	The schema version of the data object. The publisher defines the schema version.
metadataVersion	The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.
topic	Full resource path to the event source. This field isn't writeable. Event Grid provides this value

Inherited Properties

data	Event data specific to the resource provider
eventTime	The time the event is generated based on the provider's UTC time
eventType	One of the registered event types for this event source
id	Unique identifier for the event
subject	Publisher-defined path to the event subject

Property Details

dataVersion

The schema version of the data object. The publisher defines the schema version.

dataVersion: string

Property Value

string

metadataVersion

The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value.

metadataVersion: string

Property Value

string

topic

Full resource path to the event source. This field isn't writeable. Event Grid provides this value

topic: string

Property Value

string

Inherited Property Details

data

Event data specific to the resource provider

data?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited From EventGridPartialEvent.data

eventTime

The time the event is generated based on the provider's UTC time

eventTime: string

Property Value

string

Inherited From EventGridPartialEvent.eventTime

eventType

One of the registered event types for this event source

eventType: string

Property Value

string

Inherited From EventGridPartialEvent.eventType

id

Unique identifier for the event

id: string

Property Value

string

Inherited From EventGridPartialEvent.id

subject

Publisher-defined path to the event subject

subject: string

Property Value

string

Inherited From EventGridPartialEvent.subject