Skip to content

[Azure.Migrate] Add RefreshEntities API - 2026-02-01-preview#40433

Open
shreyasmalims wants to merge 16 commits intomainfrom
refresh-entities
Open

[Azure.Migrate] Add RefreshEntities API - 2026-02-01-preview#40433
shreyasmalims wants to merge 16 commits intomainfrom
refresh-entities

Conversation

@shreyasmalims
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

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.
  • Update existing version for a new feature.
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec.
  • Other, please clarify:

Summary

This PR adds a new API version 2026-02-01-preview for Azure Migrate Waves Management service with the following changes:

New Features

  • RefreshEntities API: New operation to refresh execution status for migration entities and groups within a migrate project
    • Operation: POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/refreshEntities
    • Long-running async operation with 202 response
    • Supports refreshing by entity IDs or entity group IDs

Changes Made

  1. TypeSpec Updates:

    • Added v2026_02_01_preview to ApiVersions.tsp
    • Created new model file: WebModels/RefreshEntities/RefreshEntities.tsp
    • Updated routes.tsp with refreshEntities operation
  2. Generated Artifacts:

    • Generated OpenAPI spec: preview/2026-02-01-preview/waves.json
    • Generated 22 example files using OAV (OpenAPI Validator)
    • All existing operations from previous API version included
  3. SDK Configuration:

    • Updated readme.md with package-preview-2026-02 tag
    • Updated readme.go.md with Go SDK configuration

API Version History

  • 2026-02-01-preview (NEW): Adds RefreshEntities API
  • 2025-12-01-preview: Adds GenerateWavePlan API
  • 2025-03-30-preview: Initial Waves Management API

Due diligence checklist

Related Work Items

  • Service Implementation: [Link to your work item if available]

Breaking Changes

  • None - This is a new API version with additive changes only

Testing

  • Examples generated and validated using OAV
  • TypeSpec compilation successful
  • All 22 x-ms-examples properly linked in OpenAPI specification

@github-actions
Copy link

github-actions bot commented Feb 13, 2026

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.

@github-actions github-actions bot added ARMReview new-api-version resource-manager TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMAutoSignedOff-IncrementalTSP ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 13, 2026
@github-actions
Copy link

github-actions bot commented Feb 13, 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.Migrate-Waves
TypeSpec Microsoft.Migrate
JavaScript @azure/arm-migrate
Python azure-mgmt-migrate
Java com.azure.resourcemanager:azure-resourcemanager-migrate

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request adds a new API version 2026-02-01-preview for the Azure Migrate Waves Management service, introducing a new RefreshEntities operation. The PR includes both TypeSpec source files and the generated OpenAPI specifications.

Changes:

  • Added new API version v2026_02_01_preview to ApiVersions.tsp
  • Created new RefreshEntities operation as a long-running async action on MigrateProjects
  • Generated complete OpenAPI spec at preview/2026-02-01-preview/waves.json with all existing operations plus the new RefreshEntities endpoint
  • Added configuration in readme.md and readme.go.md for the new package-preview-2026-02 tag
  • Generated 22 example JSON files for all operations in the 2026-02-01-preview API version

Reviewed changes

Copilot reviewed 50 out of 50 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
specification/migrate/Waves.Management/ApiVersions.tsp Added v2026_02_01_preview enum value
specification/migrate/Waves.Management/WebModels/RefreshEntities/RefreshEntities.tsp New TypeSpec model definitions for RefreshEntitiesRequest and RefreshEntitiesResponse
specification/migrate/Waves.Management/routes.tsp Added refreshEntities operation to MigrateProjects interface using ArmResourceActionAsync
specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.md Updated default tag to package-preview-2026-02 and added new tag configuration
specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.go.md Added Go SDK configuration for package-preview-2026-02
specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2026-02-01-preview/waves.json Complete generated OpenAPI spec with RefreshEntities operation and all models
specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2026-02-01-preview/examples/*.json Generated 22 example files for all operations
specification/migrate/Waves.Management/examples/2026-02-01-preview/*.json Duplicate example files in TypeSpec source directory

@satravi satravi added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 13, 2026
@microsoft-github-policy-service
Copy link
Contributor

@shreyasmalims please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@satravi satravi self-requested a review February 13, 2026 12:30
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 51 out of 53 changed files in this pull request and generated no new comments.

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

Labels

ARMAutoSignedOff-IncrementalTSP ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version 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.

3 participants