diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/Web.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/Web.json new file mode 100644 index 000000000000..69d70d1b6fb5 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/Web.json @@ -0,0 +1,594 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure App Service events published to Azure Event Grid", + "description": "Describes the schema of the Azure App Service events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "WebAppUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.AppUpdated event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebBackupOperationStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationStarted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebBackupOperationCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationCompleted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebBackupOperationFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.BackupOperationFailed event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebRestoreOperationStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationStarted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebRestoreOperationCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationCompleted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebRestoreOperationFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.RestoreOperationFailed event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebSlotSwapStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapStarted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebSlotSwapCompletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapCompleted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebSlotSwapFailedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapFailed event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebSlotSwapWithPreviewStartedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapWithPreviewStarted event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebSlotSwapWithPreviewCancelledEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.SlotSwapWithPreviewCancelled event.", + "type": "object", + "properties": { + "appEventTypeDetail": { + "$ref": "#/definitions/AppEventTypeDetail" + }, + "name": { + "description": "name of the web site that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the site API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "WebAppServicePlanUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Web.AppServicePlanUpdated event.", + "type": "object", + "properties": { + "appServicePlanEventTypeDetail": { + "$ref": "#/definitions/AppServicePlanEventTypeDetail" + }, + "sku": { + "description": "sku of app service plan.", + "type": "object", + "properties": { + "name": { + "description": "name of app service plan sku.", + "type": "string" + }, + "Tier": { + "description": "tier of app service plan sku.", + "type": "string" + }, + "Size": { + "description": "size of app service plan sku.", + "type": "string" + }, + "Family": { + "description": "family of app service plan sku.", + "type": "string" + }, + "Capacity": { + "description": "capacity of app service plan sku.", + "type": "string" + } + } + }, + "name": { + "description": "name of the app service plan that had this event.", + "type": "string" + }, + "clientRequestId": { + "description": "The client request id generated by the app service for the app service plan API operation that triggered this event.", + "type": "string" + }, + "correlationRequestId": { + "description": "The correlation request id generated by the app service for the app service plan API operation that triggered this event.", + "type": "string" + }, + "requestId": { + "description": "The request id generated by the app service for the app service plan API operation that triggered this event.", + "type": "string" + }, + "address": { + "description": "HTTP request URL of this operation.", + "type": "string" + }, + "verb": { + "description": "HTTP verb of this operation.", + "type": "string" + } + } + }, + "AppEventTypeDetail": { + "description": "Detail of action on the app.", + "type": "object", + "properties": { + "action": { + "description": "Type of action of the operation.", + "type": "string", + "enum": [ + "Restarted", + "Stopped", + "ChangedAppSettings", + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AppAction", + "modelAsString": true, + "values": [ + { + "value": "Restarted", + "description": "Web app was restarted." + }, + { + "value": "Stopped", + "description": "Web app was stopped." + }, + { + "value": "ChangedAppSettings", + "description": "There was an operation to change app setting on the web app." + }, + { + "value": "Started", + "description": "The job has started." + }, + { + "value": "Completed", + "description": "The job has completed." + }, + { + "value": "Failed", + "description": "The job has failed to complete." + } + ] + } + } + } + }, + "AppServicePlanEventTypeDetail": { + "description": "Detail of action on the app service plan.", + "type": "object", + "properties": { + "stampKind": { + "description": "Kind of environment where app service plan is.", + "type": "string", + "enum": [ + "Public", + "AseV1", + "AseV2" + ], + "x-ms-enum": { + "name": "StampKind", + "modelAsString": true, + "values": [ + { + "value": "Public", + "description": "App Service Plan is running on a public stamp." + }, + { + "value": "AseV1", + "description": "App Service Plan is running on an App Service Environment V1." + }, + { + "value": "AseV2", + "description": "App Service Plan is running on an App Service Environment V2." + } + ] + } + }, + "action": { + "description": "Type of action on the app service plan.", + "type": "string", + "enum": [ + "Updated" + ], + "x-ms-enum": { + "name": "AppServicePlanAction", + "modelAsString": true, + "values": [ + { + "value": "Updated", + "description": "App Service plan is being updated." + } + ] + } + }, + "status": { + "$ref": "#/definitions/AsyncStatus" + } + } + }, + "AsyncStatus": { + "description": "Asynchronous operation status of the operation on the app service plan.", + "type": "string", + "enum": [ + "Started", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncStatus", + "modelAsString": true, + "values": [ + { + "value": "Started", + "description": "Async operation has started." + }, + { + "value": "Completed", + "description": "Async operation has completed." + }, + { + "value": "Failed", + "description": "Async operation failed to complete." + } + ] + } + } + } +} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index aa5a71eb52c0..fd7eb6016138 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -58,6 +58,7 @@ input-file: - Microsoft.KeyVault/stable/2018-01-01/KeyVault.json - Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json - Microsoft.Cache/stable/2018-01-01/RedisCache.json +- Microsoft.Web/stable/2018-01-01/Web.json ``` --- @@ -139,6 +140,7 @@ input-file: - $(this-folder)/Microsoft.KeyVault/stable/2018-01-01/KeyVault.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json - $(this-folder)/Microsoft.Cache/stable/2018-01-01/RedisCache.json + - $(this-folder)/Microsoft.Web/stable/2018-01-01/Web.json ```