feat: Introduce 11 new events for Azure API Management in Azure Event Grid system topic by tomkerkhove · Pull Request #20871 · Azure/azure-rest-api-specs

tomkerkhove · 2022-09-26T13:45:59Z

Event Grid IcM: https://portal.microsofticm.com/imp/v3/incidents/details/337589116/home

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

Link to engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.}

Design Document: N/A
Previous Open API Doc: N/A
Updated paths: N/A

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

… Grid system topic Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

openapi-workflow-bot · 2022-09-26T13:46:03Z

Hi, @tomkerkhove Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-09-26T13:46:03Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.9.7)]	new version	base version
APIManagement.json	2018-01-01(ef8f1f7)	2018-01-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️❌LintDiff: 2 Errors, 0 Warnings failed [Detail]

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
`❌` AutoRest exception	"location":"specification/eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"swagger-document/individual/schema-validator - FAILED"
`❌` AutoRest exception	"location":"specification/eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"Error: [OperationAbortedException] Error occurred. Exiting."

️❌Avocado: 22 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayApiAdded.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayApiRemoved.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayCertificateAuthorityCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayCertificateAuthorityDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayCertificateAuthorityUpdated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayHostnameConfigurationCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayHostnameConfigurationDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayHostnameConfigurationUpdated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/cloud-events-schema/selfHostedGatewayUpdated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayApiAdded.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayApiRemoved.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayCertificateAuthorityCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayCertificateAuthorityDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayCertificateAuthorityUpdated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayHostnameConfigurationCreated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayHostnameConfigurationDeleted.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayHostnameConfigurationUpdated.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/eventgrid/data-plane/readme.md json: 2018-01-01/examples/event-grid-schema/selfHostedGatewayUpdated.json

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]

Validation passes for ServiceAPIReadinessTest.

️️✔️~[Staging] TrafficValidation succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/ef8f1f7a195dbbe2b6bd64b114a89077e0c78243/specification/eventgrid/data-plane/readme.md#tag-package-2018-01">eventgrid/data-plane/readme.md#package-2018-01

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-09-26T13:46:04Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 5fb985d52df6af850a0e84989b154a9ff182dd19. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.Messaging.EventGrid [View full logs] [Preview SDK Changes]
- Azure.Messaging.EventGrid.4.12.0-alpha.20221003.1.nupkg
```
info	[Changelog]
```

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-09-26T13:46:05Z

Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

openapi-workflow-bot · 2022-09-26T13:50:21Z

Hi @tomkerkhove, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

tomkerkhove · 2022-09-26T14:30:27Z

I'm not sure how to fix the remaining validation failures to be honest

JoshLove-msft · 2022-10-03T04:32:03Z

specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json

        }
      }
+    },
+    "ApiManagementSelfHostedGatewayCreatedEventData": {


These event names are pretty long. Could we possibly remove "SelfHosted"?

Not really as this event is solely aimed for our self-hosted gateway.

Here's a full list of all events:

Microsoft.ApiManagement.SelfHostedGateway.Created

Microsoft.ApiManagement.SelfHostedGateway.Updated

Microsoft.ApiManagement.SelfHostedGateway.Deleted

Microsoft.ApiManagement.SelfHostedGateway.HostnameConfiguration.Created

Microsoft.ApiManagement.SelfHostedGateway.HostnameConfiguration.Updated

Microsoft.ApiManagement.SelfHostedGateway.HostnameConfiguration.Deleted

Microsoft.ApiManagement.SelfHostedGateway.CertificateAuthority.Created

Microsoft.ApiManagement.SelfHostedGateway.CertificateAuthority.Updated

Microsoft.ApiManagement.SelfHostedGateway.CertificateAuthority.Deleted

Microsoft.ApiManagement.SelfHostedGateway.API.Added

Microsoft.ApiManagement.SelfHostedGateway.API.Removed

Do you anticipate there being similar events for the managed gateway at some point?

I'd like to have this freedom, yet. Our ARM resource is big and these events are coming from https://learn.microsoft.com/en-us/azure/templates/microsoft.apimanagement/service/gateways/apis?pivots=deployment-language-bicep and related sub resources.

Our managed gateway also has custom hostname support as well as CAs.

As part of our product we always make a distinction

specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json

tomkerkhove added 2 commits September 26, 2022 15:36

feat: Introduce 11 new events for Azure API Management in Azure Event…

6de8426

… Grid system topic Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

Add CE samples

7ab7fa1

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

tomkerkhove requested review from Kishp01 and ahamad-MS as code owners September 26, 2022 13:45

openapi-assignment-bot bot assigned lmazuel Sep 26, 2022

ghost added the Event Grid label Sep 26, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Sep 26, 2022

AzureRestAPISpecReview added the data-plane label Sep 26, 2022

azure-sdk mentioned this pull request Sep 26, 2022

[AutoPR Azure.Messaging.EventGrid] feat: Introduce 11 new events for Azure API Management in Azure Event Grid system topic azure-sdk/azure-sdk-for-net#968

Closed

tomkerkhove added 2 commits September 26, 2022 16:02

Run prettier

85f43a4

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

Rename

7eeb4e7

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

JoshLove-msft mentioned this pull request Sep 30, 2022

Board Review: Event Grid new system events Azure/azure-sdk#4893

Closed

JoshLove-msft reviewed Oct 3, 2022

View reviewed changes

specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json Outdated Show resolved Hide resolved

JoshLove-msft reviewed Oct 3, 2022

View reviewed changes

specification/eventgrid/data-plane/Microsoft.ApiManagement/stable/2018-01-01/APIManagement.json Outdated Show resolved Hide resolved

"API" -> "Api"

ef8f1f7

tomkerkhove requested a review from JoshLove-msft October 3, 2022 05:54

tomkerkhove marked this pull request as draft October 3, 2022 18:44

tomkerkhove closed this Oct 19, 2022

JoshLove-msft mentioned this pull request Oct 24, 2022

Board Review: Event Grid new system events Azure/azure-sdk#5011

Closed

tomkerkhove mentioned this pull request Dec 6, 2022

feat: Introduce 11 new events for Azure API Management in Azure Event Grid system topic #21771

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Introduce 11 new events for Azure API Management in Azure Event Grid system topic#20871

feat: Introduce 11 new events for Azure API Management in Azure Event Grid system topic#20871
tomkerkhove wants to merge 5 commits intoAzure:mainfrom
tomkerkhove:tomkerkhove/apim/new-event-grid-events

tomkerkhove commented Sep 26, 2022

Uh oh!

openapi-workflow-bot bot commented Sep 26, 2022

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Sep 26, 2022

Uh oh!

tomkerkhove commented Sep 26, 2022

Uh oh!

JoshLove-msft Oct 3, 2022

Uh oh!

tomkerkhove Oct 3, 2022

Uh oh!

JoshLove-msft Oct 3, 2022

Uh oh!

tomkerkhove Oct 3, 2022

Uh oh!

tomkerkhove Oct 3, 2022

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

tomkerkhove commented Sep 26, 2022

Data Plane API - Pull Request

API Info: The Basics

Change Scope

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Uh oh!

openapi-workflow-bot bot commented Sep 26, 2022

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Sep 26, 2022

Uh oh!

tomkerkhove commented Sep 26, 2022

Uh oh!

JoshLove-msft Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

tomkerkhove Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

JoshLove-msft Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

tomkerkhove Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

tomkerkhove Oct 3, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 26, 2022 •

edited

Loading