[Az.Advisor] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28276

lijinpei2008 · 2025-07-27T11:46:26Z

#28036

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

…mdlet adds a BreakingChange announcement

azure-client-tools-bot-prd · 2025-07-27T11:46:30Z

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

github-actions · 2025-08-11T06:17:32Z

‼️ 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.

github-actions · 2025-08-11T06:17:57Z

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

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.

Copilot

Pull Request Overview

This PR prepares the Az.Advisor module for an upcoming refactoring by adding breaking change announcements to cmdlets and updating various project files. The changes notify users that the module's codebase will be refactored and introduces breaking change attributes for output type modifications.

Updates cmdlet output type annotations with breaking change attributes for future compatibility
Modifies module manifest to update dependencies and configuration paths
Adds breaking change announcements to the changelog for affected cmdlets

Reviewed Changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/Advisor/Advisor/help/Get-AzAdvisorRecommendation.md	Updates documentation to add markdown link formatting for Category parameter
src/Advisor/Advisor/ChangeLog.md	Adds breaking change announcement for five cmdlets affected by the refactoring
src/Advisor/Advisor/Az.Advisor.psd1	Updates module manifest with new dependency version and path corrections
src/Advisor/Advisor.sln	Restructures solution file with new project organization and build configurations
src/Advisor/Advisor.Autorest/custom/*.ps1	Adds OutputBreakingChangeAttribute to cmdlets for output type changes
src/Advisor/Advisor.Autorest/README.md	Adds breaking change configuration for Get-Configuration cmdlet
Other files	Various generated files with updated metadata and assembly information

Copilot · 2025-08-11T06:18:13Z

src/Advisor/Advisor/help/Get-AzAdvisorRecommendation.md

 ### -Filter
 The filter to apply to the recommendations.
-Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', 'Category'] with operators ['eq', 'and', 'or'].
+Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].


The markdown link 'Category' appears to be incorrect. The anchor '#category' doesn't correspond to any section in this documentation file. Consider either removing the link formatting or ensuring the target section exists.

Suggested change

Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].

Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', 'Category'] with operators ['eq', 'and', 'or'].

Copilot · 2025-08-11T06:18:13Z

src/Advisor/Advisor.Autorest/custom/Enable-AzAdvisorRecommendation.ps1

 #>
 function Enable-AzAdvisorRecommendation{
 [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase])]
+[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]


There's an extra period at the end of 'IRecommendationPropertiesActionsItem].' in the NewOutputProperties parameter. Remove the trailing period for consistency.

Suggested change

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem]", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

Copilot · 2025-08-11T06:18:13Z

src/Advisor/Advisor.Autorest/custom/Disable-AzAdvisorRecommendation.ps1

 #>
 function Disable-AzAdvisorRecommendation{
 [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase])]
+[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]


There's an extra period at the end of 'IRecommendationPropertiesActionsItem].' in the NewOutputProperties parameter. Remove the trailing period for consistency.

Suggested change

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem]", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

Copilot · 2025-08-11T06:18:14Z

src/Advisor/Advisor.Autorest/custom/Get-AzAdvisorRecommendation.ps1

 #>
 function Get-AzAdvisorRecommendation {
    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase])]
+    [Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]


There's an extra period at the end of 'IRecommendationPropertiesActionsItem].' in the NewOutputProperties parameter. Remove the trailing period for consistency.

Suggested change

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem].", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Runtime.OutputBreakingChangeAttribute("Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.Api202001.IResourceRecommendationBase", "15.0.0", "9.0.0", "2025/11/03", ReplacementCmdletOutputType = "Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IResourceRecommendationBase", DeprecatedOutputProperties = ("Action Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem[]", "SuppressionId System.String[]"), NewOutputProperties = ("Action System.Collections.Generic.List`1[Microsoft.Azure.PowerShell.Cmdlets.Advisor.Models.IRecommendationPropertiesActionsItem]", "SuppressionId System.Collections.Generic.List`1[System.String]"))]

… jinpei/main/Advisor-Announcement

[Az.Advisor] The code base is going to be refactored, the following c…

f543757

…mdlet adds a BreakingChange announcement

Update examples

b13ccf0

lijinpei2008 marked this pull request as ready for review August 11, 2025 06:17

Copilot AI review requested due to automatic review settings August 11, 2025 06:17

lijinpei2008 added Do Not Merge 🚫 Contains Breaking Change This PR contains breaking change labels Aug 11, 2025

Copilot AI reviewed Aug 11, 2025

View reviewed changes

lijinpei2008 removed Do Not Merge 🚫 Contains Breaking Change This PR contains breaking change labels Aug 18, 2025

Pan-Qi added the Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change label Aug 18, 2025

lijinpei2008 added 2 commits August 18, 2025 16:29

Merge branch 'main' of https://github.com/Azure/azure-powershell into…

cb6f441

… jinpei/main/Advisor-Announcement

Update changelog

51679de

NoriZC approved these changes Aug 19, 2025

View reviewed changes

NoriZC merged commit 0559014 into main Aug 19, 2025
12 checks passed

NoriZC deleted the jinpei/main/Advisor-Announcement branch August 19, 2025 07:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Az.Advisor] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28276

[Az.Advisor] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28276

Uh oh!

lijinpei2008 commented Jul 27, 2025

Uh oh!

azure-client-tools-bot-prd bot commented Jul 27, 2025

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Copilot AI Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].
	Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', 'Category'] with operators ['eq', 'and', 'or'].

[Az.Advisor] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28276

[Az.Advisor] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28276

Uh oh!

Conversation

lijinpei2008 commented Jul 27, 2025

Description

Mandatory Checklist

Uh oh!

azure-client-tools-bot-prd bot commented Jul 27, 2025

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

github-actions bot commented Aug 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants