Breaking Change Message for Metric migrating to autorest (#24445)

* add breaking change message for Metric migrating to autorest

add breaking change message for Metric migrating to autorest

* Change log add breaking change message for Metric

* Update Breaking change message for Monitor Metric

Author: JoyerJin

src/Monitor/Monitor/ChangeLog.md

@@ -19,6 +19,10 @@
 -->
 
 ## Upcoming Release
+* Added breaking change warning messages for Metric Management Plane
+    * Get-AzMetric
+    * Get-AzMetricDefinition
+    * New-AzMetricFilter
 
 ## Version 5.1.0
 * Added support for the Metric Data Plane

src/Monitor/Monitor/Metrics/GetAzureRmMetricCommand.cs

@@ -31,6 +31,9 @@ namespace Microsoft.Azure.Commands.Insights.Metrics
     /// Get the list of metric definition for a resource.
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "Metric", DefaultParameterSetName = GetAzureRmAMetricParamGroup), OutputType(typeof(PSMetric))]
+    [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.GenericBreakingChangeWithVersion("Parameter set GetWithDefaultParameters will be removed", "12.0.0", "6.0.0", "2024/05/21")]
+    [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.GenericBreakingChangeWithVersion("Parameter set GetWithFullParameters will be changed to List2 and be 'Default' set", "12.0.0", "6.0.0", "2024/05/21")]
+    [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletOutputBreakingChangeWithVersion(typeof(PSMetric), "12.0.0", "6.0.0", "2024/05/21", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.Metric.Models.IResponse", DeprecatedOutputProperties = new[] { "Microsoft.Azure.Commands.Insights.OutputClasses.PSMetric" } , NewOutputProperties = new[] { "Microsoft.Azure.PowerShell.Cmdlets.Metric.Models.ISubscriptionScopeMetricDefinition"})]
     public class GetAzureRmMetricCommand : ManagementCmdletBase
     {
         internal const string GetAzureRmAMetricParamGroup = "GetWithDefaultParameters";
@@ -52,6 +55,7 @@ public class GetAzureRmMetricCommand : ManagementCmdletBase
         /// <summary>
         /// Gets or sets the timegrain parameter of the cmdlet
         /// </summary>
+        [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletParameterBreakingChangeWithVersion("The interval (i.e.timegrain) of the query in ISO 8601 duration format", "12.0.0", "6.0.0", "2024/05/21")]
         [Parameter(ParameterSetName = GetAzureRmAMetricParamGroup, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The time grain of the query.")]
         [Parameter(ParameterSetName = GetAzureRmAMetricFullParamGroup, Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The time grain of the query.")]
         [ValidateNotNullOrEmpty]
@@ -111,7 +115,8 @@ public class GetAzureRmMetricCommand : ManagementCmdletBase
 
         /// <summary>
         /// Gets or sets the dimension parameter of the cmdlet
-        /// </summary>
+        /// </summary>]
+        [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletParameterBreakingChangeWithVersion("Parameter Dimension will be removed", "12.0.0", "6.0.0", "2024/05/21")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, HelpMessage = "The metric dimensions to query metrics for")]
         public string[] Dimension { get; set; }
 
@@ -127,6 +132,7 @@ public class GetAzureRmMetricCommand : ManagementCmdletBase
         /// <summary>
         /// Gets or sets the detailedoutput parameter of the cmdlet
         /// </summary>
+        [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletParameterBreakingChangeWithVersion("Parameter DetailedOutput will be removed", "12.0.0", "6.0.0", "2024/05/21")]
         [Parameter(ValueFromPipelineByPropertyName = true, HelpMessage = "Return object with all the details of the records (the default is to return only some attributes, i.e. no detail)")]
         public SwitchParameter DetailedOutput { get; set; }
 

src/Monitor/Monitor/Metrics/GetAzureRmMetricDefinitionCommand.cs

@@ -23,6 +23,7 @@ namespace Microsoft.Azure.Commands.Insights.Metrics
     /// Get the list of metric definitions for a resource.
     /// </summary>
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "MetricDefinition"), OutputType(typeof(PSMetricDefinition))]
+    [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletOutputBreakingChangeWithVersion(typeof(PSMetricDefinition), "12.0.0", "6.0.0", "2024/05/21", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.Metric.Models.IMetricDefinition")]
     public class GetAzureRmMetricDefinitionCommand : ManagementCmdletBase
     {
         /// <summary>
@@ -35,6 +36,7 @@ public class GetAzureRmMetricDefinitionCommand : ManagementCmdletBase
         /// <summary>
         /// Gets or sets the metricnames parameter of the cmdlet
         /// </summary>
+        [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletParameterBreakingChangeWithVersion("Parameter MetricName will be removed", "12.0.0", "6.0.0", "2024/05/21")]
         [Parameter(ValueFromPipelineByPropertyName = true, HelpMessage = "The metric names of the query")]
         [ValidateNotNullOrEmpty]
         public string[] MetricName { get; set; }
@@ -48,6 +50,7 @@ public class GetAzureRmMetricDefinitionCommand : ManagementCmdletBase
         /// <summary>
         /// Gets or sets the detailedoutput parameter of the cmdlet
         /// </summary>
+        [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.CmdletParameterBreakingChangeWithVersion("Parameter DetailedOutput will be removed", "12.0.0", "6.0.0", "2024/05/21")]
         [Parameter(HelpMessage = "Return object with all the details of the records (the default is to return only some attributes, i.e. no detail)")]
         public SwitchParameter DetailedOutput { get; set; }
 

src/Monitor/Monitor/Metrics/NewAzureRmMetricFilterCommand.cs

@@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.Insights.Metrics
     /// <summary>
     /// Create a metric dimension filter
     /// </summary>
+    [Microsoft.WindowsAzure.Commands.Common.CustomAttributes.GenericBreakingChangeWithVersion("Parameter DefaultProfile will be removed", "12.0.0", "6.0.0", "2024/05/21")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "MetricFilter"), OutputType(typeof(string))]
     public class NewAzureRmMetricFilterCommand : MonitorCmdletBase
     {