[PS] RedisEnterpriseCache add breaking change for migration autorest v4 #28621
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 adds breaking change notifications to the RedisEnterpriseCache module as part of migrating to AutoRest v4. The changes prepare users for upcoming breaking changes in Az v15.0.0 by adding preview messages to affected cmdlets.
- Updates the ChangeLog with a preannounced breaking changes notice
- Adds breaking change preview messages to key cmdlets (Get, New, Update operations)
- Updates module dependencies and version information to support the migration
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| ChangeLog.md | Added breaking changes preannouncement notice |
| Az.RedisEnterpriseCache.psd1 | Updated Az.Accounts dependency version and generation date |
| RedisEnterpriseCache.sln | Updated project GUID references |
| generate-info.json | Updated generation ID for AutoRest |
| docs/Az.RedisEnterpriseCache.md | Updated module GUID |
| custom/*.ps1 | Added PreviewMessage attributes to Get/New/Update cmdlets |
| README.md | Added AutoRest directives for breaking change messages |
| AssemblyInfo.cs | Updated assembly version from 1.4.1 to 1.5.0 |
Comment on lines
+62
to
+66
| [Microsoft.Azure.PowerShell.Cmdlets.RedisEnterpriseCache.Runtime.PreviewMessage("**********************************************************************************************`n | ||
| * This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *`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 breaking change message is duplicated across multiple cmdlets. Consider defining this as a constant to improve maintainability and ensure consistency across all cmdlets.
Copilot uses AI. Check for mistakes.
Comment on lines
+281
to
+287
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | ||
| - where: | ||
| verb: Update | ||
| subject: ^$ | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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 is duplicated in the AutoRest configuration. Consider using YAML anchors (&anchor and *alias) to define the message once and reference it in multiple places to reduce duplication.
Suggested change
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | |
| - where: | |
| verb: Update | |
| subject: ^$ | |
| set: | |
| preview-announcement: | |
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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: &previewMsg "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | |
| - where: | |
| verb: Update | |
| subject: ^$ | |
| set: | |
| preview-announcement: | |
| preview-message: *previewMsg |
Copilot uses AI. Check for mistakes.
Comment on lines
+281
to
+287
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | ||
| - where: | ||
| verb: Update | ||
| subject: ^$ | ||
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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 is duplicated in the AutoRest configuration. Consider using YAML anchors (&anchor and *alias) to define the message once and reference it in multiple places to reduce duplication.
Suggested change
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | |
| - where: | |
| verb: Update | |
| subject: ^$ | |
| set: | |
| preview-announcement: | |
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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: &previewMsg "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\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**************************************************************************************************" | |
| - where: | |
| verb: Update | |
| subject: ^$ | |
| set: | |
| preview-announcement: | |
| preview-message: *previewMsg |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.