|
1 | 1 | ---
|
2 | 2 | title: Azure Event Grid event schema
|
3 |
| -description: Describes the properties and schema that are present for all events. Events consist of a set of four required string properties. |
| 3 | +description: Describes the properties and schema for the proprietary, non-extensible, yet fully-functional Event Grid format. |
4 | 4 | ms.topic: reference
|
5 |
| -ms.date: 09/15/2021 |
| 5 | +ms.date: 05/24/2023 |
6 | 6 | ---
|
7 | 7 |
|
8 | 8 | # Azure Event Grid event schema
|
9 | 9 |
|
10 |
| -This article describes the properties and schema that are present for all events. Events consist of a set of four required string properties. The properties are common to all events from any publisher. The data object has properties that are specific to each publisher. For system topics, these properties are specific to the resource provider, such as Azure Storage or Azure Event Hubs. |
| 10 | +This article describes the Event Grid schema, which is a proprietary, non-extensible, yet fully-functional event format. Event Grid still supports this event format and will continue to support it. However, [CloudEvents](cloud-event-schema.md) is the recommended event format to use. If you are using applications that use the Event Grid format, you may find useful the information in the [CloudEvents] section that describes the transformations between the Event Grid and CloudEvents format supported by Event Grid. |
| 11 | + |
| 12 | +This article describes in detail the properties and schema for the Event Grid format. Events consist of a set of four required string properties. The properties are common to all events from any publisher. The data object has properties that are specific to each publisher. For system topics, these properties are specific to the resource provider, such as Azure Storage or Azure Event Hubs. |
11 | 13 |
|
12 | 14 | Event sources send events to Azure Event Grid in an array, which can have several event objects. When posting events to an event grid topic, the array can have a total size of up to 1 MB. Each event in the array is limited to 1 MB. If an event or the array is greater than the size limits, you receive the response **413 Payload Too Large**. Operations are charged in 64 KB increments though. So, events over 64 KB will incur operations charges as though they were multiple events. For example, an event that is 130 KB would incur operations as though it were 3 separate events.
|
13 | 15 |
|
@@ -101,7 +103,16 @@ When publishing events to custom topics, create subjects for your events that ma
|
101 | 103 |
|
102 | 104 | Sometimes your subject needs more detail about what happened. For example, the **Storage Accounts** publisher provides the subject `/blobServices/default/containers/<container-name>/blobs/<file>` when a file is added to a container. A subscriber could filter by the path `/blobServices/default/containers/testcontainer` to get all events for that container but not other containers in the storage account. A subscriber could also filter or route by the suffix `.txt` to only work with text files.
|
103 | 105 |
|
| 106 | +## CloudEvents |
| 107 | +CloudEvents is the recommended event format to use. Azure Event Grid will continue investing in features related to at least [CloudEvents JSON](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md) format. Given the fact that some event sources like Azure services use the Event Grid format, the following table is provided to help help you understand the transformation supported when using CloudEvents and Event Grid formats as an input schema in topics and as an output schema in event subscriptions. Note that an Event Grid output schema cannot be used when using CloudEvents as an input schema because CloudEvents supports [extension attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) which are not supported by the Event Grid schema. |
| 108 | + |
| 109 | +| Input schema | Output schema |
| 110 | +|--------------------|--------------------- |
| 111 | +| CloudEvents format | CloudEvents format |
| 112 | +| Event Grid format | CloudEvents format |
| 113 | +| Event Grid format | Event Grid format |
| 114 | + |
104 | 115 | ## Next steps
|
105 | 116 |
|
106 | 117 | * For an introduction to Azure Event Grid, see [What is Event Grid?](overview.md)
|
107 |
| -* For more information about creating an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md). |
| 118 | +* For more information about creating an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md). |
0 commit comments