[API Management] breaking change warning to make Sku property from Enum to String (#19126)

* impl

* changelog

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

Author: KacieKK

src/ApiManagement/ApiManagement/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added warning message for upcoming breaking change: changed the type of parameter Sku from Enum to String
 * Supported GraphQL Specification Format
 
 ## Version 3.0.0
@@ -26,7 +27,7 @@
 * Updated APIM .Net SDK version to 8.0.0 / Api Version 2021-08-01
 
 ## Version 2.3.2
-Added warning message for upcoming breaking change.
+* Added warning message for upcoming breaking change.
 
 ## Version 2.3.1
 * Fixed a bug in `Get-AzApiManagementTenantGitAccess` cmdlet.

src/ApiManagement/ApiManagement/Commands/AddAzureApiManagementRegion.cs

@@ -15,9 +15,11 @@
 
 namespace Microsoft.Azure.Commands.ApiManagement.Commands
 {
+    using System;
+    using System.Management.Automation;
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using ResourceManager.Common.ArgumentCompleters;
-    using System.Management.Automation;
 
     [Cmdlet("Add", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementRegion"), OutputType(typeof(PsApiManagement))]
     public class AddAzureApiManagementRegion : AzureApiManagementCmdletBase
@@ -37,6 +39,7 @@ public class AddAzureApiManagementRegion : AzureApiManagementCmdletBase
         [ValidateNotNullOrEmpty]
         public string Location { get; set; }
 
+        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
         [Parameter(
             ValueFromPipelineByPropertyName = false,
             Mandatory = false,

src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs

@@ -18,6 +18,8 @@ namespace Microsoft.Azure.Commands.ApiManagement.Commands
     using ResourceManager.Common.ArgumentCompleters;
     using System.Collections.Generic;
     using System.Management.Automation;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+    using System;
 
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagement"), OutputType(typeof(PsApiManagement))]
     public class NewAzureApiManagement : AzureApiManagementCmdletBase
@@ -58,6 +60,7 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
         [ValidatePattern(@"^[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)*@([a-zA-Z0-9_]+[a-zA-Z0-9_-]*\.)+[a-zA-Z]{2,63}$")]
         public string AdminEmail { get; set; }
 
+        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,

src/ApiManagement/ApiManagement/Commands/UpdateAzureApiManagementRegion.cs

@@ -15,9 +15,11 @@
 
 namespace Microsoft.Azure.Commands.ApiManagement.Commands
 {
+    using System;
+    using System.Management.Automation;
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using ResourceManager.Common.ArgumentCompleters;
-    using System.Management.Automation;
 
     [Cmdlet("Update", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementRegion"), OutputType(typeof(PsApiManagement))]
     public class UpdateAzureApiManagementRegion : AzureApiManagementCmdletBase
@@ -37,6 +39,7 @@ public class UpdateAzureApiManagementRegion : AzureApiManagementCmdletBase
         [ValidateNotNullOrEmpty]
         public string Location { get; set; }
 
+        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
         [Parameter(
             ValueFromPipelineByPropertyName = true,
             Mandatory = true,

src/ApiManagement/ApiManagement/Models/PsApiManagement.cs

@@ -20,6 +20,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.Models
     using System.Text.RegularExpressions;
     using Microsoft.Azure.Commands.ApiManagement.Properties;
     using Microsoft.Azure.Management.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     public class PsApiManagement
     {
@@ -160,6 +161,7 @@ public PsApiManagement(ApiManagementServiceResource apiServiceResource)
 
         public string Location { get; private set; }
 
+        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
         public PsApiManagementSku Sku { get; set; }
 
         public int Capacity { get; set; }

src/ApiManagement/ApiManagement/Models/PsApiManagementRegion.cs

@@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.Models
     using Helpers;
     using System;
     using System.Linq;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     public class PsApiManagementRegion
     {
@@ -57,6 +58,7 @@ internal PsApiManagementRegion(AdditionalLocation additionalLocation)
 
         public int Capacity { get; set; }
 
+        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
         public PsApiManagementSku Sku { get; set; }
 
         public string Location { get; set; }

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

@@ -29,7 +29,8 @@
 
 The following cmdlets were affected this release:
 
-**Set-AzApiManagementOperation**
-**New-AzApiManagementOperation**
+**Add-AzApiManagementRegion**
+**New-AzApiManagement**
+**Update-AzApiManagementRegion**
 
-BreakingChangeAttributeParameterReplaced: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation.Samlple
+BreakingChangeAttributeParameterReplaced: Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku