[APIM]add warning for upcoming breaking change (#17055)

* msg

* warning

* add using

* change desc

* alias

* order

Co-authored-by: Kacie Kang <[email protected]>

Author: KacieKK

src/ApiManagement/ApiManagement.ServiceManagement/Commands/NewAzureApiManagementOperation.cs

@@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
     using System;
     using System.Management.Automation;
     using Management.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementOperation")]
     [OutputType(typeof(PsApiManagementOperation))]
@@ -88,12 +89,16 @@ public class NewAzureApiManagementOperation : AzureApiManagementCmdletBase
                           " Use the parameter to give more details on parameters like description, type, possible values.")]
         public PsApiManagementParameter[] TemplateParameters { get; set; }
 
+        public const String ChangeDesc = "Change Request.Representations.Sample to Request.Representations.Example";
+        [CmdletParameterBreakingChange("Request.Representations.Sample", ChangeDescription = ChangeDesc)]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "Operation request details. This parameter is optional.")]
         public PsApiManagementRequest Request { get; set; }
 
+        public const String ChangeDesc2 = "Change Responses.Representations.Sample to Responses.Representations.Example";
+        [CmdletParameterBreakingChange("Responses.Representations.Sample", ChangeDescription = ChangeDesc2)]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,

src/ApiManagement/ApiManagement.ServiceManagement/Commands/SetAzureApiManagementOperation.cs

@@ -19,6 +19,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
     using Management.ApiManagement.Models;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Properties;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementOperation", SupportsShouldProcess = true)]
     [OutputType(typeof(PsApiManagementOperation))]
@@ -88,12 +89,16 @@ public class SetAzureApiManagementOperation : AzureApiManagementCmdletBase
                           " Use the parameter to give more details on parameters like description, type, possible values.")]
         public PsApiManagementParameter[] TemplateParameters { get; set; }
 
+        public const String ChangeDesc = "Change Request.Representations.Sample Request.Representations.Example";
+        [CmdletParameterBreakingChange("Request", ChangeDescription = ChangeDesc)]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "Operation request details. This parameter is optional.")]
         public PsApiManagementRequest Request { get; set; }
-
+        
+        public const String ChangeDesc2 = "Change Responses.Representations.Sample to Responses.Representations.Example";
+        [CmdletParameterBreakingChange("Responses", ChangeDescription = ChangeDesc2)]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,

src/ApiManagement/ApiManagement/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+Added warning message for upcoming breaking change.
 
 ## Version 2.3.1
 * Fixed a bug in `Get-AzApiManagementTenantGitAccess` cmdlet.

src/ApiManagement/documentation/upcoming-breaking-changes.md

@@ -25,4 +25,11 @@
     https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md
 -->
 
-# Upcoming Breaking Changes
+# Upcoming Breaking Changes
+
+The following cmdlets were affected this release:
+
+**Set-AzApiManagementOperation**
+**New-AzApiManagementOperation**
+
+BreakingChangeAttributeParameterReplaced: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation.Samlple