Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api management events schema #15987

Merged
merged 15 commits into from
Sep 23, 2021
Merged

api management events schema #15987

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
179b4e3
Merge pull request #1 from Azure/master
KacieKK Feb 24, 2021
f8bb8c6
Merge remote-tracking branch 'upstream/master' into master
KacieKK Jun 4, 2021
95805dc
Merge branch 'master' of https://github.com/Azure/azure-rest-api-spec…
KacieKK Jun 16, 2021
3534a76
Merge branch 'Azure:master' into master
KacieKK Jun 16, 2021
220d282
Merge branch 'master' of https://github.com/KacieKK/azure-rest-api-sp…
KacieKK Sep 9, 2021
f221e24
add swagger
KacieKK Sep 9, 2021
a1534e6
align
KacieKK Sep 9, 2021
ef10a16
rephrase
KacieKK Sep 10, 2021
a99abd6
resolvemergeconflict
KacieKK Sep 10, 2021
068fce1
Merge branch 'main' into apimEgSchema
KacieKK Sep 10, 2021
4d9f58e
comments
KacieKK Sep 13, 2021
2f54f2f
examples
KacieKK Sep 14, 2021
5091d95
prettier
KacieKK Sep 14, 2021
ead07f0
comments
KacieKK Sep 17, 2021
9daae81
pascal
KacieKK Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 161 additions & 0 deletions ...ication/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json
View file
Open in desktop
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": {
KacieKK marked this conversation as resolved.
Show resolved Hide resolved
"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.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that for some events API is capitalized, and in other cases, it's spell Api (e.g. APIUpdated vs ApiReleaseUpdated) I just want to confirm that the difference in casing between these event is expected.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@JoshLove-msft JoshLove-msft Sep 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ApiManagement is the name of our service that hosts "API" entities. API is an abbreviation so we normally spell it with all caps.
Renaming "ApiManagementAPI" to "ApiManagementApi" requires an extra rollout train to all our services. We prefer to stay as it is.

"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"
}
}
}
}
}
12 changes: 12 additions & 0 deletions ...entgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/examples/productCreated.json
View file
Open in desktop
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"
}
3 changes: 3 additions & 0 deletions specification/eventgrid/data-plane/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ input-file:
- Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json
- Microsoft.PolicyInsights/stable/2018-01-01/PolicyInsights.json
- Microsoft.ContainerService/stable/2018-01-01/ContainerService.json
- Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json

```

### Suppression
Expand Down Expand Up @@ -227,6 +229,7 @@ input-file:
- $(this-folder)/Microsoft.Web/stable/2018-01-01/Web.json
- $(this-folder)/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json
- $(this-folder)/Microsoft.ContainerService/stable/2018-01-01/ContainerService.json
- $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json

```

Expand Down