EventGridPartialEvent interface

Package:

@azure/functions

Link to docs and examples This "partial" interface is meant to be used when creating an event yourself and allows some properties to be left out

Properties

data	Event data specific to the resource provider
dataVersion	The schema version of the data object. The publisher defines the schema version. If not included, will be stamped with an empty value
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
metadataVersion	The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. If included, must match the Event Grid Schema metadataVersion exactly (currently, only 1). If not included, Event Grid will stamp onto the event.
subject	Publisher-defined path to the event subject
topic	Full resource path to the event source. This field isn't writeable. Event Grid provides this value If included, must match the Event Grid topic Azure Resource Manager ID exactly. If not included, Event Grid will stamp onto the event.

Property Details

data

Event data specific to the resource provider

data?: Record<string, unknown>

Property Value

Record<string, unknown>

dataVersion

The schema version of the data object. The publisher defines the schema version. If not included, will be stamped with an empty value

dataVersion?: string

Property Value

string

eventTime

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

eventTime: string

Property Value

string

eventType

One of the registered event types for this event source

eventType: string

Property Value

string

id

Unique identifier for the event

id: 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. If included, must match the Event Grid Schema metadataVersion exactly (currently, only 1). If not included, Event Grid will stamp onto the event.

metadataVersion?: string

Property Value

string

subject

Publisher-defined path to the event subject

subject: string

Property Value

string

topic

Full resource path to the event source. This field isn't writeable. Event Grid provides this value If included, must match the Event Grid topic Azure Resource Manager ID exactly. If not included, Event Grid will stamp onto the event.

topic?: string

Property Value

string