Skip to content

Commit 458d90b

Browse files
authored
Merge pull request #220279 from spelluru/egridschema1202
review and update schema articles - 2
2 parents dfdd900 + 984db01 commit 458d90b

15 files changed

+40
-44
lines changed

articles/azure-maps/azure-maps-event-grid-integration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Azure Event Grid is a fully managed event routing service, which uses a publish-
2424

2525
## Azure Maps events types
2626

27-
Event grid uses [event subscriptions](../event-grid/concepts.md#event-subscriptions) to route event messages to subscribers. An Azure Maps account emits the following event types:
27+
Event Grid uses [event subscriptions](../event-grid/concepts.md#event-subscriptions) to route event messages to subscribers. An Azure Maps account emits the following event types:
2828

2929
| Event type | Description |
3030
| ---------- | ----------- |
@@ -75,6 +75,7 @@ Applications that handle Azure Maps geofence events should follow a few recommen
7575
* When a GET or a POST request in the Geofence API is called with the mode parameter set to `EnterAndExit`, then an Enter or Exit event is generated for each geometry in the geofence for which the status has changed from the previous Geofence API call.
7676

7777
## Next steps
78+
For details about all the events supported by Azure Maps and the schema, see [Azure Maps as an Event Grid source](../event-grid/event-schema-azure-maps.md).
7879

7980
To learn more about how to use geofencing to control operations at a construction site, see:
8081

articles/event-grid/event-grid-event-hubs-integration.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ Azure [Event Grid](overview.md) is an intelligent event routing service that ena
1313
[!INCLUDE [event-grid-event-hubs-functions-synapse-analytics.md](./includes/event-grid-event-hubs-functions-synapse-analytics.md)]
1414

1515
## Next steps
16-
17-
* To learn about differences in the Azure messaging services, see [Choose between Azure services that deliver messages](compare-messaging-services.md).
18-
* For an introduction to Event Grid, see [About Event Grid](overview.md).
19-
* For an introduction to Event Hubs Capture, see [Enable Event Hubs Capture using the Azure portal](../event-hubs/event-hubs-capture-enable-through-portal.md).
2016
* For more information about setting up and running the sample, see [Event Hubs Capture and Event Grid sample](https://github.com/Azure/azure-event-hubs/tree/master/samples/e2e/EventHubsCaptureEventGridDemo).
17+
* In this tutorial, you created an event subscription for the `CaptureFileCreated` event. For more information about this event and all the events supported by Azure Blob Storage, see [Azure Event Hubs as an Event Grid source](event-schema-event-hubs.md).
18+
* To learn more about the Event Hubs Capture feature, see [Capture events through Azure Event Hubs in Azure Blob Storage or Azure Data Lake Storage](../event-hubs/event-hubs-capture-overview.md).
19+
* To learn about differences in the Azure messaging services, see [Choose between Azure services that deliver messages](compare-messaging-services.md).

articles/event-grid/event-schema-aks.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Azure Kubernetes Service as Event Grid source
33
description: This article describes how to use Azure Kubernetes Service as an Event Grid event source. It provides the schema and links to tutorial and how-to articles.
44
author: zr-msft
55
ms.topic: conceptual
6-
ms.date: 10/04/2021
6+
ms.date: 12/02/2022
77
ms.author: zarhoads
88
---
99

1010
# Azure Kubernetes Service (AKS) as an Event Grid source
1111

12-
This article provides the properties and schema for AKS events. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md). It also gives you a list of quick starts and tutorials to use AKS as an event source.
12+
This article provides the properties and schema for AKS events. It also gives you a list of quick starts and tutorials to use AKS as an event source. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md) and [Cloud event schema](cloud-event-schema.md).
1313

1414
## Available event types
1515

@@ -108,6 +108,4 @@ The data object contains the following properties:
108108
| `latestPreviewKubernetesVersion` | string | The latest preview version of Kubernetes available. |
109109

110110
## Next steps
111-
112-
* For an introduction to Azure Event Grid, see [What is Event Grid?](overview.md)
113-
* For more information about creating an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md)
111+
See the following tutorial: [Quickstart: Subscribe to Azure Kubernetes Service (AKS) events with Azure Event Grid](../aks/quickstart-event-grid.md).

articles/event-grid/event-schema-azure-health-data-services.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Health Data Services as Event Grid source
33
description: Describes the properties that are provided for Azure Health Data Services events with Azure Event Grid
44
ms.topic: conceptual
5-
ms.date: 02/03/2022
5+
ms.date: 12/02/2022
66
---
77

88
# Azure Health Data Services as an Event Grid source
@@ -156,8 +156,7 @@ This section contains examples of what events message data would look like for e
156156
---
157157

158158
## Next steps
159-
160-
* For an introduction to Azure Event Grid, see [What is Event Grid?](overview.md)
161-
* For more information about creating an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md).
159+
See the following tutorial: [Deploy Events using the Azure portal](../healthcare-apis/events/events-deploy-portal.md).
160+
162161

163162
(FHIR®) is a registered trademark of [HL7](https://hl7.org/fhir/) and is used with the permission of HL7.

articles/event-grid/event-schema-azure-maps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Maps as Event Grid source
33
description: Describes the properties and schema provided for Azure Maps events with Azure Event Grid
44
ms.topic: conceptual
5-
ms.date: 09/15/2021
5+
ms.date: 12/02/2022
66
---
77

88
# Azure Maps as an Event Grid source

articles/event-grid/event-schema-azure-signalr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure SignalR as Event Grid source
33
description: Describes the properties that are provided for Azure SignalR events with Azure Event Grid
44
ms.topic: conceptual
5-
ms.date: 09/15/2021
5+
ms.date: 12/02/2022
66
---
77

88
# Azure Event Grid event schema for SignalR Service

articles/event-grid/event-schema-event-hubs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Event Hubs as Event Grid source
33
description: Describes the properties that are provided for event hubs events with Azure Event Grid
44
ms.topic: conceptual
5-
ms.date: 09/15/2021
5+
ms.date: 12/02/2022
66
---
77

88
# Azure Event Hubs as an Event Grid source

articles/event-grid/event-schema-iot-hub.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure IoT Hub as Event Grid source
33
description: This article provides the properties and schema for Azure IoT Hub events. It lists the available event types, an example event, and event properties.
44
ms.topic: conceptual
5-
ms.date: 09/15/2021
5+
ms.date: 12/02/2022
66
---
77

88
# Azure IoT Hub as an Event Grid source
@@ -24,7 +24,7 @@ Azure IoT Hub emits the following event types:
2424

2525
# [Event Grid event schema](#tab/event-grid-event-schema)
2626

27-
The schema for DeviceConnected and DeviceDisconnected events have the same structure. This sample event shows the schema of an event raised when a device is connected to an IoT hub:
27+
The schemas for DeviceConnected and DeviceDisconnected events have the same structure. This sample event shows the schema of an event raised when a device is connected to an IoT hub:
2828

2929
```json
3030
[{
@@ -81,7 +81,7 @@ The DeviceTelemetry event is raised when a telemetry event is sent to an IoT Hub
8181
}]
8282
```
8383

84-
The schema for DeviceCreated and DeviceDeleted events have the same structure. This sample event shows the schema of an event raised when a device is registered to an IoT hub:
84+
The schemas for DeviceCreated and DeviceDeleted events have the same structure. This sample event shows the schema of an event raised when a device is registered to an IoT hub:
8585

8686
```json
8787
[{
@@ -131,7 +131,7 @@ The schema for DeviceCreated and DeviceDeleted events have the same structure. T
131131

132132
# [Cloud event schema](#tab/cloud-event-schema)
133133

134-
The schema for DeviceConnected and DeviceDisconnected events have the same structure. This sample event shows the schema of an event raised when a device is connected to an IoT hub:
134+
The schemas for DeviceConnected and DeviceDisconnected events have the same structure. This sample event shows the schema of an event raised when a device is connected to an IoT hub:
135135

136136
```json
137137
[{
@@ -186,7 +186,7 @@ The DeviceTelemetry event is raised when a telemetry event is sent to an IoT Hub
186186
}]
187187
```
188188

189-
The schema for DeviceCreated and DeviceDeleted events have the same structure. This sample event shows the schema of an event raised when a device is registered to an IoT hub:
189+
The schemas for DeviceCreated and DeviceDeleted events have the same structure. This sample event shows the schema of an event raised when a device is registered to an IoT hub:
190190

191191
```json
192192
[{
@@ -245,7 +245,7 @@ All events contain the same top-level data:
245245
| Property | Type | Description |
246246
| -------- | ---- | ----------- |
247247
| `id` | string | Unique identifier for the event. |
248-
| `topic` | string | Full resource path to the event source. This field is not writeable. Event Grid provides this value. |
248+
| `topic` | string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
249249
| `subject` | string | Publisher-defined path to the event subject. |
250250
| `eventType` | string | One of the registered event types for this event source. |
251251
| `eventTime` | string | The time the event is generated based on the provider's UTC time. |
@@ -261,7 +261,7 @@ All events contain the same top-level data:
261261
| Property | Type | Description |
262262
| -------- | ---- | ----------- |
263263
| `id` | string | Unique identifier for the event. |
264-
| `source` | string | Full resource path to the event source. This field is not writeable. Event Grid provides this value. |
264+
| `source` | string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
265265
| `subject` | string | Publisher-defined path to the event subject. |
266266
| `type` | string | One of the registered event types for this event source. |
267267
| `time` | string | The time the event is generated based on the provider's UTC time. |
@@ -293,7 +293,7 @@ For **Device Telemetry** IoT Hub event, the data object contains the device-to-c
293293
| -------- | ---- | ----------- |
294294
| `body` | string | The content of the message from the device. |
295295
| `properties` | string | Application properties are user-defined strings that can be added to the message. These fields are optional. |
296-
| `system properties` | string | [System properties](../iot-hub/iot-hub-devguide-routing-query-syntax.md#system-properties) help identify contents and source of the messages. Device telemetry message must be in a valid JSON format with the contentType set to JSON and contentEncoding set to UTF-8 in the message system properties. If this is not set, then IoT Hub will write the messages in base 64 encoded format. |
296+
| `system properties` | string | [System properties](../iot-hub/iot-hub-devguide-routing-query-syntax.md#system-properties) help identify contents and source of the messages. Device telemetry message must be in a valid JSON format with the contentType set to JSON and contentEncoding set to UTF-8 in the message system properties. If this isn't set, then IoT Hub will write the messages in base 64 encoded format. |
297297

298298
For **Device Created** and **Device Deleted** IoT Hub events, the data object contains the following properties:
299299

@@ -303,13 +303,13 @@ For **Device Created** and **Device Deleted** IoT Hub events, the data object co
303303
| `deviceID` | string | The unique identifier of the device twin. |
304304
| `etag` | string | A validator for ensuring consistency of updates to a device twin. Each etag is guaranteed to be unique per device twin. |
305305
| `deviceEtag` | string | A validator for ensuring consistency of updates to a device registry. Each deviceEtag is guaranteed to be unique per device registry. |
306-
| `status` | string | Whether the device twin is enabled or disabled. |
306+
| `status` | string | Indicates whether the device twin is enabled or disabled. |
307307
| `statusUpdateTime` | string | The ISO8601 timestamp of the last device twin status update. |
308-
| `connectionState` | string | Whether the device is connected or disconnected. |
308+
| `connectionState` | string | Indicates whether the device is connected or disconnected. |
309309
| `lastActivityTime` | string | The ISO8601 timestamp of the last activity. |
310310
| `cloudToDeviceMessageCount` | integer | Count of cloud to device messages sent to this device. |
311311
| `authenticationType` | string | Authentication type used for this device: either `SAS`, `SelfSigned`, or `CertificateAuthority`. |
312-
| `x509Thumbprint` | string | The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate. |
312+
| `x509Thumbprint` | string | The thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and doesn't physically exist in the certificate. |
313313
| `primaryThumbprint` | string | Primary thumbprint for the x509 certificate. |
314314
| `secondaryThumbprint` | string | Secondary thumbprint for the x509 certificate. |
315315
| `version` | integer | An integer that is incremented by one each time the device twin is updated. |

articles/event-grid/event-schema-machine-learning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Machine Learning as Event Grid source
33
description: Describes the properties that are provided for Machine Learning Workspace events with Azure Event Grid
44
ms.topic: conceptual
5-
ms.date: 09/15/2021
5+
ms.date: 12/02/2022
66
---
77

88
# Azure Machine Learning as an Event Grid source

0 commit comments

Comments
 (0)