Skip to content

Commit 6b9227f

Browse files
ttorblettorble
authored
Merge pull request #229268 from BlackRider97/data_manager_for_agri_supports_event_grid
Adding Azure Data Manager for Agriculture events to Event Grid [Public Preview Launch]
2 parents b4efc93 + a6de482 commit 6b9227f

File tree

3 files changed

+216
-1
lines changed

3 files changed

+216
-1
lines changed

‎articles/event-grid/event-schema-data-manager-for-agriculture.md

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
---
2+
title: Azure Data Manager for Agriculture
3+
description: Describes the properties that are provided for Azure Data Manager for Agriculture events with Azure Event Grid.
4+
ms.topic: conceptual
5+
ms.date: 03/02/2023
6+
---
7+
8+
# Azure Data Manager for Agriculture (Preview) as Event Grid source
9+
10+
This article provides the properties and schema for Azure Data Manager for Agriculture (Preview) events. For an introduction to event schemas, see [Azure Event Grid event schema](event-schema.md) and [Cloud event schema](cloud-event-schema.md).
11+
12+
## Available event types
13+
14+
### Farm management related event types
15+
16+
|Event Name | Description|
17+
|:-----:|:----:|
18+
|Microsoft.AgFoodPlatform.PartyChanged|Published when a `Party` is created/updated/deleted.|
19+
|Microsoft.AgFoodPlatform.FarmChangedV2| Published when a `Farm` is created/updated/deleted.|
20+
|Microsoft.AgFoodPlatform.FieldChangedV2|Published when a `Field` is created/updated/deleted.|
21+
|Microsoft.AgFoodPlatform.SeasonChanged|Published when a `Season` is created/updated/deleted.|
22+
|Microsoft.AgFoodPlatform.SeasonalFieldChangedV2|Published when a `Seasonal Field` is created/updated/deleted.|
23+
|Microsoft.AgFoodPlatform.BoundaryChangedV2|Published when a `Boundary` is created/updated/deleted.|
24+
|Microsoft.AgFoodPlatform.CropChanged|Published when a `Crop` is created/updated/deleted.|
25+
|Microsoft.AgFoodPlatform.CropProductChanged|Published when a `Crop Product` is created /updated/deleted.|
26+
|Microsoft.AgFoodPlatform.AttachmentChangedV2|Published when an `Attachment` is created/updated/deleted.
27+
|Microsoft.AgFoodPlatform.ManagementZoneChangedV2|Published when a `Management Zone` is created/updated/deleted.|
28+
|Microsoft.AgFoodPlatform.ZoneChangedV2|Published when an `Zone` is created/updated/deleted.|
29+
30+
### Satellite data related event types
31+
32+
|Event Name | Description|
33+
|:-----:|:----:|
34+
|Microsoft.AgFoodPlatform.SatelliteDataIngestionJobStatusChangedV2| Published when a satellite data ingestion job's status is changed, for example, job is created, has progressed or completed.|
35+
36+
### Weather data related event types
37+
38+
|Event Name | Description|
39+
|:-----:|:----:|
40+
|Microsoft.AgFoodPlatform.WeatherDataIngestionJobStatusChangedV2|Published when a weather data ingestion job's status is changed, for example, job is created, has progressed or completed.|
41+
|Microsoft.AgFoodPlatform.WeatherDataRefresherJobStatusChangedV2| Published when a weather data refresher job status is changed, for example, job is created, has progressed or completed.|
42+
43+
### Farm activities data related event types
44+
45+
|Event Name | Description|
46+
|:-----:|:----:|
47+
|Microsoft.AgFoodPlatform.ApplicationDataChangedV2|Published when an `Application Data` is created/updated/deleted.|
48+
|Microsoft.AgFoodPlatform.HarvestDataChangedV2|Published when a `Harvesting Data` is created/updated/deleted.|
49+
|Microsoft.AgFoodPlatform.TillageDataChangedV2|Published when a `Tillage Data` is created/updated/deleted.|
50+
|Microsoft.AgFoodPlatform.PlantingDataChangedV2|Published when a `Planting Data` is created/updated/deleted.|
51+
|Microsoft.AgFoodPlatform.ImageProcessingRasterizeJobStatusChangedV2|Published when an image-processing rasterizes job's status is changed, for example, job is created, has progressed or completed.|
52+
|Microsoft.AgFoodPlatform.FarmOperationDataIngestionJobStatusChangedV2| Published when a farm operations data ingestion job's status is changed, for example, job is created, has progressed or completed.|
53+
54+
### Sensor data related event types
55+
56+
|Event Name | Description|
57+
|:-----:|:----:|
58+
|Microsoft.AgFoodPlatform.SensorMappingChangedV2|Published when a `Sensor Mapping` is created/updated/deleted.|
59+
|Microsoft.AgFoodPlatform.SensorPartnerIntegrationChangedV2|Published when a `Sensor Partner Integration` is created/updated/deleted.|
60+
|Microsoft.AgFoodPlatform.DeviceDataModelChanged|Published when `Device Data Model` is created/updated/deleted.|
61+
|Microsoft.AgFoodPlatform.DeviceChanged|Published when a `Device` is created/updated/deleted.|
62+
|Microsoft.AgFoodPlatform.SensorDataModelChanged|Published when a `Sensor Data Model` is created/updated/deleted.|
63+
|Microsoft.AgFoodPlatform.SensorChanged|Published when a `Sensor` is created/updated/deleted.|
64+
65+
### Insight and observations related event types
66+
67+
|Event Name | Description|
68+
|:-----:|:----:|
69+
|Microsoft.AgFoodPlatform.PrescriptionChangedV2|Published when a `Prescription` is created/updated/deleted.|
70+
|Microsoft.AgFoodPlatform.PrescriptionMapChangedV2|Published when a `Prescription Map` is created/updated/deleted.|
71+
|Microsoft.AgFoodPlatform.PlantTissueAnalysisChangedV2|Published when a `Plant Tissue Analysis` data is created/updated/deleted.|
72+
|Microsoft.AgFoodPlatform.NutrientAnalysisChangedV2|Published when a `Nutrient Analysis` data is created/updated/deleted.|
73+
|Microsoft.AgFoodPlatform.InsightChangedV2| Published when an `Insight` is created/updated/deleted.|
74+
|Microsoft.AgFoodPlatform.InsightAttachmentChangedV2| Published when an `Insight Attachment` is created/updated/deleted.|
75+
76+
### Model inference jobs related event types
77+
78+
|Event Name | Description|
79+
|:-----:|:----:|
80+
|Microsoft.AgFoodPlatform.BiomassModelJobStatusChangedV2|Published when a Biomass Model job's status is changed, for example, job is created, has progressed or completed.|
81+
|Microsoft.AgFoodPlatform.SoilMoistureModelJobStatusChangedV2|Published when a Soil Moisture Model job's status is changed, for example, job is created, has progressed or completed.|
82+
|Microsoft.AgFoodPlatform.SensorPlacementModelJobStatusChangedV2|Published when a Sensor Placement Model job's status is changed, for example, job is created, has progressed or completed.|
83+
84+
## Example events
85+
86+
# [Event Grid event schema](#tab/event-grid-event-schema)
87+
88+
The following example show schema for **Microsoft.AgFoodPlatform.PartyChanged**:
89+
90+
```JSON
91+
[
92+
{
93+
"data": {
94+
"actionType": "Deleted",
95+
"modifiedDateTime": "2022-10-17T18:43:37Z",
96+
"eTag": "f700fdd7-0000-0700-0000-634da2550000",
97+
"properties": {
98+
"key1": "value1",
99+
"key2": 123.45
100+
},
101+
"id": "<YOUR-PARTY-ID>",
102+
"createdDateTime": "2022-10-17T18:43:30Z"
103+
},
104+
"id": "23fad010-ec87-40d9-881b-1f2d3ba9600b",
105+
"topic": "/subscriptions/{SUBSCRIPTION-ID}/resourceGroups/{RESOURCE-GROUP-NAME}/providers/Microsoft.AgFoodPlatform/farmBeats/{YOUR-RESOURCE-NAME}",
106+
"subject": "/parties/<YOUR-PARTY-ID>",
107+
"eventType": "Microsoft.AgFoodPlatform.PartyChanged",
108+
"dataVersion": "1.0",
109+
"metadataVersion": "1",
110+
"eventTime": "2022-10-17T18:43:37.3306735Z"
111+
}
112+
]
113+
```
114+
115+
# [Cloud event schema](#tab/cloud-event-schema)
116+
117+
The following example show schema for **Microsoft.AgFoodPlatform.PartyChanged**:
118+
119+
```JSON
120+
[
121+
{
122+
"data": {
123+
"actionType": "Deleted",
124+
"modifiedDateTime": "2022-10-17T18:43:37Z",
125+
"eTag": "f700fdd7-0000-0700-0000-634da2550000",
126+
"properties": {
127+
"key1": "value1",
128+
"key2": 123.45
129+
},
130+
"id": "<YOUR-PARTY-ID>",
131+
"createdDateTime": "2022-10-17T18:43:30Z"
132+
},
133+
"id": "23fad010-ec87-40d9-881b-1f2d3ba9600b",
134+
"source": "/subscriptions/{SUBSCRIPTION-ID}/resourceGroups/{RESOURCE-GROUP-NAME}/providers/Microsoft.AgFoodPlatform/farmBeats/{YOUR-RESOURCE-NAME}",
135+
"subject": "/parties/<YOUR-PARTY-ID>",
136+
"type": "Microsoft.AgFoodPlatform.PartyChanged",
137+
"specversion":"1.0",
138+
"time": "2022-10-17T18:43:37.3306735Z"
139+
}
140+
]
141+
```
142+
143+
---
144+
145+
## Event properties
146+
147+
# [Event Grid event schema](#tab/event-grid-event-schema)
148+
149+
An event has the following top-level data:
150+
151+
| Property | Type | Description |
152+
|:-----:|:----:|:----:|
153+
| `topic` | string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
154+
| `subject` | string | Publisher-defined path to the event subject. |
155+
| `eventType` | string | One of the registered event types for this event source. |
156+
| `eventTime` | string | The time the event is generated based on the provider's UTC time. |
157+
| `id` | string | Unique identifier for the event. |
158+
| `data` | object | App Configuration event data. |
159+
| `dataVersion` | string | The schema version of the data object. The publisher defines the schema version. |
160+
| `metadataVersion` | string | The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. |
161+
162+
# [Cloud event schema](#tab/cloud-event-schema)
163+
164+
An event has the following top-level data:
165+
166+
| Property | Type | Description |
167+
|:-----:|:----:|:----:|
168+
| `source` | string | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
169+
| `subject` | string | Publisher-defined path to the event subject. |
170+
| `type` | string | One of the registered event types for this event source. |
171+
| `time` | string | The time the event is generated based on the provider's UTC time. |
172+
| `id` | string | Unique identifier for the event. |
173+
| `data` | object | App Configuration event data. |
174+
| `specversion` | string | CloudEvents schema specification version. |
175+
176+
---
177+
178+
The data object has the following common properties:
179+
180+
### For resource change related event types
181+
182+
|Property | Type| Description|
183+
|:-----:|:----:|:----:|
184+
|id| String| Unique ID of resource.|
185+
|actionType| String| Indicates the change, which triggered publishing of the event. Applicable values are created, updated, deleted.|
186+
|properties| Object| It contains user defined key–value pairs.|
187+
|modifiedDateTime|String| Indicates the time at which the event was last modified.|
188+
|createdDateTime| String| Indicates the time at which the resource was created.|
189+
|status| String| Contains the user defined status of the object.|
190+
|eTag| String| Implements optimistic concurrency.|
191+
|description| string| Textual description of the resource.|
192+
|name| string| Name to identify resource.|
193+
194+
### For job status change related event types
195+
196+
Property| Type| Description
197+
|:-----:|:----:|:----:|
198+
|id|String| Unique ID of the job.|
199+
|name| string| User-defined name of the job.|
200+
|status|string|Various states a job can be in.|
201+
|isCancellationRequested| boolean|Flag that gets set when job cancellation is requested.|
202+
|description|string| Textual description of the job.|
203+
|partyId|string| Party ID for which job was created.|
204+
|message|string| Status message to capture more details of the job.|
205+
|lastActionDateTime|date-time|Date-time when last action was taken on the job, sample format: yyyy-MM-ddTHH:mm:ssZ.|
206+
|createdDateTime|date-time|Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.|
207+
|properties| Object| It contains user defined key-value pairs.|
208+
209+
## Next steps
210+
211+
* For an introduction to Azure Event Grid, see [What is Event Grid?](overview.md).
212+
* For more information about how to create an Azure Event Grid subscription, see [Event Grid subscription schema](subscription-creation-schema.md).

‎articles/event-grid/includes/event-sources-system-topics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@
1515
- [Azure App Service](../event-schema-app-service.md)
1616
- [Azure Blob Storage](../event-schema-blob-storage.md)
1717
- [Azure Cache for Redis](../event-schema-azure-cache.md)
18-
- [Azure Communication Services](../event-schema-communication-services.md)
18+
- [Azure Communication Services](../event-schema-communication-services.md)
1919
- [Azure Container Registry](../event-schema-container-registry.md)
2020
- [Azure Data Box](../event-schema-data-box.md)
21+
- [Azure Data Manager for Agriculture](../event-schema-data-manager-for-agriculture.md)
2122
- [Azure Event Hubs](../event-schema-event-hubs.md)
2223
- [Azure Health Data Services](../event-schema-azure-health-data-services.md)
2324
- [Azure IoT Hub](../event-schema-iot-hub.md)

‎articles/event-grid/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ items:
143143
href: event-schema-container-registry.md
144144
- name: Azure Data Box
145145
href: event-schema-data-box.md
146+
- name: Azure Data Manager for Agriculture
147+
href: event-schema-data-manager-for-agriculture.md
146148
- name: Azure Event Hubs
147149
href: event-schema-event-hubs.md
148150
- name: Azure Health Data Services

0 commit comments

Comments
 (0)