diff --git a/specification/eventgrid/data-plane/Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json b/specification/eventgrid/data-plane/Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json new file mode 100644 index 000000000000..59b07ac08bb3 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json @@ -0,0 +1,821 @@ +{ + "swagger": "2.0", + "info": { + "title": "Schema of Azure FarmBeats events published to Azure Event Grid", + "description": "Describes the schema of the Azure FarmBeats Configuration events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent.", + "version": "2018-01-01" + }, + "paths": {}, + "definitions": { + "ResourceActionType": { + "description": "Action occurred on a resource.", + "enum": [ + "Created", + "Updated", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceActionType", + "modelAsString": true + } + }, + "FarmBeatsBoundaryChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.BoundaryChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "parentId": { + "description": "Id of the parent(field or seasonalField) it belongs to.", + "type": "string" + }, + "parentType": { + "description": "Type of the parent it belongs to.", + "type": "string" + }, + "isPrimary": { + "description": "A boolean flag indicating whether the boundary is primary or not.", + "type": "boolean" + }, + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsCropChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.CropChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsCropVarietyChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.CropVarietyChanged event.", + "type": "object", + "properties": { + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsFarmChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.FarmChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsFarmerChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.FarmerChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsFieldChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.FieldChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer Id.", + "type": "string" + }, + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsSeasonalFieldChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.SeasonalFieldChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "fieldId": { + "description": "Id of the field it belongs to.", + "type": "string" + }, + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsSeasonChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.SeasonChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsApplicationDataChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.ApplicationDataChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "source": { + "description": "Source of the farm operation data.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsPlantingDataChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.PlantingDataChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "source": { + "description": "Source of the farm operation data.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsHarvestDataChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.HarvestDataChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "source": { + "description": "Source of the farm operation data.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsTillageDataChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.TillageDataChanged event.", + "type": "object", + "properties": { + "actionType": { + "$ref": "#/definitions/ResourceActionType" + }, + "farmerId": { + "description": "Id of the farmer it belongs to.", + "type": "string" + }, + "status": { + "description": "Status of the resource.", + "type": "string" + }, + "source": { + "description": "Source of the farm operation data.", + "type": "string" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "JobStatus": { + "description": "Various states a job can be in.", + "enum": [ + "Waiting", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "FarmBeatsSatelliteDataIngestionJobStatusChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.SatelliteDataIngestionJobStatusChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer id for which job was created.", + "type": "string" + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/JobStatus" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Date-time when last action was taken on job, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "isCancellationRequested": { + "description": "Flag that gets set when job cancellation is requested.", + "type": "boolean" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsWeatherDataIngestionJobStatusChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.WeatherDataIngestionJobStatusChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer id for which job was created.", + "type": "string" + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/JobStatus" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Date-time when last action was taken on job, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "isCancellationRequested": { + "description": "Flag that gets set when job cancellation is requested.", + "type": "boolean" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "FarmBeatsFarmOperationDataIngestionJobStatusChangedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.AgFoodPlatform.FarmOperationDataIngestionJobStatusChanged event.", + "type": "object", + "properties": { + "farmerId": { + "description": "Farmer id for which job was created.", + "type": "string" + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/JobStatus" + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Date-time when last action was taken on job, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "isCancellationRequested": { + "description": "Flag that gets set when job cancellation is requested.", + "type": "boolean" + }, + "id": { + "description": "Unique id of resource.", + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "properties": { + "description": "A list of key value pairs that describe the resource.\r\nOnly string and numeral values are supported.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + } +} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index f1965d3b348f..8c568764d37b 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -84,6 +84,8 @@ input-file: - Microsoft.Web/stable/2018-01-01/Web.json - Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json - Microsoft.PolicyInsights/stable/2018-01-01/PolicyInsights.json +- Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json + ``` ### Suppression