[PS] Migrate LabServices module to autorest v4 by JoyerJin · Pull Request #27877 · Azure/azure-powershell

JoyerJin · 2025-05-30T10:24:11Z

Description

Mandatory Checklist

Please choose the target release of Azure PowerShell. (⚠️Target release is a different concept from API readiness. Please click below links for details.)
- General release
- Public preview
- Private preview
- Engineering build
- No need for a release
Check this box to confirm: I have read the Submitting Changes section of CONTRIBUTING.md and reviewed the following information:

SHOULD update ChangeLog.md file(s) appropriately
- Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
  - A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
- Should not change ChangeLog.md if no new release is required, such as fixing test case only.
SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
SHOULD have proper test coverage for changes in pull request.
SHOULD NOT adjust version of module manually in pull request

azure-client-tools-bot-prd · 2025-05-30T10:24:14Z

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot

Pull Request Overview

This PR migrates the LabServices PowerShell module to AutoRest v4 by updating model namespaces, unifying command implementations, and refreshing generation directives and assembly metadata.

Updated cmdlet scripts to use the new Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models types instead of Api20211001Preview variants.
Adjusted internal invocations in list commands to point at private helper functions.
Refreshed UX JSON descriptions, updated autorest directives, and added an AssemblyInfo.cs for module metadata.

Reviewed Changes

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

Show a summary per file

File	Description
src/LabServices/.../custom/*.ps1	Swapped out `Api20211001Preview` model types for `Models.*`; updated OutputType and parameter type references.
src/LabServices/.../Get-AzLabServicesLab_ListBySubscription.ps1	Changed internal call from `internal\Get-AzLabServicesLab` to `private\Get-AzLabServicesLab_List`.
src/LabServices/.../Get-AzLabServicesLab_ListByResourceGroup.ps1	Changed internal call to `private\Get-AzLabServicesLab_List1`.
src/LabServices/.../UX/Microsoft.LabServices/labs.json	Revised the “Publish-AzLabServicesLab” description text.
src/LabServices/.../README.md	Updated AutoRest directives for deprecation, password handling, and command variants.
src/LabServices/.../AssemblyInfo.cs	Added assembly metadata file with version and licensing.

Comments suppressed due to low confidence (2)

src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListBySubscription.ps1:86

[nitpick] The helper function name Get-AzLabServicesLab_List is too generic and may confuse readers. Consider renaming it to reflect the context (e.g., Get-AzLabServicesLab_ListBySubscriptionPrivate) for clarity.

        return Az.LabServices.private\Get-AzLabServicesLab_List @PSBoundParameters

src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListByResourceGroup.ps1:90

[nitpick] The numeric suffix in Get-AzLabServicesLab_List1 is unclear. A more descriptive name matching the cmdlet (e.g., Get-AzLabServicesLab_ListByResourceGroupPrivate) would improve maintainability.

        return Az.LabServices.private\Get-AzLabServicesLab_List1 @PSBoundParameters

github-actions · 2025-06-03T02:05:34Z

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

Copilot

Pull Request Overview

This PR migrates the LabServices PowerShell module to use AutoRest v4 schemas and updated codegen artifacts.

Updated all cmdlet scripts to reference the general Microsoft.Azure.PowerShell.Cmdlets.LabServices.Models.* interfaces instead of the versioned Api20211001Preview types
Swapped internal invocation namespace to Az.LabServices.private and adjusted private helper names in list cmdlets
Refreshed Autorest directives in README.md and added a new AssemblyInfo.cs with metadata

Reviewed Changes

Copilot reviewed 141 out of 141 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesUserVM_Get.ps1	Updated .Outputs and OutputType to use Models.IVirtualMachine
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesTemplateVM_Lab.ps1	Updated .Outputs and OutputType to use Models.IVirtualMachine and reference Models.Lab
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesTemplateVM_Get.ps1	Updated .Outputs and OutputType to use Models.IVirtualMachine
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesSchedule_ResourceId.ps1	Updated .Outputs and OutputType to use Models.ISchedule
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesSchedule_Lab.ps1	Updated .Outputs and OutputType to use Models.ISchedule and reference Models.Lab
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesPlanImage_ResourceId.ps1	Updated .Outputs and OutputType to use Models.IImage
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesPlanImage_ListByDisplayName.ps1	Updated .Outputs and OutputType to use Models.IImage
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesPlanImage_LabPlan.ps1	Updated .Outputs and OutputType to use Models.IImage and reference Models.LabPlan
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLabforVM.ps1	Updated .Outputs and OutputType to use Models.ILab
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ResourceId.ps1	Updated .Outputs and OutputType to use Models.ILab
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListBySubscription.ps1	Updated .Outputs, OutputType, and switched to `Az.LabServices.private\Get-AzLabServicesLab_List`
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListByResourceGroup.ps1	Updated .Outputs, OutputType, and switched to `Az.LabServices.private\Get-AzLabServicesLab_List1`
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListByLabName.ps1	Updated .Outputs and OutputType to use Models.ILab
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_LabPlan.ps1	Updated .Outputs and OutputType to use Models.ILab and reference Models.LabPlan
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLabPlan_ResourceId.ps1	Updated .Outputs and OutputType to use Models.ILabPlan
src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLabPlan_ListByLabPlanName.ps1	Updated .Outputs and OutputType to use Models.ILabPlan
src/LabServices/LabServices.Autorest/custom/Add-AzLabServicesUserQuota_User.ps1	Updated .Outputs and OutputType to use Models.IUser and reference Models.User
src/LabServices/LabServices.Autorest/custom/Add-AzLabServicesUserQuota_Email.ps1	Updated .Outputs and OutputType to use Models.IUser
src/LabServices/LabServices.Autorest/README.md	Refreshed Autorest v4 directives, deprecation notices, transforms, and removed old extension block
src/LabServices/LabServices.Autorest/Properties/AssemblyInfo.cs	Added new AssemblyInfo with license header and assembly metadata

Comments suppressed due to low confidence (2)

src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesSchedule_ResourceId.ps1:26

The function name Get-AzLabServicesSchedule_LabObject does not match the file name Get-AzLabServicesSchedule_ResourceId.ps1. Rename the function to Get-AzLabServicesSchedule_ResourceId for consistency.

function Get-AzLabServicesSchedule_LabObject {

src/LabServices/LabServices.Autorest/custom/Get-AzLabServicesLab_ListByResourceGroup.ps1:90

The helper invocation references Get-AzLabServicesLab_List1, which is an unexpected suffix. Verify and correct the function name (e.g., Get-AzLabServicesLab_ListByResourceGroup or a consistent private helper) to prevent runtime errors.

        return Az.LabServices.private\Get-AzLabServicesLab_List1 @PSBoundParameters

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

vidai-msft

A few parameters like Lab, LabPlan, Schedule, User, VM and etc are missing descriptions. Please confirm if this is expected.

… cmdlet

…ix cmd Stop User VM variant stop bug.

YanaXu · 2025-07-10T04:53:35Z

Please check the CI results and remove the secrets.

updated.

[PS] Migrate LabServices module to autorest v4

c6cd26c

Copilot AI review requested due to automatic review settings May 30, 2025 10:24

Copilot AI reviewed May 30, 2025

View reviewed changes

Comment thread src/LabServices/LabServices.Autorest/UX/Microsoft.LabServices/labs.json Outdated

JoyerJin added the Do Not Merge 🚫 label Jun 3, 2025

alexneyler approved these changes Jun 3, 2025

View reviewed changes

Comment thread src/LabServices/LabServices.Autorest/UX/Microsoft.LabServices/labs.json Outdated

fix 'replace publish cmdlet description' bug

ec3d6a5

JoyerJin requested review from Copilot June 3, 2025 07:46

JoyerJin removed the Do Not Merge 🚫 label Jun 3, 2025

Copilot AI reviewed Jun 3, 2025

View reviewed changes

Azure deleted a comment from Copilot AI Jun 14, 2025

vidai-msft reviewed Jun 14, 2025

View reviewed changes

JoyerJin added 3 commits June 16, 2025 17:43

add description for all parameters

b84d7b4

Merge branch 'main' into joyer/labservices-migrate-v4

08de713

update parameter descriptions

5c6aade

vidai-msft previously requested changes Jun 20, 2025

View reviewed changes

JoyerJin added 4 commits June 24, 2025 14:51

sync the custom synopsis

61150f9

Remove 'AdditionalUsageQuota' parameter of Publish-AzLabServicesLab…

84731e8

… cmdlet

Merge branch 'main' into joyer/labservices-migrate-v4

27d5dfe

update the power shell script from a back slash to a slash

6244439

YanaXu reviewed Jul 3, 2025

View reviewed changes

Comment thread src/LabServices/LabServices.Autorest/README.md

YanaXu added the Waiting for Verification 🔍 label Jul 3, 2025

JoyerJin added 2 commits July 7, 2025 13:35

Rewrite test case, run testing with record and fix the part of bug. F…

6774b50

…ix cmd Stop User VM variant stop bug.

Update Get-AzLabServicesUserVM_ResourceId.ps1

9d13339

Remove password and pwd words

92d39de

YanaXu closed this Jul 10, 2025

YanaXu reopened this Jul 10, 2025

JoyerJin removed the Waiting for Verification 🔍 label Jul 10, 2025

JoyerJin added 2 commits July 10, 2025 17:57

test license check

fcea214

update join-path

2cc6482

YanaXu approved these changes Jul 11, 2025

View reviewed changes

YanaXu merged commit 603ee4f into main Jul 11, 2025
12 checks passed

YanaXu deleted the joyer/labservices-migrate-v4 branch July 11, 2025 07:47

Conversation

JoyerJin commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd Bot commented May 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

github-actions Bot commented Jun 3, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

vidai-msft left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

YanaXu commented Jul 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

JoyerJin commented May 30, 2025 •

edited

Loading

vidai-msft left a comment •

edited

Loading