Skip to content

Conversation

achyuth-ms
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.
  • 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.

msyyc and others added 30 commits June 6, 2025 14:02
- [test/Avocado] Ignore TSP `examples` folder
- [TSV/FolderStructure] Detect v1/v2 and validate accordingly
  - Regex for v2 RP Namespace: `/^[A-Za-z0-9\.]+$/`
  - Regex for v2 Service (DP or RM): `/^[A-Za-z0-9]+$/`
- [spec-gen-sdk-runner] Add "under /resource-manager/" to RM detection
* include report as json

* update to added-or-deleted change
…pec (#34902)

* Add deploymentSafeguards resource to 2025-04-01 and 2025-04-02-preview
* hopefully final pass

* format

---------

Co-authored-by: iscai-msft <isabellavcai@gmail.com>
* oav runner changes
  * add processing of a static file list instead of relying on simple-git ONLY
  * only scan files that start with specification/
  * add some error handling when parsing a specific swagger so broken links don't break the entire PR

---------
Co-authored-by: Mike Harder <mharder@microsoft.com>
* add sdk-only tag

* add sdk-only tag

* update python config

* update python config

* update python config

* add suffix

* update python config

* update python config
* Copy files from stable/2024-02-01

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to stable/2025-05-25

Updated the API version from stable/2024-02-01 to stable/2025-05-25.

* Added tag for 2025-05-25 in readme file

* add access control method property

* suppress python breaking changes
* Use common-types v6

* Update

* update

* Update sdk-suppressions.yaml

* Update sdk-suppressions.yaml

* add suppression

* add suppression

* add suppression

---------

Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com>
Co-authored-by: jliusan <v-liujudy@microsoft.com>
Bumps [simple-git](https://github.com/steveukx/git-js/tree/HEAD/simple-git) from 3.27.0 to 3.28.0.
- [Release notes](https://github.com/steveukx/git-js/releases)
- [Changelog](https://github.com/steveukx/git-js/blob/main/simple-git/CHANGELOG.md)
- [Commits](https://github.com/steveukx/git-js/commits/simple-git@3.28.0/simple-git)

---
updated-dependencies:
- dependency-name: simple-git
  dependency-version: 3.28.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [simple-git](https://github.com/steveukx/git-js/tree/HEAD/simple-git) from 3.27.0 to 3.28.0.
- [Release notes](https://github.com/steveukx/git-js/releases)
- [Changelog](https://github.com/steveukx/git-js/blob/main/simple-git/CHANGELOG.md)
- [Commits](https://github.com/steveukx/git-js/commits/simple-git@3.28.0/simple-git)

---
updated-dependencies:
- dependency-name: simple-git
  dependency-version: 3.28.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…ecs) and uses default environment variable present in GH Actions (#35164)
* use subpackage value default models for java eventgrid system events

* update package namespace

* renames

* tsp-foramt

* tsp compile
as we prefer url in JavaScript. This is also consistent with

StorageTaskCompletedEventData.summaryReportBlobUrl
Co-authored-by: Scott Beddall <scbedd@microsoft.com>
* Copy files from preview/2024-09-01-preview

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.

* Update version to preview/2025-05-01-preview

Updated the API version from preview/2024-09-01-preview to preview/2025-05-01-preview.

* Added tag for 2025-05-01-preview in readme file

* Update with PNA and DLA

* Fix typo
* add resolution of the owning directory. add tests ensuring it works as expected.
* resolve() the result of simple-git so that are are dealing with a platform-specific result from the function call resolving root directory
* newly created

* update

* Delete oldSwagger.json

* update

* flatten disabled by default

* update

* prettier

* Update tspconfig.yaml

* rename

* remove useless comment

* update

* update

* Fix optional body issue

* update

* remove

* recovery

* update

* update

* Delete conditionalClientFlatten

* update

* update

* update

* update

* fix TSP generation SDK

---------

Co-authored-by: Pan Shao <pashao@microsoft.com>
Co-authored-by: melina5656 <140602263+melina5656@users.noreply.github.com>
Co-authored-by: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com>
Co-authored-by: mcgallan <88413158+mcgallan@users.noreply.github.com>
Co-authored-by: mcgallan <1186003288@qq.com>
Co-authored-by: Jiao Di (MSFT) <80496810+v-jiaodi@users.noreply.github.com>
Co-authored-by: Pan Shao <97225342+pshao25@users.noreply.github.com>
@achyuth-ms achyuth-ms requested a review from jsntcy as a code owner July 7, 2025 23:42
Copy link

PR validation pipeline started 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 Jul 7, 2025
@achyuth-ms achyuth-ms closed this Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

brownfield Brownfield services will soon be required to convert to TypeSpec. See https://aka.ms/azsdk/typespec.

Projects

None yet

Development

Successfully merging this pull request may close these issues.