Skip to content

Comments

migrate to LRO APIs for vmware#34243

Merged
cataggar merged 12 commits intoAzure:release-vmware-Microsoft.AVS/2024-09-01from
cataggar:PatchWithResponse
Apr 29, 2025
Merged

migrate to LRO APIs for vmware#34243
cataggar merged 12 commits intoAzure:release-vmware-Microsoft.AVS/2024-09-01from
cataggar:PatchWithResponse

Conversation

@cataggar
Copy link
Member

@cataggar cataggar commented Apr 25, 2025

This is for:

It removes all usage of x-ms-long-running-operation in the TypeSpec. The resulting OpenAPI is the same. Specifically, it addresses #32946 (comment).

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 25, 2025

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 is awaiting ARM reviewer feedback (label: WaitForARMFeedback).
    To learn when this PR will get reviewed, see ARM review queue at aka.ms/azsdk/pr-arm-review
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 25, 2025

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

@cataggar cataggar changed the title remove any @extension("x-ms-long-running-operation" for vmware migrate to LRO APIs for vmware Apr 25, 2025
@github-actions
Copy link

github-actions bot commented Apr 25, 2025

API Change Check

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

Language API Review for Package
TypeSpec Microsoft.AVS
Java com.azure.resourcemanager:azure-resourcemanager-avs
JavaScript @azure/arm-avs

@cataggar cataggar marked this pull request as ready for review April 25, 2025 10:57
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 25, 2025
@cataggar cataggar requested a review from markcowl April 25, 2025 18:39
@cataggar cataggar dismissed markcowl’s stale review April 26, 2025 11:10

Changes applied.

"x-ms-long-running-operation-options",
#{ `final-state-via`: "location" }
)
@armResourceDelete(WorkloadNetworkDnsService)

Choose a reason for hiding this comment

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

nit, delete as LRO seems to work as the response is

    | ArmDeletedResponse
    | ArmDeleteAcceptedLroResponse
    | ArmDeletedNoContentResponse
    | ErrorResponse;

Copy link
Member Author

Choose a reason for hiding this comment

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

@weidongxu-microsoft , I'm not sure what you mean.

Copy link
Member Author

Choose a reason for hiding this comment

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

As this is a nit, I'm going to merge the PR without this change, but I would still like to know in case it can improve our spec.

Copy link
Member

@weidongxu-microsoft weidongxu-microsoft left a comment

Choose a reason for hiding this comment

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

LGTM. Please wait for Mark's feedback as well. I am not the expert on templates on ARM.

@cataggar
Copy link
Member Author

I really need to get #32946 merged, so I am unable to wait more.

@cataggar cataggar merged commit 1b8c833 into Azure:release-vmware-Microsoft.AVS/2024-09-01 Apr 29, 2025
39 of 44 checks passed
@cataggar cataggar deleted the PatchWithResponse branch April 29, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview BreakingChange-Go-Sdk BreakingChange-JavaScript-Sdk BreakingChange-Python-Sdk resource-manager TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants