Skip to content

Conversation

@AzureMarker
Copy link
Member

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 Apr 8, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR targets either the main branch of the public specs repo or the RPSaaSMaster branch of the private specs repo. These branches are not intended for iterative development. Therefore, you must acknowledge you understand that after this PR is merged, the APIs are considered shipped to Azure customers. Any further attempts at in-place modifications to the APIs will be subject to Azure's versioning and breaking change policies. Additionally, for control plane APIs, you must acknowledge that you are following all the best practices documented by ARM at aka.ms/armapibestpractices. If you do intend to release the APIs to your customers by merging this PR, add the PublishToCustomers label to your PR in acknowledgement of the above. Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. 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. In addition, refer to step 4 in the PR workflow diagram

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 8, 2025

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

@AzureMarker AzureMarker changed the title Add new API version 2025-03-01-preview to Microsoft.ResourceConnector [Draft] Add new API version 2025-03-01-preview to Microsoft.ResourceConnector Apr 8, 2025
@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 Apr 8, 2025
@github-actions
Copy link

github-actions bot commented Apr 8, 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.ResourceConnector
JavaScript @azure/arm-resourceconnector
Python azure-mgmt-resourceconnector
Java com.azure.resourcemanager:azure-resourcemanager-resourceconnector
Go sdk/resourcemanager/resourceconnector/armresourceconnector

@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from 7faef92 to 97dcfc4 Compare April 9, 2025 19:01
@AzureRestAPISpecReview AzureRestAPISpecReview added the VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required label Apr 9, 2025
@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from cfb4bb0 to 94cc352 Compare April 9, 2025 23:34
@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from 94cc352 to 57036b1 Compare June 11, 2025 16:57
@openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from 57036b1 to dbcc577 Compare June 11, 2025 17:42
@AzureRestAPISpecReview AzureRestAPISpecReview removed the VersioningReviewRequired <valid label in PR review process>add this label when versioning review is required label Jun 11, 2025
@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from dbcc577 to 6c50caf Compare June 11, 2025 18:21
@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from 6c50caf to f4c0aa2 Compare June 11, 2025 21:30
@saisankargochhayat
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 33808 in repo Azure/azure-rest-api-specs

@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from f4c0aa2 to fa79c29 Compare June 12, 2025 21:23
@AzureMarker
Copy link
Member Author

AzureMarker commented Jun 12, 2025

The breaking changes seen in the JavaScript SDK are not new. The change happened between the 2022-04-15-preview and 2022-10-27 API versions.

Breaking Changes

  • Enum KnownProvider no longer has value KubeVirt
  • Enum KnownProvider no longer has value OpenStack

azure-sdk/azure-sdk-for-js#14830

@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from fa79c29 to 4113cfd Compare June 13, 2025 19:03
@AzureMarker
Copy link
Member Author

AzureMarker commented Jun 13, 2025

The Avocado error MISSING_APIS_IN_DEFAULT_TAG is a false positive. The API (/listclustercustomerusercredential) was previously deprecated and removed in 2022-10-27, which was already the default version before this PR.

ref: Azure/avocado#150

This is the diff between 2022-10-27 and the new API version.
@AzureMarker AzureMarker force-pushed the markdrobnak/resourceconnector/2025-03-01-preview branch from 922d03f to 9ce9b7e Compare July 3, 2025 23:00
@AzureMarker AzureMarker changed the title [Draft] Add new API version 2025-03-01-preview to Microsoft.ResourceConnector Add new API version 2025-03-01-preview to Microsoft.ResourceConnector Jul 3, 2025
@AzureMarker AzureMarker marked this pull request as ready for review July 3, 2025 23:01
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 3, 2025
@razvanbadea-msft
Copy link
Member

/azp run

@azure-pipelines
Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@razvanbadea-msft razvanbadea-msft removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 7, 2025
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 8, 2025
@razvanbadea-msft razvanbadea-msft added Approved-Avocado ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Jul 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 Jul 9, 2025
@gary-x-li
Copy link
Contributor

As discussed in the office hour, the second use case for PUT operation as illustrated in example AppliancesUpdateProxy.json should be modeled as a POST operation. Please make the switch before releasing your next version.

@microsoft-github-policy-service
Copy link
Contributor

Hi, @@AzureMarker. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

@microsoft-github-policy-service microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Aug 11, 2025
@microsoft-github-policy-service
Copy link
Contributor

Hi, @@AzureMarker. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Avocado Approved-ModelValidation ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec. new-api-version no-recent-activity There has been no recent activity on this issue. resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants