Skip to content

[Event Grid] Add Control Plane API Version 2025-11-15-preview#40671

Open
priyanshuvats wants to merge 13 commits into
Azure:mainfrom
priyanshuvats:pvats/EventGrid_2025_11_15_preview
Open

[Event Grid] Add Control Plane API Version 2025-11-15-preview#40671
priyanshuvats wants to merge 13 commits into
Azure:mainfrom
priyanshuvats:pvats/EventGrid_2025_11_15_preview

Conversation

@priyanshuvats

@priyanshuvats priyanshuvats commented Feb 24, 2026

Copy link
Copy Markdown
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section 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.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    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.
  • A release plan has been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

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 ApiView comment 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

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.
  • For guidance on SDK breaking change review, refer to https://aka.ms/ci-fix.

@github-actions

github-actions Bot commented Feb 24, 2026

Copy link
Copy Markdown

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The suppressions added to the AutoRest config files (README.mds) require review. Refer to step 1 in the PR workflow diagram, or to step 3, depending on the kind of suppression you did.


Comment generated by summarize-checks workflow run.

@github-actions github-actions Bot added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 24, 2026
@priyanshuvats priyanshuvats added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 24, 2026
@priyanshuvats priyanshuvats changed the title Pvats/event grid 2025 11 15 preview [Event Grid] Add Control Plane API Version 2025-11-15-preview Feb 24, 2026
@mentat9

mentat9 commented Feb 26, 2026

Copy link
Copy Markdown
Contributor
      "type": "boolean"

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)

@mentat9

mentat9 commented Feb 26, 2026

Copy link
Copy Markdown
Contributor
      "type": "boolean"

Consider enum.


Refers to: specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/preview/2025-11-15-preview/EventGrid.json:18108 in e100da5. [](commit_id = e100da5, deletion_comment = False)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.json for the new API version.
  • Adds a large set of preview/2025-11-15-preview/examples/*.json files for operations/resources in this API version.
  • Updates suppressions.yaml to include the new preview version in the TypeSpecRequirement suppression.

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.

@github-actions github-actions Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 26, 2026
@priyanshuvats

Copy link
Copy Markdown
Member Author
      "type": "boolean"

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)

@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.

@microsoft-github-policy-service microsoft-github-policy-service Bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Mar 30, 2026
@microsoft-github-policy-service microsoft-github-policy-service Bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Apr 13, 2026
@github-actions

github-actions Bot commented Apr 19, 2026

Copy link
Copy Markdown

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Swagger Microsoft.EventGrid-EventGrid
Go sdk/resourcemanager/eventgrid/armeventgrid
JavaScript @azure/arm-eventgrid
Python azure-mgmt-eventgrid
Java com.azure.resourcemanager:azure-resourcemanager-eventgrid
C# Azure.ResourceManager.EventGrid

Comment generated by After APIView workflow run.

@github-actions github-actions Bot added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed ARMChangesRequested labels Jun 2, 2026
Rohit Semwal and others added 3 commits June 2, 2026 21:26
…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>
@github-actions github-actions Bot added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview labels Jun 5, 2026
- preview/2025-11-15-preview/EventGrid.json

suppressions:
- code: PatchBodyParametersSchema

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

PatchBodyParametersSchema

in place of creating multiple entries you can use where with a list of paths. Can you share why you need this suppresssion?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Addressed. Used where with list of paths as suggested

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Checked latest: these PatchBodyParametersSchema suppressions are carry-forward from package-2025-07 for existing paths, and this tag uses consolidated where path lists.

Comment thread specification/eventgrid/resource-manager/Microsoft.EventGrid/EventGrid/readme.md Outdated
@github-actions github-actions Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 5, 2026
@priyanshuvats priyanshuvats added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Jun 5, 2026
@github-actions github-actions Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 5, 2026
@github-actions github-actions Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 5, 2026
@sandipsh sandipsh added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review Event Grid new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager SuppressionReviewRequired

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants