[Event Grid] Add Control Plane API Version 2025-11-15-preview#40671
[Event Grid] Add Control Plane API Version 2025-11-15-preview#40671priyanshuvats wants to merge 13 commits into
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
Comment generated by summarize-checks workflow run. |
ARM recommends well-chosen enum values instead of boolean for flexibility, better discoverability, and other reasons. This could be something like scalingType: { Manual, Automatic }. Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/preview/2025-11-15-preview/EventGrid.json:18089 in e100da5. [](commit_id = e100da5, deletion_comment = False) |
There was a problem hiding this comment.
Pull request overview
Adds a new Event Grid ARM (control plane) preview API version 2025-11-15-preview, including the swagger for that version, associated ARM examples, and an update to the repo suppressions to allow the new version to remain in OpenAPI (non-TypeSpec) form for now.
Changes:
- Introduces
preview/2025-11-15-preview/EventGrid.jsonfor the new API version. - Adds a large set of
preview/2025-11-15-preview/examples/*.jsonfiles for operations/resources in this API version. - Updates
suppressions.yamlto include the new preview version in theTypeSpecRequirementsuppression.
Reviewed changes
Copilot reviewed 219 out of 220 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/suppressions.yaml | Adds TypeSpecRequirement suppression for the new preview version path. |
| specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/preview/2025-11-15-preview/EventGrid.json | New/updated swagger for API version 2025-11-15-preview. |
| specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/preview/2025-11-15-preview/examples/*.json | New/updated ARM examples for operations in 2025-11-15-preview. |
@mentat9 there is a precedence of using boolean for auto scaling feature in other products in messaging like event hub here. We prefer to keep it like that for consistency across messaging products, let me know if this is a blocking issue. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
Comment generated by After APIView workflow run. |
…olve TypeFormatChanged cross-version breaking change Common-types v6 SubscriptionIdParameter has format:uuid which triggers TypeFormatChanged errors when compared against the previous stable version. v3 has no format field, matching the previous stable behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| - preview/2025-11-15-preview/EventGrid.json | ||
|
|
||
| suppressions: | ||
| - code: PatchBodyParametersSchema |
There was a problem hiding this comment.
EventGrid's PATCH operations use a flat update model (EventSubscriptionUpdateParameters) where properties like destination, retryPolicy, deadLetterDestination are at the top level NOT nested under a properties wrapper.
- This is the existing API contract from previous versions.
- The PatchBodyParametersSchema rule expects PATCH bodies to follow ARM's nested properties pattern, but EventGrid's design predates that convention.
Note: These suppressions were NOT added explicitly in this version, they were already in the previous preview's (2025-07-15) readme tag. This PR just copied the same suppressions into the new package-2025-11-preview tag.
There was a problem hiding this comment.
i am talking about formating the suppresions. But are you sure you need to copy them to curent version if you did not added anything new to the properties of patch body?
- code: PatchBodyParametersSchema
reason: text
where:
- path1
- path2
- etc
There was a problem hiding this comment.
Addressed. Used where with list of paths as suggested
There was a problem hiding this comment.
Checked latest: these PatchBodyParametersSchema suppressions are carry-forward from package-2025-07 for existing paths, and this tag uses consolidated where path lists.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.