[BC]SqlVirtualMachine breaking changes announcement#29199
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull request overview
This PR announces breaking changes for the Az.SqlVirtualMachine module scheduled for Az v16.0.0 in May 2026. The changes add PreviewMessage attributes to cmdlets and update help documentation examples to improve security by using variable references instead of hardcoded secrets.
Changes:
- Added breaking change announcements via PreviewMessage attributes to cmdlets (New-AzSqlVM, Update-AzSqlVM, Update-AzSqlVMGroup, New-AzAvailabilityGroupListener)
- Added AutoRest README directives to apply breaking change announcements to Get cmdlets and other generated cmdlets
- Updated help documentation examples to use variables for sensitive values (passwords, access keys, GUIDs) instead of hardcoded placeholders
- Updated Az.Accounts dependency from 4.0.1 to 5.3.2
- Updated module manifest generation date and formatting
- Added resources/README.md and AssemblyInfo.cs to the AutoRest project structure
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/SqlVirtualMachine/SqlVirtualMachine/ChangeLog.md | Added changelog entry for breaking changes announcement |
| src/SqlVirtualMachine/SqlVirtualMachine/Az.SqlVirtualMachine.psd1 | Updated Az.Accounts dependency to 5.3.2, updated generation date, formatting improvements |
| src/SqlVirtualMachine/SqlVirtualMachine/help/Update-AzSqlVM.md | Improved example security by using variable for password and updated GUID format |
| src/SqlVirtualMachine/SqlVirtualMachine/help/New-AzSqlVMGroup.md | Improved example security by using variable for storage account access key |
| src/SqlVirtualMachine/SqlVirtualMachine/help/Assert-AzSqlVMEntraAuth.md | Updated GUID format in examples to use standard format |
| src/SqlVirtualMachine/SqlVirtualMachine.sln | Added x64 and x86 platform configurations, updated project GUID references |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/README.md | Added directives to apply breaking change announcements to Get, New, and Invoke cmdlets |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/Update-AzSqlVMGroup.ps1 | Added PreviewMessage attribute for breaking change announcement |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/Update-AzSqlVM.ps1 | Added PreviewMessage attribute for breaking change announcement |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/New-AzSqlVM.ps1 | Added PreviewMessage attribute for breaking change announcement |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/custom/New-AzAvailabilityGroupListener.ps1 | Added PreviewMessage attribute for breaking change announcement |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/generate-info.json | Updated generate ID for AutoRest regeneration tracking |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/docs/Az.SqlVirtualMachine.md | Updated module GUID |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/resources/README.md | Added standard resources directory documentation |
| src/SqlVirtualMachine/SqlVirtualMachine.Autorest/Properties/AssemblyInfo.cs | Added assembly metadata for the AutoRest project |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | ||
| * At least one change applies to this cmdlet. *`n | ||
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | ||
| ***************************************************************************************************")] |
There was a problem hiding this comment.
The PreviewMessage attribute has inconsistent indentation with leading spaces inside the multi-line string. The continuation lines (lines 60-63) should not have leading spaces before the asterisk. This creates unnecessary whitespace in the displayed message. Compare with the format used in Update-AzSqlVM.ps1 and Update-AzSqlVMGroup.ps1 where the asterisks align without extra leading spaces.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | |
| ***************************************************************************************************")] | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | |
| ***************************************************************************************************")] |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | ||
| * At least one change applies to this cmdlet. *`n | ||
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | ||
| ***************************************************************************************************")] |
There was a problem hiding this comment.
The PreviewMessage attribute has inconsistent indentation with leading spaces inside the multi-line string. The continuation lines (lines 38-41) should not have leading spaces before the asterisk. This creates unnecessary whitespace in the displayed message. Compare with the format used in Update-AzSqlVM.ps1 and Update-AzSqlVMGroup.ps1 where the asterisks align without extra leading spaces.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | |
| ***************************************************************************************************")] | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * At least one change applies to this cmdlet. *`n | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *`n | |
| ***************************************************************************************************")] |
| [OutputType([Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachineGroup])] | ||
| [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The breaking change announcement uses "May 2026" in the PreviewMessage, but this doesn't match the date format used in the README.md directives which say "released in May 2026" (line 228). For consistency across the module, both custom cmdlets and README directives should use the same date phrasing. Additionally, based on repository conventions for breaking change dates, consider using a more specific format like "YYYY/MM/DD" or at minimum "Month YYYY" consistently throughout all breaking change announcements.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *`n |
| [OutputType([Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine])] | ||
| [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n |
There was a problem hiding this comment.
The PreviewMessage says "released on May 2026" but should say "to be released in May 2026" to match the phrasing used in the README.md directives (line 228) for consistency across the module.
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *`n | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released in May 2026. *`n |
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.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.