Skip to content

Conversation

@yitaopan
Copy link
Member

@yitaopan yitaopan commented Sep 2, 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:
    • 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.

@yitaopan yitaopan requested a review from Juliehzl as a code owner September 2, 2025 08:42
@github-actions
Copy link

github-actions bot commented Sep 2, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
    To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review


Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Sep 2, 2025
@github-actions
Copy link

github-actions bot commented Sep 2, 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/appcontainers/armappcontainers
Java com.azure.resourcemanager:azure-resourcemanager-appcontainers
JavaScript @azure/arm-appcontainers

"$ref": "#/definitions/TemplateStatus"
}
},
"additionalProperties": false
Copy link
Contributor

Choose a reason for hiding this comment

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

why add this one?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks, removed, this should not be needed.

}
],
"templateUpdateStatus": {
"activeTemplate": {
Copy link
Contributor

Choose a reason for hiding this comment

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

can you also add desiredTemplate in example?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, a new example added

@Juliehzl Juliehzl added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 4, 2025
@yitaopan yitaopan merged commit 257c715 into Azure:release-app-Microsoft.App-preview/2025-10-02-preview Sep 4, 2025
46 of 54 checks passed
Juliehzl pushed a commit that referenced this pull request Oct 9, 2025
* Add template update status for session pool

* Prettier

* fix doc

* fix

* add example
Juliehzl pushed a commit to Juliehzl/azure-rest-api-specs that referenced this pull request Oct 9, 2025
* Add template update status for session pool

* Prettier

* fix doc

* fix

* add example
Juliehzl pushed a commit that referenced this pull request Oct 24, 2025
* Add template update status for session pool

* Prettier

* fix doc

* fix

* add example
Juliehzl added a commit that referenced this pull request Oct 29, 2025
* 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 (#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 (#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 (#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 (#37907)

* Update ingress params

* Remove from samples

* Adding containerapp functions apis (#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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants