Skip to content

Conversation

@anjbal
Copy link
Contributor

@anjbal anjbal commented Dec 12, 2025

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:
    • Service Gateway resource swagger changes,

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:

  • [X 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.

@anjbal anjbal requested a review from kamboj-prjwl as a code owner December 12, 2025 18:54
@github-actions
Copy link

github-actions bot commented Dec 12, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 12, 2025
@github-actions
Copy link

github-actions bot commented Dec 12, 2025

API Change Check

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

Language API Review for Package
Go sdk/resourcemanager/network/armnetwork
Java com.azure.resourcemanager:azure-resourcemanager-network-generated
JavaScript @azure/arm-network

@ramoka178
Copy link
Contributor

Please fix Swagger ModelValidation and place it back in queue for review.

@ramoka178 ramoka178 added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 12, 2025
@anjbal anjbal added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested ARMReview labels Dec 13, 2025
@anjbal
Copy link
Contributor Author

anjbal commented Dec 13, 2025

Please fix Swagger ModelValidation and place it back in queue for review.

Updated. Please reveiw.

reason: False alarm.
- code: PutRequestResponseSchemeArm
from: serviceGateway.json
reason: Code issue in PutRequestResponseSchemeArm validation.
Copy link
Member

@razvanbadea-msft razvanbadea-msft Dec 16, 2025

Choose a reason for hiding this comment

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

Code issue in PutRequestResponseSchemeArm validation

Can you explain more why do you need this suppresion? also can you add a where clause to be clear where you need it #Resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is code issue on API spec side Azure/azure-openapi-validator#752. Once issue is resolved , we don't need suppression.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated reason a bit and we need this suppression for whole file, until there is fix.

"items": {
"type": "string"
},
"description": "A list of availability zones denoting the zone in which service gateway should be deployed."
Copy link
Member

@razvanbadea-msft razvanbadea-msft Dec 16, 2025

Choose a reason for hiding this comment

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

description

what format will it be for its values, will it be more like integers 1,2,3 or also like az-01 etc? #Resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don’t specify zone formats in definitions for other resources either, so we’re using the same description used for NAT Gateway and Load Balancer.

Copy link
Member

Choose a reason for hiding this comment

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

this is a good opportunity to update those descriptions as well

Copy link
Contributor Author

@anjbal anjbal Dec 17, 2025

Choose a reason for hiding this comment

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

Updated description for zone for service gateway.

@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 16, 2025
@anjbal anjbal added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Dec 16, 2025
@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 17, 2025
@anjbal anjbal added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested labels Dec 17, 2025
@razvanbadea-msft razvanbadea-msft added Approved-Suppression ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Dec 18, 2025
@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 18, 2025
@anjbal anjbal merged commit ef68004 into release-microsoft-network-2025-05-01 Dec 18, 2025
38 of 40 checks passed
@anjbal anjbal deleted the users/anjbal/SGWChange2 branch December 18, 2025 21:43
kamboj-prjwl added a commit that referenced this pull request Jan 7, 2026
* Copy files from stable/2025-03-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2025-05-01

Updated the API version from stable/2025-03-01 to stable/2025-05-01.

* Added tag for 2025-05-01 in readme file

* Update Suppression and directives from previous verison

* Update version to stable 2025-05-01 (#39294)

Co-authored-by: Santosh Lokarapu <[email protected]>

* Service Gateway Swagger changes (#39221)

* Sgw change

* ModelFix

* Model issue fix

* Fix

* Model fix

* Fixed comment

* Updated description for zone

* Azure Firewall Policy: Add New IDPS Profiles (#36855)

* Update IDPS Profile names

* Add examples for IDPS profile

* Update Firewall Policy PUT example IDPS profile

* Update profile name and enum order

* Remove delete example

* Update profile names to emerging, extended and core

* Add Off as default profile

* Move changes to latest release

* Revert PUT example change on older version

* Move changes to release 2025-05-01

* Update examples release version

* Update profile order

* Update profiles description

* Add vna top level resource 2025-05-01 (#39341)

* Add a new top level resource for VNA

* add suppression for a known issue.

* add 1 more suppression due to known issue

* added x-ms-parameter-location as per go sdk team suggestion

* one more place to add for x-ms-parameter-location attribute

---------

Co-authored-by: Prajjwal Kamboj <[email protected]>

* Update the AppGW WAF spec with CAPTCHA action and Cookie expiary (#39362)

* update the spec with CAPTCHA action and cookies expiary

* whitespace issue

* Fix description for CAPTCHA cookie expiration

* Lint error fix (#39410)

* Lint error fix

* Response Change

---------

Co-authored-by: Prajjwal Kamboj <[email protected]>
Co-authored-by: santoshgh317 <[email protected]>
Co-authored-by: Santosh Lokarapu <[email protected]>
Co-authored-by: anjbal <[email protected]>
Co-authored-by: Saloni Rajeev Kumar <[email protected]>
Co-authored-by: Arjun Patel <[email protected]>
Co-authored-by: Yaniv Sagron <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. Network resource-manager SuppressionReviewRequired

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants