[BC]SignalR Breaking Change Announcement #29080
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 pull request announces breaking changes for the SignalR PowerShell module, specifically targeting the removal of several debugging and proxy-related parameters from WebPubSub cmdlets in the upcoming Az v16.0.0 release (May 2026).
Changes:
- Removed deprecated parameter documentation from 26 help markdown files (-Break, -HttpPipelineAppend, -HttpPipelinePrepend, -Proxy, -ProxyCredential, -ProxyUseDefaultCredentials)
- Added breaking change pre-announcement to ChangeLog.md
- Updated module manifest files with new generation dates, cmdlet export list alphabetization, and dependency updates
- Added breaking change preview messages to cmdlets via AutoRest directives
- Reorganized solution file with new project GUIDs and build configurations
Reviewed changes
Copilot reviewed 33 out of 33 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/SignalR/SignalR/ChangeLog.md | Added pre-announcement of breaking changes with reference link |
| src/SignalR/SignalR/help/*.md (26 files) | Removed documentation for deprecated parameters (Break, HttpPipelineAppend, HttpPipelinePrepend, Proxy, ProxyCredential, ProxyUseDefaultCredentials); Added blank lines for formatting; Updated type names to fully-qualified names |
| src/SignalR/SignalR/Az.SignalR.psd1 | Updated generation date, alphabetized cmdlet exports, uncommented ScriptsToProcess and TypesToProcess, changed path separators to forward slashes for cross-platform compatibility |
| src/SignalR/SignalR.Autorest/custom/scripts/New-AzWebPubSub.ps1 | Added PreviewMessage attribute with breaking change warning |
| src/SignalR/SignalR.Autorest/README.md | Added AutoRest directive to apply preview-announcement to New and Update WebPubSub cmdlets |
| src/SignalR/SignalR.Autorest/Az.SignalR.nuspec | Updated Az.Accounts dependency from previous version to 2.7.5 |
| src/SignalR/SignalR.Autorest/Properties/AssemblyInfo.cs | New file with assembly metadata (version 2.3.2) |
| src/SignalR/SignalR.Autorest/resources/README.md | New file documenting the resources directory purpose |
| src/SignalR/SignalR.Autorest/generate-info.json | Updated generation ID |
| src/SignalR/SignalR.Autorest/docs/Az.SignalR.md | Updated module GUID |
| src/SignalR/SignalR.sln | Updated project references and build configurations with new GUIDs and platform targets |
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("**********************************************************************************************`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 preview message in the PreviewMessage attribute contains inconsistent formatting. Line 97 starts with excessive asterisks (88 characters) while line 101 has only 99 asterisks. The message should use consistent border formatting for better readability. Additionally, line 99 has inconsistent spacing with many extra spaces after "cmdlet."
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("**********************************************************************************************`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 | |
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("***************************************************************************************************`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 |
| <tags>Azure ResourceManager ARM PSModule $(service-name)</tags> | ||
| <dependencies> | ||
| <dependency id="Az.Accounts" version="2.2.3" /> | ||
| <dependency id="Az.Accounts" version="2.7.5" /> |
There was a problem hiding this comment.
The Az.Accounts dependency version is inconsistent between files. The nuspec file specifies version 2.7.5, but the module manifest (Az.SignalR.psd1) requires version 5.3.2. These versions should be synchronized to ensure consistent dependencies.
| <dependency id="Az.Accounts" version="2.7.5" /> | |
| <dependency id="Az.Accounts" version="5.3.2" /> |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] | ||
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("**********************************************************************************************`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 |
There was a problem hiding this comment.
Could you please describe the breaking change more detail? What will be the breaking change?
There was a problem hiding this comment.
-IdentityType SystemAssigned will be changed to -EnableSystemAssignedIdentity
| subject: WebPubSub | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
There was a problem hiding this comment.
Could you please describe the breaking change more detail? What will be the breaking change?
There was a problem hiding this comment.
-IdentityType SystemAssigned will be changed to -EnableSystemAssignedIdentity
There was a problem hiding this comment.
Hi Yunchi @wyunchi-ms,
This breaking change announcement is for the Autorest v4 upgrade, which introduces a large number of repeated breaking changes across different cmdlets.
After discussing with Xiaogang and Yeming, we agreed to create a centralized breaking change list for users to review as mentioned in the BC message. The consolidated list can be found here: https://go.microsoft.com/fwlink/?linkid=2333486
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("**********************************************************************************************`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 preview message contains inconsistent formatting with extra leading whitespace on some lines. The indentation should be consistent, or the message should be formatted as a single line. This will display incorrectly to users when the cmdlet is executed.
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("**********************************************************************************************`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 | |
| ***************************************************************************************************")] | |
| [Microsoft.Azure.PowerShell.Cmdlets.WebPubSub.Runtime.PreviewMessage("This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. At least one change applies to this cmdlet. See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486.")] |
| subject: WebPubSub | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
There was a problem hiding this comment.
The preview-message in the directive uses different formatting than the custom script. The README.md directive uses escaped newlines (\r\n) and different asterisk counts, which may produce inconsistent messages to users between the same cmdlets. The messages should be identical for consistency.
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | |
| preview-message: | | |
| ************************************************************************************************** | |
| * This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2026. * | |
| * At least one change applies to this cmdlet. * | |
| * See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 * | |
| ************************************************************************************************** |
…iaSeng-v/azure-powershell into jiaseng/SignalR-breakingchange
Pan-Qi
added
the
Breaking Change Preannounce
3 participants
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.