Skip to content

Conversation

wenjlu-lgy
Copy link
Contributor

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.

Copy link

github-actions bot commented Sep 17, 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 new-api-version resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 17, 2025
Copy link

github-actions bot commented Sep 17, 2025

API Change Check

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

Language API Review for Package
Swagger Microsoft.HybridContainerService
Go sdk/resourcemanager/hybridcontainerservice/armhybridcontainerservice
Java com.azure.resourcemanager:azure-resourcemanager-hybridcontainerservice
JavaScript @azure/arm-hybridcontainerservice

@wenjlu-lgy wenjlu-lgy force-pushed the private/wenjlu/2502api branch from 0f1c166 to e02536e Compare September 17, 2025 08:17
@sarathys sarathys self-assigned this Sep 17, 2025
@gary-x-li
Copy link
Contributor

The first commit needs to be an exact copy of the previous api version. All new changes should only be added in the subsequent commits. This is explained in detail here - https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs?tabs=openapi

Please add your base commit in a new commit (make sure the commit message is clear) and another commit to revert that commit (so that your latest commit always reflects the latest code).

@gary-x-li gary-x-li added ARMChangesRequested and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 22, 2025
@github-actions github-actions bot removed brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. ARMChangesRequested resource-manager new-api-version ARMReview RPaaS labels Sep 23, 2025
Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2024-01-01 to preview/2025-02-01-preview.
@github-actions github-actions bot added brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. ARMReview labels Sep 23, 2025
@github-actions github-actions bot added new-api-version resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 23, 2025
@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 Sep 24, 2025
@wenjlu-lgy wenjlu-lgy added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Sep 25, 2025
@wenjlu-lgy wenjlu-lgy merged commit 2f99fc0 into main Sep 25, 2025
50 checks passed
@wenjlu-lgy wenjlu-lgy deleted the private/wenjlu/2502api branch September 25, 2025 02:24
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 brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager RPaaS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants