Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Microsoft.Resources/deployments stable API version 2025-03-01 #32822

Merged
merged 11 commits into from
Apr 2, 2025

Conversation

kalbert312
Copy link
Member

@kalbert312 kalbert312 commented Feb 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:
    • 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.

Copy link

openapi-pipeline-app bot commented Feb 25, 2025

Next Steps to Merge

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

Copy link

openapi-pipeline-app bot commented Feb 25, 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 Feb 25, 2025
@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 25, 2025

API change check

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

Microsoft.Authorization

This was referenced Feb 25, 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 24, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Mar 25, 2025
@kalbert312 kalbert312 force-pushed the kylea/deployments-next branch from 5c224c8 to 25a8935 Compare March 25, 2025 15:07
@kalbert312
Copy link
Member Author

kalbert312 commented Mar 25, 2025

@ramoka178 or next ARM reviewer, I requested some guidance on how to resolve this via the API spec review channel (https://teams.microsoft.com/l/message/19:[email protected]/1742917076477?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1742917076477&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1742917076477) and @mikeharder said that I should request the Approved-Avocado tag with a link to this issue Azure/avocado#152 that describes some issues with the MULTIPLE_DEFAULT_TAGS error.

If this error cannot be excepted, I'm not certain how to resolve it. There's a bunch of other resource types I have no familiarity with, and I do not understand what side effects some config changes have.
Is the entire section with tag: declarations based on CLI switch (yaml $(switch-name)) deleteable? I don't know how the SDK team runs the autorest command. It looks like this specification uses an older directory structure. Would updating that potentially resolve this?

I made some changes to the README.md, including deleting multiple tag declarations for package-resources flag and removing the package-2022-12 as the default tag to requiring a new switch package-2022-12, but I still get the error.

@kalbert312 kalbert312 added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Mar 25, 2025
@ramoka178 ramoka178 added Approved-Avocado ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Mar 25, 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 25, 2025
@kalbert312 kalbert312 enabled auto-merge (squash) March 25, 2025 19:12
@mikeharder
Copy link
Member

@ramoka178 or next ARM reviewer, I requested some guidance on how to resolve this via the API spec review channel (https://teams.microsoft.com/l/message/19:[email protected]/1742917076477?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1742917076477&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1742917076477) and @mikeharder said that I should request the Approved-Avocado tag with a link to this issue Azure/avocado#152 that describes some issues with the MULTIPLE_DEFAULT_TAGS error.

If this error cannot be excepted, I'm not certain how to resolve it. There's a bunch of other resource types I have no familiarity with, and I do not understand what side effects some config changes have. Is the entire section with tag: declarations based on CLI switch (yaml $(switch-name)) deleteable? I don't know how the SDK team runs the autorest command. It looks like this specification uses an older directory structure. Would updating that potentially resolve this?

I made some changes to the README.md, including deleting multiple tag declarations for package-resources flag and removing the package-2022-12 as the default tag to requiring a new switch package-2022-12, but I still get the error.

Adding Approved-Avocado for this one PR is OK, but going forward you will need to change your readme.md (assuming the Avocado rule is correct).

There's a bunch of other resource types I have no familiarity with, and I do not understand what side effects some config changes have.

Do you know who owns the other resource types? Is there an owner for the readme.md as a whole, that includes all the resource types?

Our first question is "why do you need multiple default tags like this?".

@kalbert312
Copy link
Member Author

kalbert312 commented Mar 25, 2025

Do you know who owns the other resource types? Is there an owner for the readme.md as a whole, that includes all the resource types?

No. My team owns resource types deployments, deploymentStacks, deploymentScripts, bicepClient, templateSpecs. We don't own subscriptions, changes, dataBoundaries, links, or snapshots. So it's a mix of owners which makes this a little more difficult.

Our first question is "why do you need multiple default tags like this?".

I don't know. It seems like all the tag: declarations could be deleted, but I'm not sure how the automation works or SDK releases are run. I imagine they would pass the --tag=package-resources-2025-03 argument when I go to submit an SDK release request, which would scope the code gen down to that. Is a default tag necessary? It feels like it doesn't make sense for this ownership scenario.

@mikeharder
Copy link
Member

Do you know who owns the other resource types? Is there an owner for the readme.md as a whole, that includes all the resource types?

No. My team owns resource types deployments, deploymentStacks, deploymentScripts, bicepClient, templateSpecs. We don't own subscriptions, changes, dataBoundaries, links, or snapshots. So it's a mix of owners which makes this a little more difficult.

Is there someone else on your team responsible for the readme as a whole? Should we work on this with just you, or others on your team?

@kalbert312
Copy link
Member Author

Is there someone else on your team responsible for the readme as a whole? Should we work on this with just you, or others on your team?

There's no official owner but @anthony-c-martin said he can fill for one.

@kalbert312
Copy link
Member Author

@msyyc It looks like merging is blocked until you approve.

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.

Approve for Python SDK part.

@kalbert312 kalbert312 merged commit c33093d into Azure:main Apr 2, 2025
30 of 31 checks passed
@kalbert312 kalbert312 deleted the kylea/deployments-next branch April 2, 2025 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-Avocado Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Go-Sdk BreakingChange-Go-Sdk-Approved BreakingChange-JavaScript-Sdk BreakingChange-JavaScript-Sdk-Approved 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 SuppressionReviewRequired
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants