Skip to content

Conversation

@anthony-c-martin
Copy link
Member

@anthony-c-martin anthony-c-martin commented Mar 28, 2025

ARM (Control Plane) API Specification Update Pull Request

This is an implementation of the API changes described in Define an API between parameters and tooling

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 28, 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 28, 2025

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

@anthony-c-martin anthony-c-martin marked this pull request as ready for review April 2, 2025 01:41
@anthony-c-martin anthony-c-martin requested a review from msyyc as a code owner April 2, 2025 01:41
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed SuppressionReviewRequired labels Apr 2, 2025
@azure-sdk
Copy link
Collaborator

azure-sdk commented Apr 2, 2025

@kazrael2119
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.

@anthony-c-martin
Copy link
Member Author

@msyyc please could you take a look?

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

@anthony-c-martin anthony-c-martin merged commit f826fcc into main Apr 22, 2025
55 of 56 checks passed
@anthony-c-martin anthony-c-martin deleted the ant/externalinputs branch April 22, 2025 02:36
nwnt pushed a commit to nwnt/azure-rest-api-specs that referenced this pull request Jun 10, 2025
* Initial commit

* Add new functionality

* Add extension property to WhatIfChange definition

* Add identity property to deployments resource

* Add example using externalInputs

* Incorporate change from Azure#33899

---------

Co-authored-by: Mike Harder <mharder@microsoft.com>
Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com>
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-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 PipelineBotTrigger 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.