Skip to content

Conversation

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

Jingshu918 and others added 30 commits October 27, 2025 10:22
…37515)

* [DataFactory]Add Enable/Disable Interactive Query API Support

* fix

* fix

* fix

* fix

* fix
* enable new mpg csharp emitter for healthdataaiservices

* cleanup

* rename

* rename operation
* Added Search stable version documentation

* Update Search API to make 'select' parameter optional and include in README

* Add configuration for package-2025-05-01 in README

* Fix parameter naming and update descriptions in OpenAPI and TypeSpec models

* Remove Search API input file from package-2025-05-01 configuration in README

* Add TypeSpec options for C#, Java, TypeScript, Go, and Python

* Update emitter output directories in tspconfig.yaml for C#, Java, TypeScript, Go, and Python

* Update SelectParameter model to include default return fields and make 'select' optional

* Add configuration for multiple TypeSpec emitters in tspconfig.yaml

* Update emitter output directory for TypeSpec configurations to use a consistent path

* Fix emitter output directories for C# and TypeScript in tspconfig.yaml

* Refactor emitter output directories for C# and Java in tspconfig.yaml to use consistent namespace and module paths

* Update emitter output directory and module for Go in tspconfig.yaml

* fix: update Go emitter output directory and module path in tspconfig.yaml

* refactor: remove unused emitter configurations for Python, C#, TypeScript, and Java in tspconfig.yaml

* feat: add Azure benefit eligibility filter to OpenAPI definition

* feat: add emitter configurations for C#, Java, TypeScript, Go, and Python in tspconfig.yaml

* refactor: remove unused emitter configurations for C#, Java, TypeScript, Go, and Python in tspconfig.yaml

* feat: add missing emitter output directory suppressions for Java, TypeScript, Go, and C# in suppressions.yaml

* Remove unused dependency and update TypeSpec configuration for Python, C#, Java, and Go emitters

* Update Go module path in tspconfig.yaml for marketplace catalog

* Refactor SelectParameter documentation for clarity and consistency

* Update Go module path in tspconfig.yaml for search emitter

* Update Go module and package directory for search emitter in tspconfig.yaml

* Refactor suppressions.yaml to update emitter-output-dir options for TypeSpec validation

* Update tspconfig.yaml for Go module path and output directory; add 'azsearch' to cspell.yaml

* Update Go module path for azsearch in tspconfig.yaml

* Update emitter output directories and namespaces for C# and Java in tspconfig.yaml

* Refactor emitter output directories and namespaces for C# and Java in tspconfig.yaml

* Update emitter output directories and namespaces for C# and Java in tspconfig.yaml

* Fix formatting for C# typespec configuration in tspconfig.yaml

* Add service-name and package-name for C# typespec configuration in tspconfig.yaml

* Refactor C# typespec configuration in tspconfig.yaml to update emitter output directory and namespace

* Remove clear-output-folder option for C# typespec configuration in tspconfig.yaml

* Update C# typespec configuration for MarketplaceCatalog to correct emitter output directory and namespace

* Add emitter output directory for C# typespec configuration in tspconfig.yaml

* Fix duplicate flavor entry for C# typespec configuration in tspconfig.yaml

* Update C# typespec configuration for MarketplaceCatalog to correct emitter output directory and namespace
…pec (Azure#37169)

* convert containerregistry

* update

* update

* Update models.tsp

* Update models.tsp

* update

* update

* update operation list

* update

* update

* update

* update

* update

* update

* Update ArchiveVersion.tsp

* fix swagger model-validation:Object didn't pass validation for format arm-id: string

* Revert "fix swagger model-validation:Object didn't pass validation for format arm-id: string"

This reverts commit c9f738d.

* fix: Object didn't pass validation for format arm-id

* update

* update

* update

* update

* Update client.tsp

* java config

* update

* update

* support 2025-11-01

* Update models.tsp

* fix ci

* prettier fix

* fix model validation

* update

* java config

* go config

* fix python config

* add configuration for python

* Update client.tsp

* add clientname

* resolve comment

* update

* Update PrivateLinkResource.tsp

---------

Co-authored-by: xiaofeicao <[email protected]>
Co-authored-by: Weidong Xu <[email protected]>
Co-authored-by: Chenjie Shi <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
Co-authored-by: Judy Liu <[email protected]>
Co-authored-by: Pan Shao <[email protected]>
* Add new code owner for web specification

Adding Joseph Cawthorne as a code owner to have SME redudancy

* Add @1tariq as code owner for web specifications
* removing remoteRendering from the MixedReality api spec

* typo

* prettier

* removing MixedReality namespace api specs

---------

Co-authored-by: jagohr <[email protected]>
- More likely to be installed if file is copied to another repo
* Removed eslint

* Removed lint settings in pipeline

* Removed eslint config
* changed enabled field in originCapacityResource to enum

* fixed example files

---------

Co-authored-by: Anh Nguyen <[email protected]>
…le/2025-09-01 (Azure#38069)

* Adds base for updating Microsoft.ContainerService/aks from version stable/2025-08-01 to version 2025-09-01

* Updates readme

* Updates API version in new specs and examples

* Add Managed Namespace API to 2025-09-01 (Azure#38021)

* Add Managed Namespace API to 2025-09-01

* Update summary according to the GA api doc

* run prettier

* remove outdated examples for maintenance config (Azure#38026)

Co-authored-by: juanbe <[email protected]>

* [LocalDNS GA] Add localDNS config to agent pool profile (Azure#38025)

* add local dns config to agent pool profile

* run prettier on file

* run prettier on managed cluster example

---------

Co-authored-by: juanbe <[email protected]>

* Added Kata API for 2025-09-01 (Azure#38064)

* Added kata example and api.

* Removed preview wording.

* Resolve Review Comments for Microsoft.ContainerService/aks to add version stable/2025-09-01 (Azure#38092)

* sort ossku

* normalize casing of eTag

* Add Istio egress GA to 2025-09-01 (Azure#38161)

* Add Istio egress GA

Signed-off-by: nshankar <[email protected]>

* Fix style

Signed-off-by: nshankar <[email protected]>

* Update example

Signed-off-by: nshankar <[email protected]>

* Fix example

Signed-off-by: nshankar <[email protected]>

---------

Signed-off-by: nshankar <[email protected]>

---------

Signed-off-by: nshankar <[email protected]>
Co-authored-by: Yiran Li <[email protected]>
Co-authored-by: Juan Diego Bencardino <[email protected]>
Co-authored-by: juanbe <[email protected]>
Co-authored-by: Martin Heberling <[email protected]>
Co-authored-by: Niranjan Shankar <[email protected]>
Co-authored-by: Judy Liu <[email protected]>
* resolve breaking

* update config
* parameter ordering for java

* format
* after being converted

* tsp optimized and compiled into swagger

* removed too early tsp rename and type fix

* Update readme.md

* fix page

* Update tspconfig.yaml

* Update tspconfig.yaml

* update

* update

* update

* Update tspconfig.yaml

* Update specification/healthbot/Healthbot.Management/tspconfig.yaml

* Update specification/healthbot/Healthbot.Management/tspconfig.yaml

* prettier

* Update tspconfig.yaml

* prettier exmaples

* Delete diff.json

* Update models.tsp

* Update tspconfig.yaml

* Update back-compatible.tsp

* Update main.tsp

* update

* Update healthbot.json

* resolve breaking change

* resolve breaking change with client.tsp

* FIXME update

* example files

* update

* recoery of previous api version

* fix for model validation

* Update specification/healthbot/Healthbot.Management/tspconfig.yaml

* Update specification/healthbot/Healthbot.Management/tspconfig.yaml

* update

* update ErrorError

* prettier

* update

* remove csharp emmiter

* Rename Healthbot.Management to HealthBot.Management

All files in the specification/healthbot/Healthbot.Management directory were renamed to specification/healthbot/HealthBot.Management to standardize the casing of the directory name.

* fix for comment

* remove private things

* fix final-stat-via

* update

* update new config for golang

* Update main.tsp

* rename ErrorError to ErrorDetail

* Update client.tsp

* update

* Remove unused dependency annotations from Versions enum

Removed unused dependency annotations for API version.

* Update emitter output directories in tspconfig.yaml

---------

Co-authored-by: Pan Shao <[email protected]>
Co-authored-by: Mary Gao <[email protected]>
Co-authored-by: JiaqiZhang-Dev <[email protected]>
Co-authored-by: Jiao Di (MSFT) <[email protected]>
Co-authored-by: Weidong Xu <[email protected]>
Co-authored-by: Pan Shao <[email protected]>
…10 02 preview (Azure#37998)

* 2025-10-02-preview

* fix readme

* fix returnJupyterFormatExecutionResult

* Add more shell properties

* fix

* update doc

* fix unused usedependency

* fix formating

* fix doc

* test

* test

* test

* test

* make optional

* make optional fix

* fix examples

* fix doc
* converted

* compile successfully

* update

* fix for swagger validation: GlobalRulestack_List_MaximumSet_Gen

* update

* update

* update

* fix for 404

* prettier

* supress warning

* update

* Update tspconfig.yaml

* Update tspconfig.yaml

* justification and recovery of opeartionid

* Update models.tsp

* update

* update

* update

* Update tspconfig.yaml

* Update tspconfig.yaml

* fix

* fix go config

* unblock java automation

* Apply TypeSpec migration compatibility fixes

- Fixed model name compatibility: IPAddress->IpAddress, IPAddressSpace->IpAddressSpace, DNSSettings->DnsSettings, DNSProxy->DnsProxy, EnabledDNSType->EnabledDnsType
- Updated service name configuration for manager consistency
- Removed invalid version dependencies from main.tsp

* Update tspconfig.yaml

* change go ns

* fix rename breaking for python

* Update PaloAltoNetworks configuration for SDK

* Remove emitter-output-dir from tspconfig.yaml

Removed emitter-output-dir from configuration.

* Add typespec-title-map for CloudngfwClient

* Modify emitter output directory in tspconfig.yaml

Update emitter output directory for Azure tools.

* swagger recovery of version v2025_07_07_preview

* update version to 2025-10-08

* Update cspell.yaml

* Update cspell.yaml

* Revert "Update cspell.yaml"

This reverts commit 5572817.

* Update cspell.yaml

* update: ArmDeletedNoContentResponse --> ArmNoContentResponse

---------

Co-authored-by: Chenjie Shi <[email protected]>
Co-authored-by: xiaofeicao <[email protected]>
Co-authored-by: Weidong Xu <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
Co-authored-by: Jiao Di (MSFT) <[email protected]>
Co-authored-by: Pan Shao <[email protected]>
* Copy files from preview/2025-02-02-preview

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

* Update version to preview/2025-10-02-preview

Updated the API version from preview/2025-02-02-preview to preview/2025-10-02-preview.

* Added tag for 2025-10-02-preview in readme file

* Add template update status for session pool (Azure#37083)

* Add template update status for session pool

* Prettier

* fix doc

* fix

* add example

* update config

* Add reason and message properties to job execution response (Azure#38225)

Adding high level reason and message in job execution response to provide better diagnostics and status information for job executions.

* Session pool MCP server settings (Azure#38206)

* Add MCP server

* Fix example

* prettier

* fix

* fix

* fix

* fix comment

* add mcpServerApiKeyDisabled

* fix

* prettier

* [Microsoft.App 2025-10-02-preview] Update ingress params (Azure#37907)

* Update ingress params

* Remove from samples

* Adding containerapp functions apis (Azure#38018)

* Adding containerapp functions apis

* Update types.json reference

Signed-off-by: Shivam Kumar <[email protected]>

* Update types.json reference

Signed-off-by: Shivam Kumar <[email protected]>

---------

Signed-off-by: Shivam Kumar <[email protected]>
Co-authored-by: Shivam Kumar <[email protected]>

* fix breaking changes

* Update schema for DaprComponent

* fix breaking cahnges kind, error, billing meter

* remove examples

* fix examples

* fix breaking changes httproute

* fix error response in container app

* fix http route

* fix error response

---------

Signed-off-by: Shivam Kumar <[email protected]>
Co-authored-by: Yitao Pan <[email protected]>
Co-authored-by: bhanuprakash-1 <[email protected]>
Co-authored-by: Chris Ross <[email protected]>
Co-authored-by: Shivam Kumar <[email protected]>
Co-authored-by: Shivam Kumar <[email protected]>
Co-authored-by: Layla Liu <[email protected]>
mikeharder and others added 16 commits November 18, 2025 21:27
…e#38560)

* Handle SmartDetectorAlertRulesApi

* Handle AlertProcessingRules and PrometheusRuleGroup

* More services

* Finish all the rest

* Fixes

* Add missing example

* Move AlertRules to AlertProcessingRules

* Undelete missing files

* Delete redundant readme file

* APR - round 1

* APR - fix

* Fix ```

* SmartDetectorAlertRules readmes

* PrometheusRuleGroups and SmartGroups

* Fix in PrometheusRuleGroups

* AlertRuleRecommendations

* Issue

* Issues - fix

* MigrateFromSmartDetections

* PreviewAlertRule

* TenantActivityLogAlerts

* AlertsManagement - cleanup

* Fixes after cleanup

* Add suppressions to various LintDiff errors

* More suppressions for LintDiff

* Move to legacy

* Adjust "legacy" folder

* Add missing tags under legacy

* Suppress old private preview version

* Add typespec requirement suppressions

---------

Co-authored-by: Liad Tal <[email protected]>
…impact (Azure#38886)

* build(deps): bump glob in /eng/tools/summarize-impact

Bumps [glob](https://github.com/isaacs/node-glob) from 12.0.0 to 13.0.0.
- [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md)
- [Commits](isaacs/node-glob@v12.0.0...v13.0.0)

---
updated-dependencies:
- dependency-name: glob
  dependency-version: 13.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* npm i

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mike Harder <[email protected]>
* Updated address object property descriptions.

* Updated address object property descriptions.

* Updated address object property descriptions.
* Initial commit of Content Understanding 2025-11-01 GA

* Migrate the client SDK changes from azure-rest-api-specs-pr (Azure#38839)

* MIGRATE SDK changes from azure-rest-api-specs-pr:

- Updated ContentUnderstandingClient interface to flatten operations and enhance naming conventions.
- Renamed ContentAnalyzer's status field to ResourceStatus for better clarity.
- Introduced StringEncoding union for encoding formats in AnalyzeParameters.
- Adjusted tspconfig.yaml to enable Java support and ensure proper emission of client libraries.

* PYTHON-SDK-FEEDBACK:
Add fieldType and inputRange renaming for clarity in ContentUnderstandingClient

* SDK-PYTHON: Hide string_encoding parameter in Python SDK and clarify string indexing behavior

* Move operation renames into interface definition

* PR Comments:
- Comment out emitters in emit to avoid dependency in this repo
- Move internal def of getRestul and getOperationStatus to client.tsp
- Merge operation rename in interface
- rename createAnalyzer

* Fix incorrect name in listAnalyzers renaming for .NET

* Fix typo in deleteAnalyzer method name in ContentUnderstandingClient interface

* Remove preview versions.  Add examples.

* Fix PR checks

* Fix example title in ContentAnalyzers_DeleteResult.json (Azure#38877)

* Initial plan

* Fix example title: Change "Delete Analyzer" to "Delete Analysis Result"

Co-authored-by: bojunehsu <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: bojunehsu <[email protected]>

* Address review feedbacks.

---------

Co-authored-by: Yung-Shin Lin <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: bojunehsu <[email protected]>
* add publicNetworkAccess to SitePatchResource

* make enum

* prettier

* fix enum

* use string

* update owners
@github-actions
Copy link

github-actions bot commented Nov 21, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR modified the suppressions for Go SDK breaking changes (label: BreakingChange-Go-Sdk-Suppression). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR modified the suppressions for JavaScript SDK breaking changes (label: BreakingChange-JavaScript-Sdk-Suppression). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR modified the suppressions for Python SDK breaking changes (label: BreakingChange-Python-Sdk-Suppression). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR modified the suppressions for Python track-2 SDK breaking changes (label: BreakingChange-Python-Sdk-Suppression). Refer to step 3 in the PR workflow diagram.
  • ❌ The required check named Summarize PR Impact has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:
  • ⚠️ The check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide


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

Projects

None yet

Development

Successfully merging this pull request may close these issues.