api management events schema #15987
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2018-01-01", | ||
| "title": "Schema of Azure API Management events published to Azure Event Grid", | ||
| "description": "Describes the schema of the Azure API Management events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." | ||
| }, | ||
| "paths": {}, | ||
| "definitions": { | ||
| "UserCreatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserCreated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "UserUpdatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserUpdated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "UserDeletedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.UserDeleted event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "SubscriptionCreatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionCreated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "SubscriptionUpdatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionUpdated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "SubscriptionDeletedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.SubscriptionDeleted event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ProductCreatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductCreated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ProductUpdatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductUpdated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ProductDeletedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ProductDeleted event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "APICreatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APICreated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "APIUpdatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIUpdated event.", | ||
|
Member
There was a problem hiding this comment. I noticed that for some events
Member
There was a problem hiding this comment. Also, curious about this - We would likely need to rename this via swagger transforms in .NET. It also seems odd that we have API (in whatever casing) twice in the name of the events.
Member
There was a problem hiding this comment. Yeah, that makes sense but the casing should be consistent, right? We will have to transform it anyway to use "Api" everywhere if we leave it as "API" in the swagger. There was a problem hiding this comment. ApiManagement is the name of our service that hosts "API" entities. API is an abbreviation so we normally spell it with all caps. |
||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "APIDeletedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.APIDeleted event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ApiReleaseCreatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ApiReleaseCreated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ApiReleaseUpdatedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ApiReleaseUpdated event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "ApiReleaseDeletedEventData": { | ||
| "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ApiManagement.ApiReleaseDeleted event.", | ||
| "type": "object", | ||
| "properties": { | ||
| "resourceUri": { | ||
| "description": "The fully qualified ID of the resource that the compliance state change is for, including the resource name and resource type. Uses the format, `/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName>`", | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "id": "92c502f2-a966-42a7-a428-d3b319844544", | ||
| "topic": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}", | ||
| "subject": "/products/myproduct", | ||
| "data": { | ||
| "resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct" | ||
| }, | ||
| "eventType": "Microsoft.ApiManagement.ProductCreated", | ||
| "dataVersion": "1", | ||
| "metadataVersion": "1", | ||
| "eventTime": "2021-07-02T00:47:47.8536532Z" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.