Skip to content

Conversation

@savaradh
Copy link
Member

@savaradh savaradh commented Mar 4, 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.

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 4, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Mar 4, 2025

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

@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 Mar 4, 2025
@azure-sdk
Copy link
Collaborator

azure-sdk commented Mar 4, 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

@joshbaunach
Copy link
Contributor

All of the MISSING_APIS_IN_DEFAULT_TAG errors in the Swagger Avocado check (CI link) are false positives.

The API paths below are not supported anymore. The most recent stable API version that supported these paths is 2017-10-01, and all stable versions after that (including the most recent stable version 2023-07-01) do not support those paths.

  • subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/listpolicies
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/updatepolicies

The API paths listed below are still in preview and are not ready to be introduced to a stable API version:

  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/exportpipelines
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/importpipelines/{}
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/importpipelines
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/importpipelines/{}
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/pipelineruns
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/pipelineruns/{}

The API paths listed below are deprecated, and we have no plans to introduce them into a stable API version:

  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/packages/{}/archives
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/packages/{}/archives/{}
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/packages/{}/archives/{}/versions
  • /subscriptions/{}/resourcegroups/{}/providers/microsoft.containerregistry/registries/{}/packages/{}/archives/{}/versions/{}

These Swagger Avocado false positives are similar to the ones our team encountered when we released our most recent stable version, 2023-07-01. Link to comment

@rkmanda rkmanda added Approved-Avocado ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Mar 9, 2025
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 9, 2025
@joshbaunach
Copy link
Contributor

joshbaunach commented Mar 10, 2025

@msyyc @rkmanda @tadelesh Can one of you add the PublishToCustomers label to this PR? @savaradh is OOF right now, and I'm unable to add the label myself

Edit: Nevermind; I got the permissions needed to add the label myself

@joshbaunach joshbaunach added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Mar 10, 2025
@joshbaunach
Copy link
Contributor

Thanks for the +1 @AntonioVT

I'm going to hold off on merging this PR until the RP release is finished and the new manifest has been applied.

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Mar 31, 2025
@joshbaunach joshbaunach removed the no-recent-activity There has been no recent activity on this issue. label Mar 31, 2025
Copy link
Member

@msyyc msyyc left a comment

Choose a reason for hiding this comment

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

Approved for Python.

@joshbaunach joshbaunach merged commit 107def4 into Azure:main Apr 16, 2025
36 of 46 checks passed
@joshbaunach joshbaunach deleted the savaradh-containerregistry-Microsoft.ContainerRegistry-2025-04-01 branch April 16, 2025 03:34
danieljurek pushed a commit that referenced this pull request Apr 17, 2025
…32969)

* Copy files from stable/2023-07-01

* Update version to stable/2025-04-01

* Added tag for 2025-04-01 in readme file

* add new path and properties to the 2025-04-01 version along with examples

* Add missing apis to default tag

* revert readme changes

* Remove bad line

* remove all legacy lines from go readme

---------

Co-authored-by: Josh Baunach <[email protected]>
nwnt pushed a commit to nwnt/azure-rest-api-specs that referenced this pull request Jun 10, 2025
…zure#32969)

* Copy files from stable/2023-07-01

* Update version to stable/2025-04-01

* Added tag for 2025-04-01 in readme file

* add new path and properties to the 2025-04-01 version along with examples

* Add missing apis to default tag

* revert readme changes

* Remove bad line

* remove all legacy lines from go readme

---------

Co-authored-by: Josh Baunach <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Avocado ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. Container Registry new-api-version PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants