[Az.SqlVirtualMachine] Update Autorest v3 to v4 by khang-11 · Pull Request #29565 · Azure/azure-powershell

khang-11 · 2026-05-12T03:32:59Z

Description

Preannouncement PR: #29199

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

This reverts commit df28161.

This reverts commit 1bc5510.

azure-client-tools-bot-prd · 2026-05-12T03:33:02Z

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

Copilot

Pull request overview

Updates the Az.SqlVirtualMachine AutoRest-based module to align with AutoRest PowerShell v4 generation, including regenerated cmdlet help/docs, updated custom cmdlets, and refreshed test assets.

Changes:

Updated AutoRest configuration for the SqlVirtualMachine module and regenerated outputs for v4.
Regenerated cmdlet help/docs and adjusted exposed model/type references (removing Api20220801Preview-scoped types in docs/tests).
Updated Pester tests and recordings for the regenerated cmdlets/models.

Reviewed changes

Copilot reviewed 59 out of 66 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/SqlVirtualMachine/SqlVirtualMachine/help/Update-AzSqlVMGroup.md	Regenerated help reflecting v4 typing/output model updates.
src/SqlVirtualMachine/SqlVirtualMachine/help/Update-AzSqlVM.md	Regenerated help reflecting v4 typing/output model updates.
src/SqlVirtualMachine/SqlVirtualMachine/help/Start-AzSqlVMAssessment.md	Regenerated help content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine/help/Remove-AzSqlVMGroup.md	Regenerated help content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine/help/Remove-AzSqlVM.md	Regenerated help content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine/help/Remove-AzAvailabilityGroupListener.md	Regenerated help; adds/reflects new identity-based parameter set.
src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzSqlVMGroup.md	Regenerated help; adds JsonString/JsonFilePath parameter sets and string-typed enums.
src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzSqlVM.md	Regenerated help; string-typed enums and updated output model type.
src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md	Regenerated help; updated online link casing and output type namespace.
src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzSqlVirtualMachineAgReplicaObject.md	Regenerated help; string-typed enums and updated output type namespace.
src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzAvailabilityGroupListener.md	Regenerated help; updated model interface namespaces and outputs.
src/SqlVirtualMachine/SqlVirtualMachine/help/Invoke-AzSqlVMTroubleshoot.md	Regenerated help; adds JsonString/JsonFilePath parameter sets and string-typed scenario.
src/SqlVirtualMachine/SqlVirtualMachine/help/Invoke-AzRedeploySqlVM.md	Regenerated help content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine/help/Get-AzSqlVMGroup.md	Regenerated help; updated output model type namespace.
src/SqlVirtualMachine/SqlVirtualMachine/help/Get-AzSqlVM.md	Regenerated help; updated output model type namespace.
src/SqlVirtualMachine/SqlVirtualMachine/help/Get-AzAvailabilityGroupListener.md	Regenerated help; adds group-identity parameter set and updated outputs.
src/SqlVirtualMachine/SqlVirtualMachine/help/Az.SqlVirtualMachine.md	Regenerated module help index/summary text.
src/SqlVirtualMachine/SqlVirtualMachine/ChangeLog.md	Added an upcoming release note entry related to the change.
src/SqlVirtualMachine/SqlVirtualMachine/Az.SqlVirtualMachine.psd1	Updated module manifest formatting/generated metadata.
src/SqlVirtualMachine/SqlVirtualMachine.sln	Updated solution project GUID mapping for the generated project reference.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Start-AzSqlVMAssessment.Recording.json	Updated HTTP playback recording for Start-AzSqlVMAssessment.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Remove-AzAvailabilityGroupListener.Tests.ps1	Updated test to use non-preview model types.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzSqlVMGroup.Tests.ps1	Updated test to use non-preview model types.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzSqlVMGroup.Recording.json	Updated HTTP playback recording for Get-AzSqlVMGroup.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzSqlVM.Tests.ps1	Updated test to use non-preview model types.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzSqlVM.Recording.json	Updated HTTP playback recording for Get-AzSqlVM.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzAvailabilityGroupListener.Tests.ps1	Updated test to use non-preview model types.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/Get-AzAvailabilityGroupListener.Recording.json	Updated HTTP playback recording for Get-AzAvailabilityGroupListener.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/test/env.json	Updated test environment values used by Pester tests.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/README.md	Updated AutoRest v4 configuration and directives for generation/customization.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/Properties/AssemblyInfo.cs	Updated assembly version attributes.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/generate-info.json	Updated generation metadata identifier.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Update-AzSqlVMGroup.md	Regenerated docs for v4 typing/output model updates.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Update-AzSqlVM.md	Regenerated docs for v4 typing/output model updates.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Start-AzSqlVMAssessment.md	Regenerated docs content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Remove-AzSqlVMGroup.md	Regenerated docs content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Remove-AzSqlVM.md	Regenerated docs content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Remove-AzAvailabilityGroupListener.md	Regenerated docs; adds/reflects new identity-based parameter set.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/New-AzSqlVMGroup.md	Regenerated docs; adds JsonString/JsonFilePath parameter sets and string-typed enums.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/New-AzSqlVM.md	Regenerated docs; string-typed enums and updated output model type.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.md	Regenerated docs; updated online link casing and output type namespace.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/New-AzSqlVirtualMachineAgReplicaObject.md	Regenerated docs; string-typed enums and updated output type namespace.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/New-AzAvailabilityGroupListener.md	Regenerated docs; updated model interface namespaces and outputs.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Invoke-AzSqlVMTroubleshoot.md	Regenerated docs; adds JsonString/JsonFilePath parameter sets and string-typed scenario.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Invoke-AzRedeploySqlVM.md	Regenerated docs content for identity parameter documentation.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Get-AzSqlVMGroup.md	Regenerated docs; updated output model type namespace.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Get-AzSqlVM.md	Regenerated docs; updated output model type namespace.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Get-AzAvailabilityGroupListener.md	Regenerated docs; adds group-identity parameter set and updated outputs.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Az.SqlVirtualMachine.md	Regenerated module docs index metadata (e.g., module GUID) and summary text.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/Update-AzSqlVMGroup.ps1	Updated custom update wrapper to use non-preview model types and updated internal/private cmdlets.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/Update-AzSqlVM.ps1	Updated custom update wrapper to use string-typed enums and PS argument completers.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/New-AzSqlVM.ps1	Updated custom create wrapper to use string-typed enums and PS argument completers.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/New-AzAvailabilityGroupListener.ps1	Updated custom create wrapper to use non-preview model types.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/autogen-model-cmdlets/New-AzSqlVirtualMachineMultiSubnetIPConfigurationObject.ps1	Updated autogen model cmdlet to non-preview model type and model-cmdlet attribute.
src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/autogen-model-cmdlets/New-AzSqlVirtualMachineAgReplicaObject.ps1	Updated autogen model cmdlet to non-preview model type and string-based completers.

    [Parameter()]
-    [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlManagementMode])]
+    [Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.PSArgumentCompleterAttribute("Full","Lightweight","NoAgent")]
    [Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Category('Body')]
-    [Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Support.SqlManagementMode]
+    [System.String]
    # SQL Server Management type.
    ${SqlManagementType},


 inlining-threshold: 100
-resourcegroup-append: true
-nested-object-to-string: true
-identity-correction-for-post: true
-
-# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
-use-extension:
-  "@autorest/powershell": "3.x"
+disable-transform-identity-type: true

 directive:
+  - remove-operation: 
+    - SqlVirtualMachineGroups_Update
+  - from: swagger-document
+    where: $.definitions.SqlVirtualMachineGroupProperties.properties.wsfcDomainProfile
+    transform: $['x-ms-mutability'] = ["read", "update", "create"]
+  - from: swagger-document


 ## Upcoming Release
+* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).



    "Response": {
-      "StatusCode": 200,
+      "StatusCode": 404,
      "Headers": {
        "Cache-Control": [ "no-cache" ],
        "Pragma": [ "no-cache" ],


    "Response": {
-      "StatusCode": 200,
+      "StatusCode": 404,
      "Headers": {
        "Cache-Control": [ "no-cache" ],
        "Pragma": [ "no-cache" ],
-        "x-ms-request-id": [ "3d6ecce5-8589-49db-96be-0a3ab9da9fac" ],
-        "Server": [ "Microsoft-HTTPAPI/2.0" ],
-        "x-ms-ratelimit-remaining-subscription-reads": [ "11982" ],
-        "x-ms-correlation-request-id": [ "c09bcc2b-9229-4765-99b1-0879c4ef8dc4" ],
-        "x-ms-routing-request-id": [ "SOUTHEASTASIA:20230310T031443Z:c09bcc2b-9229-4765-99b1-0879c4ef8dc4" ],
+        "x-ms-failure-cause": [ "gateway" ],


    "Response": {
-      "StatusCode": 200,
+      "StatusCode": 404,
      "Headers": {
        "Cache-Control": [ "no-cache" ],
        "Pragma": [ "no-cache" ],


    "Response": {
-      "StatusCode": 202,
+      "StatusCode": 404,
      "Headers": {
        "Cache-Control": [ "no-cache" ],
        "Pragma": [ "no-cache" ],


github-actions · 2026-05-22T03:29:22Z

To the author of the pull request,
This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline.

According to our policy, breaking changes can only take place during major release and they must be preannounced.
Please follow our guide on the detailed steps.
Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

JiaSeng-v added 9 commits February 10, 2026 11:01

[Az.SqlVirtualMachine] Update Autorest v3 to v4

1bc5510

update exceptions

df28161

Revert "update exceptions"

2cc73ca

This reverts commit df28161.

Revert "[Az.SqlVirtualMachine] Update Autorest v3 to v4"

2c91beb

This reverts commit 1bc5510.

revert prev changes and rebuild with new changes

d64f1ac

update recording

6236460

update recording and replace secret

4b78b5b

update BreakingChangeIssues.csv

b742af0

fix conflict

4874c3a

Copilot AI review requested due to automatic review settings May 12, 2026 03:33

Copilot started reviewing on behalf of khang-11 May 12, 2026 03:35 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

YanaXu added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label May 13, 2026

Pan-Qi previously approved these changes May 22, 2026

View reviewed changes

Pan-Qi added the Contains Breaking Change This PR contains breaking change label May 22, 2026

skip some test cases

48774fe

JiaSeng-v dismissed Pan-Qi’s stale review via 48774fe May 22, 2026 04:08

Pan-Qi self-requested a review May 25, 2026 01:46

Pan-Qi approved these changes May 25, 2026

View reviewed changes

Pan-Qi merged commit 269dd3a into Azure:main May 25, 2026
11 of 12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Az.SqlVirtualMachine] Update Autorest v3 to v4#29565

[Az.SqlVirtualMachine] Update Autorest v3 to v4#29565
Pan-Qi merged 10 commits into
Azure:mainfrom
khang-11:recreate/pr-29156

khang-11 commented May 12, 2026

Uh oh!

azure-client-tools-bot-prd Bot commented May 12, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		## Upcoming Release
		* Improved user experience and consistency. This may introduce breaking changes. Please refer to [here](https://go.microsoft.com/fwlink/?linkid=2340249).

Conversation

khang-11 commented May 12, 2026

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd Bot commented May 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants