Skip to content

Conversation

@solankisamir
Copy link
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.

catalinaperalta and others added 30 commits October 22, 2025 09:28
Co-authored-by: catalinaperalta <caperal@microsoft.com>
Co-authored-by: catalinaperalta <caperal@microsoft.com>
* Change logging functions to use Write-Host

Change logging helpers to always write to host and either set color or use devops/gh formatting.

We do not want to use Write-Error or Write-Warning directly because they can stop the script or not depending on preferences which makes it difficult to ensure local runs of scripts work the same as in the pipelines. So, we should never depend on these logging commands to cause a script to stop execution.

* Clean up error handling in CommandInvocation-Helpers

Removed legacy error handling for command failures.

* Fix error logging for command execution

* Add option to skip exiting

---------

Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com>
Co-authored-by: Wes Haggard <Wes.Haggard@microsoft.com>
* Enable dataPlane for azure-sdk-for-java and azure-sdk-for-js

* Change isSpecGenSdkCheckRequired to true

* Fix expected result for azure-sdk-for-js test

Update expected result for JS SDK setting check.
* added 2025-11-15preview, removed 2025-05-15preview and 2024-11-15preview

* added new types to pii categories

* added docorator for 20251115preview and compile

* updated the examples for 2025-11-15preview

* added 2025-11-15-preview in readme

* added IBAN to scpell.yaml

* removed all older preview

* fix typespec validation

* update enum names

* fix spellcheck

* fix typespec validation

* updated readme

* fix typo

---------

Co-authored-by: Bidisha Chakraborty <29803402+bidisha-c@users.noreply.github.com>
Co-authored-by: Summer Warren <summerwarren@microsoft.com>
Co-authored-by: Summer Warren <summerwarren@microsoft.com>
…ure-sdk-tools repo are unnecessary - Unnecessary checkout hurts perf and increases security footprint (#38362)

Co-authored-by: Mike Harder <mharder@microsoft.com>
Co-authored-by: catalinaperalta <caperal@microsoft.com>
* mitigate breakings

* Update client.tsp

* Update client.tsp
* refactor the folder structure

* gix js sdk validation ci error

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
…#37112)

* refactor the folder structure

* fix semantic error

* fix validation error

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* Refactor migrateprojects folder structure to comply with Azure Guidelines

* Removed files readme.go.md, and go swagger-to-sdk section in readme.md
…elines (#37652)

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
#37653)

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* Refactor maps folder structure to comply with Azure Guidelines

* Resolve conflicts
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* refactor the folder structure

* fix go sdk ci error

* remove invalid info

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* Refactor redhatopenshift folder structure to comply with Azure Guidelines

* Rename folder openshiftclusters to OpenShiftClusters (case change)

* Update suppressions.yaml
…37505)

* refactor the folder structure

* refactor the folder structure

* remove data plane

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
* refactor the folder structure

* resolve conflict

---------

Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
azure-sdk and others added 17 commits November 12, 2025 13:27
* Allow forced creation when release plans already exist

* Update creation instructions

* fix small markdown issues

* Update creation steps

---------

Co-authored-by: Summer Warren <summerwarren@microsoft.com>
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2024-10-01-preview to preview/2025-03-01-preview.
…SSL certificate (#37047)

* hostname refresh

* fix prettier error

* fix uuid

* revert breaking change
…s for load balancer (#36818)

* feat(apim): Make url/protocol optional in Backend and provide examples for load balancer

* Extend example

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

* Remove empty required section

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

* Fix samples

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

* Update description

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

* Add simple LB example

---------

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
* Add hostname bindings endpoints

* fixes

* Rename keyVaultUrl to keyVault

* update

* Remove optiona

* update

* Add pattern

* Update pattern
…d resource (#36737)

* feat(apim): Introduce azureRegion in Backend resource

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

* feat(apim): Introduce preferredCarbonEmission in Backend resource

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

* feat(apim): Introduce preferredCarbonEmission in Backend resource

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

* Fix misspelling

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

* Fix sample

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

* Fix sample

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

* Prettier

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

* Fix sample

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

* Fix invalid sample

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

* Fix invalid sample

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

* Url and protocol are no longer required

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

* Revert "Url and protocol are no longer required"

This reverts commit 8b3b7d4.

* Fix LB sample

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

* preferredCarbonEmission is not read-only

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

---------

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
* fix the modifications

* add examples

* run prettier

* md 1

* corerct exampels
* Added APIM spec changes for mcp tools api

* Fix for ToolContract definition not found

* Fix prettier
* New ZoneRedundant Property

* Revert other change in apimdeployment

* Change to Enum instead of bool

* Change description

* Remove the default value
* Change ZoneRedundant property to nullable bool

* add nullable true

* prettier

* Remove nullable
Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
…refresh secret support for CM and added examples (#37231)

* added definitions for key vault and refresh secret support for CM and added examples

* fixed apimauthorizationproviders.json

* fixed prettier issues

* fixed model validation issues

* fix kv contract ref

* fix remaining model validation issue

* fixing lint diff errors

* addressed PR comments

* fixed remaining v6 reference

* reverted changes to authorization code grant type with key vaults and added keyvault to grant type

* fixed to move key vault out of grant types into oauth2settings

---------

Co-authored-by: Ji Hoon Kim <kimjihoon@microsoft.com>
@github-actions
Copy link

github-actions bot commented Nov 12, 2025

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2025-03-01-preview API Management 2025-03-01-preview

Projects

None yet

Development

Successfully merging this pull request may close these issues.