Skip to content

Conversation

@v-thepet
Copy link
Contributor

@v-thepet v-thepet commented Jan 15, 2026

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:
    • This PR contains fixes to 1 broken link in 3 files.
      For request details, see 540734

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.

@github-actions
Copy link

github-actions bot commented Jan 15, 2026

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 has ARMChangesRequested label. Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    Automation should then add WaitForARMFeedback label.
    ❗If you don't have permissions to remove the label, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ The required check named Swagger Avocado has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide


Comment generated by summarize-checks workflow run.

@github-actions
Copy link

github-actions bot commented Jan 15, 2026

API Change Check

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

Language API Review for Package
Swagger Microsoft.Compute
TypeSpec Microsoft.Compute
Go sdk/resourcemanager/compute/armcompute
Java com.azure.resourcemanager:azure-resourcemanager-compute-generated
JavaScript @azure/arm-compute
Python azure-mgmt-compute

@v-thepet v-thepet added PublishToCustomers Acknowledgement the changes will be published to Azure customers. Approved-Avocado labels Jan 15, 2026
@v-thepet v-thepet closed this Jan 15, 2026
@v-thepet v-thepet reopened this Jan 15, 2026
@v-thepet
Copy link
Contributor Author

Hi @audreyttt @haagha @ookoka - After consultation with the SDK API Spec Review team I closed PR #39567 that tried to fix links in all the versions of the compute spec. I'll no longer try to fix broken links in previous versions. I intended this current PR to only fix one broken link, in the latest (TypeSpec) version. I applied the Approved-Avocado label because I thought this was a regular exception for the compute spec. However, the label doesn't seem to prevent getting the Swagger Avocado MULTIPLE_API_VERSION error as it was intended to do. Do you have any ideas? Thanks!

@v-thepet v-thepet marked this pull request as ready for review January 16, 2026 01:13
@v-thepet
Copy link
Contributor Author

The Approved-Avocado label doesn't seem to be working to prevent the Swagger Avocado MULTIPLE_API_VERSION error as described at https://github.com/Azure/azure-rest-api-specs/wiki/Uniform-Versioning-Violation-Guide#one-time-suppression.

@github-actions github-actions bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 16, 2026
@mentat9
Copy link
Member

mentat9 commented Jan 16, 2026

The Approved-Avocado label doesn't seem to be working to prevent the Swagger Avocado MULTIPLE_API_VERSION error as described at https://github.com/Azure/azure-rest-api-specs/wiki/Uniform-Versioning-Violation-Guide#one-time-suppression.

@v-thepet - That override flag should only be set by reviewers (I've removed it). It looks like it just changes the Avocado check to optional instead of required, so the check is expected to still fail.
@mikeharder, @suhasaraos - Can you check whether this is a suitable case for overriding Avocado check of uniform versioning?

@v-thepet
Copy link
Contributor Author

@mentat, @mikeharder, @suhasaraos - I applied that label to see if the PR would then succeed, because that label was applied by @audreyttt codeowner to the last PR #39567 that I closed because it targeted old versions. Audrey informed me "The Swagger Avocado error is a known issue we have for the Compute API that we currently have an exception for. I just added the Approved-Avocado tag, please let me know if you haves any other questions." So figuring that this PR would also be eligible for the label, I tried applying it. Even with the label applied, codeowner review and approval is required to merge the PR, which I would still need to obtain. However, the fact that the check is still broken might mean that no broken links can be fixed in compute, even in latest version.

@mentat9
Copy link
Member

mentat9 commented Jan 16, 2026

@mentat, @mikeharder, @suhasaraos - I applied that label to see if the PR would then succeed, because that label was applied by @audreyttt codeowner to the last PR #39567 that I closed because it targeted old versions. Audrey informed me "The Swagger Avocado error is a known issue we have for the Compute API that we currently have an exception for. I just added the Approved-Avocado tag, please let me know if you haves any other questions." So figuring that this PR would also be eligible for the label, I tried applying it. Even with the label applied, codeowner review and approval is required to merge the PR, which I would still need to obtain. However, the fact that the check is still broken might mean that no broken links can be fixed in compute, even in latest version.

@v-thepet - It looks like you still have the link update in two API versions (2024-11-01 and 2025-04-01), which I think accounts for the continued Avocado failure.

@github-actions github-actions bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMChangesRequested ARMReview Compute PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager TypeSpec Authored with TypeSpec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants