Skip to content

Commit 98f68ee

Browse files
authored
Update event schema with field requirement info
The documentation states that five fields are required, and never indicates which fields. Issue #31259 asks for clarification on this, and the answer is provided there but has not been added into the docs.
1 parent 9ac6cf1 commit 98f68ee

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

articles/event-grid/event-schema.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,16 @@ For example, the schema published for an Azure Blob storage event is:
7979

8080
All events have the same following top-level data:
8181

82-
| Property | Type | Description |
83-
| -------- | ---- | ----------- |
84-
| topic | string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
85-
| subject | string | Publisher-defined path to the event subject. |
86-
| eventType | string | One of the registered event types for this event source. |
87-
| eventTime | string | The time the event is generated based on the provider's UTC time. |
88-
| id | string | Unique identifier for the event. |
89-
| data | object | Event data specific to the resource provider. |
90-
| dataVersion | string | The schema version of the data object. The publisher defines the schema version. |
91-
| metadataVersion | string | The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. |
82+
| Property | Type | Required | Description |
83+
| -------- | ---- | -------- | ----------- |
84+
| topic | string | No, but if included must match the Event Grid Topic ARM Id exactly. If not included, Event Grid will stamp onto the event. | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
85+
| subject | string | Yes | Publisher-defined path to the event subject. |
86+
| eventType | string | Yes | One of the registered event types for this event source. |
87+
| eventTime | string | Yes | The time the event is generated based on the provider's UTC time. |
88+
| id | string | Yes | Unique identifier for the event. |
89+
| data | object | No | Event data specific to the resource provider. |
90+
| dataVersion | string | No, but will be stamped with an empty value. | The schema version of the data object. The publisher defines the schema version. |
91+
| metadataVersion | string | Not required, but if included, must match the Event Grid Schema `metadataVersion` exactly (currently only `1`). If not included, Event Grid will stamp onto the event. | The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. |
9292

9393
To learn about the properties in the data object, see the event source:
9494

0 commit comments

Comments
 (0)