Skip to content

Conversation

@lizMSFT
Copy link
Member

@lizMSFT lizMSFT commented Sep 25, 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:
    • ContainerReigstry in the middle of the Typespec migration, and the corresponding PR is still in progress. This new version is for feature GA and will be covered as part of the initial Typespec migration.

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.

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/2025-04-01 to stable/2025-11-01.
@github-actions
Copy link

github-actions bot commented Sep 25, 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.

@lizMSFT lizMSFT changed the title Release containerregistry microsoft.container registry/2025 11 01 Release containerregistry microsoft.container registry/2025-11-01 Sep 25, 2025
@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 WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 25, 2025
@github-actions
Copy link

github-actions bot commented Sep 25, 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.ContainerRegistry-Registry
Go sdk/resourcemanager/containerregistry/armcontainerregistry
Java com.azure.resourcemanager:azure-resourcemanager-containerregistryregistry
JavaScript @azure/arm-containerregistry

@lizMSFT
Copy link
Member Author

lizMSFT commented Sep 26, 2025

Avocado CI false positive, CI results here, this is due to the same reason mentioned in the PR 24771

I noticed two issues in the Avocado CI that are being marked as errors, however I don't think this is accurate. The errors are "MISSING_APIS_IN_DEFAULT_TAG".

In Summary, the errors are related to paths that are not supported in this stable version because we either have stopped supporting those paths long time ago, or they are preview feature paths.

The API path "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerRegistry/registries/{}/listPolicies" and ".../updatePolicies" is no longer supported.

The last stable API version that supports it is 2017-10-01. The next GA version is 2019-05-01 and doesn't include that path anymore. The last stable version is 2022-12-01 and it also doesn't include the paths mentioned.
The API path "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ContainerRegistry/registries/{}/exportPipeline*", "importPipeline*", "pipelineRuns*", etc are PREVIEW path operations.

These features are not ready to be in stable version. These errors are being flagged from the 2023-06-01-preview version. This comparison should be done with another preview version, but not with the current stable version.

@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 26, 2025
@lizMSFT
Copy link
Member Author

lizMSFT commented Sep 26, 2025

The breaking changes are expected as we are in the middle of typespec migration. This PR separated Swagger files under resource-manager between ContainerRegistry and ContainerRegistryTasks for unified structure and separate API references.

@github-actions github-actions bot removed the brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. label Oct 14, 2025
@lizMSFT lizMSFT added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 14, 2025
Copy link
Member

@northtyphoon northtyphoon left a comment

Choose a reason for hiding this comment

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

LGTM

@northtyphoon northtyphoon merged commit 902eaed into Azure:main Oct 14, 2025
39 of 41 checks passed
pmoana-ms pushed a commit that referenced this pull request Oct 23, 2025
…7748)

* Copy files from stable/2025-04-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-11-01

Updated the API version from stable/2025-04-01 to stable/2025-11-01.

* update GA feature

* use "myregistry.azurecr.io"

* fix typo

---------

Co-authored-by: Bin Du <2686301+northtyphoon@users.noreply.github.com>
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.

6 participants