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

KacieKK · web-flow · commit 852b52c8cfd3 · 2022-09-27T12:58:09.000+08:00
* sku type

* dix

* fix

* fix

* fix

* fix

* revert

Co-authored-by: Kacie Kang &lt;jikang@microsoft.com&gt;
diff --git a/src/ApiManagement/ApiManagement/ApiManagementClient.cs b/src/ApiManagement/ApiManagement/ApiManagementClient.cs
@@ -129,7 +129,7 @@ public PsApiManagement CreateApiManagementService(
             string administratorEmail,
             Dictionary<string, string> tags,
             bool enableClientCertificate,
-            PsApiManagementSku sku = PsApiManagementSku.Developer,
+            string sku = SkuType.Developer,
             int? capacity = null,
             PsApiManagementVpnType vpnType = PsApiManagementVpnType.None,
             PsApiManagementVirtualNetwork virtualNetwork = null,
@@ -149,7 +149,7 @@ public PsApiManagement CreateApiManagementService(
 
             if(capacity == null)
             {
-                capacity = (sku == PsApiManagementSku.Consumption ? 0 : 1);
+                capacity = (sku == SkuType.Consumption ? 0 : 1);
             }
 
             var skuProperties = new ApiManagementServiceSkuProperties(skuType, capacity.Value);
diff --git a/src/ApiManagement/ApiManagement/ChangeLog.md b/src/ApiManagement/ApiManagement/ChangeLog.md
@@ -18,9 +18,10 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+*[Breaking Change]: changed the type of parameter Sku from Enum to String in `Add-AzApiManagementRegion`
+and `New-AzApiManagement` and `Update-AzApiManagementRegion`.
 
 ## Version 3.0.1
-* 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
diff --git a/src/ApiManagement/ApiManagement/Commands/AddAzureApiManagementRegion.cs b/src/ApiManagement/ApiManagement/Commands/AddAzureApiManagementRegion.cs
@@ -18,6 +18,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.Commands
     using System;
     using System.Management.Automation;
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.Azure.Management.ApiManagement.Models;
     using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using ResourceManager.Common.ArgumentCompleters;
 
@@ -39,12 +40,7 @@ public class AddAzureApiManagementRegion : AzureApiManagementCmdletBase
         [ValidateNotNullOrEmpty]
         public string Location { get; set; }
 
-        [CmdletParameterBreakingChange("Sku", OldParamaterType = typeof(PsApiManagementSku), NewParameterTypeName = nameof(String))]
-        [Parameter(
-            ValueFromPipelineByPropertyName = false,
-            Mandatory = false,
-            HelpMessage = "Tier of the deployment region. Valid and Default value is Premium.")]
-        public PsApiManagementSku? Sku { get; set; }
+
 
         [Parameter(
             ValueFromPipelineByPropertyName = false,
@@ -76,14 +72,20 @@ public class AddAzureApiManagementRegion : AzureApiManagementCmdletBase
         [Parameter(Mandatory = false, HelpMessage = "Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments")]
         public string PublicIpAddressId { get; set; }
 
+        [Parameter(
+        ValueFromPipelineByPropertyName = false,
+        Mandatory = false,
+        HelpMessage = "Tier of the deployment region. Valid and Default value is Premium.")]
+        public string Sku { get; set; }
+
         public override void ExecuteCmdlet()
         {
             ExecuteCmdLetWrap(
                 () =>
                 {
                     ApiManagement.AddRegion(
                         Location, 
-                        Sku ?? PsApiManagementSku.Premium, 
+                        Sku ?? SkuType.Premium, 
                         Capacity ?? 1,
                         VirtualNetwork,
                         Zone,
diff --git a/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs b/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs
@@ -20,6 +20,7 @@ namespace Microsoft.Azure.Commands.ApiManagement.Commands
     using System.Management.Automation;
     using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
+    using Microsoft.Azure.Management.ApiManagement.Models;
 
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagement"), OutputType(typeof(PsApiManagement))]
     public class NewAzureApiManagement : AzureApiManagementCmdletBase
@@ -60,13 +61,12 @@ 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,
             HelpMessage = "The tier of the Azure API Management service. Valid values are Developer, Basic, Standard, Premium and Consumption. The default value is Developer. ")]
         [ValidateSet("Developer", "Basic", "Standard", "Premium", "Consumption"), PSDefaultValue(Value = "Developer")]
-        public PsApiManagementSku? Sku { get; set; }
+        public string Sku { get; set; }
 
         [Parameter(
             ValueFromPipelineByPropertyName = true,
@@ -173,7 +173,7 @@ public override void ExecuteCmdlet()
                     AdminEmail,
                     Tag,
                     EnableClientCertificate.IsPresent,
-                    Sku ?? PsApiManagementSku.Developer,
+                    Sku ?? SkuType.Developer,
                     Capacity,
                     VpnType,
                     VirtualNetwork,
diff --git a/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagementRegion.cs b/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagementRegion.cs
@@ -16,6 +16,7 @@
 namespace Microsoft.Azure.Commands.ApiManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.Azure.Management.ApiManagement.Models;
     using ResourceManager.Common;
     using ResourceManager.Common.ArgumentCompleters;
     using System.Management.Automation;
@@ -67,7 +68,7 @@ public override void ExecuteCmdlet()
                 new PsApiManagementRegion
                 {
                     Location = Location,
-                    Sku = PsApiManagementSku.Premium, // additional regions are only supported in Premium Sku
+                    Sku = SkuType.Premium, // additional regions are only supported in Premium Sku
                     Capacity = Capacity.HasValue ? Capacity.Value : 1,
                     VirtualNetwork = VirtualNetwork,
                     Zone = Zone,
diff --git a/src/ApiManagement/ApiManagement/Commands/UpdateAzureApiManagementRegion.cs b/src/ApiManagement/ApiManagement/Commands/UpdateAzureApiManagementRegion.cs
@@ -44,7 +44,7 @@ public class UpdateAzureApiManagementRegion : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = true,
             Mandatory = true,
             HelpMessage = "New tier value for the deployment region. Valid values are Developer, Standard and Premium.")]
-        public PsApiManagementSku Sku { get; set; }
+        public string Sku { get; set; }
 
         [Parameter(
             ValueFromPipelineByPropertyName = true,
diff --git a/src/ApiManagement/ApiManagement/Helpers/Mappers.cs b/src/ApiManagement/ApiManagement/Helpers/Mappers.cs
@@ -49,30 +49,30 @@ public static PsApiManagementHostnameType MapHostnameType(string hostnameType)
             }
         }
 
-        public static string MapSku(PsApiManagementSku sku)
+        //public static string MapSku(string sku)
+        //{
+        //    switch (sku)
+        //    {
+        //        case PsApiManagementSku.Developer: return SkuType.Developer;
+        //        case PsApiManagementSku.Standard: return SkuType.Standard;
+        //        case PsApiManagementSku.Premium: return SkuType.Premium;
+        //        case PsApiManagementSku.Basic: return SkuType.Basic;
+        //        case PsApiManagementSku.Consumption: return SkuType.Consumption;
+        //        case PsApiManagementSku.Isolated: return SkuType.Isolated;
+        //        default: throw new ArgumentException($"Unrecognized Sku '{sku.ToString()}'");
+        //    }
+        //}
+
+        public static string MapSku(string sku)
         {
             switch (sku)
             {
-                case PsApiManagementSku.Developer: return SkuType.Developer;
-                case PsApiManagementSku.Standard: return SkuType.Standard;
-                case PsApiManagementSku.Premium: return SkuType.Premium;
-                case PsApiManagementSku.Basic: return SkuType.Basic;
-                case PsApiManagementSku.Consumption: return SkuType.Consumption;
-                case PsApiManagementSku.Isolated: return SkuType.Isolated;
-                default: throw new ArgumentException($"Unrecognized Sku '{sku.ToString()}'");
-            }
-        }
-
-        public static PsApiManagementSku MapSku(string sku)
-        {
-            switch (sku)
-            {
-                case SkuType.Developer: return PsApiManagementSku.Developer;
-                case SkuType.Standard: return PsApiManagementSku.Standard;
-                case SkuType.Premium: return PsApiManagementSku.Premium;
-                case SkuType.Basic: return PsApiManagementSku.Basic;
-                case SkuType.Consumption: return PsApiManagementSku.Consumption;
-                case SkuType.Isolated: return PsApiManagementSku.Isolated;
+                case SkuType.Developer: return SkuType.Developer;
+                case SkuType.Standard: return SkuType.Standard;
+                case SkuType.Premium: return SkuType.Premium;
+                case SkuType.Basic: return SkuType.Basic;
+                case SkuType.Consumption: return SkuType.Consumption;
+                case SkuType.Isolated: return SkuType.Isolated;
                 default: throw new ArgumentException($"Unrecognized Sku '{sku}'");
             }
         }
diff --git a/src/ApiManagement/ApiManagement/Models/PsApiManagement.cs b/src/ApiManagement/ApiManagement/Models/PsApiManagement.cs
@@ -44,7 +44,7 @@ public PsApiManagement(ApiManagementServiceResource apiServiceResource)
             Id = apiServiceResource.Id;
             Name = apiServiceResource.Name;
             Location = apiServiceResource.Location;
-            Sku = ApiManagementClient.Mapper.Map<string, PsApiManagementSku>(apiServiceResource.Sku.Name);
+            Sku = ApiManagementClient.Mapper.Map<string, string>(apiServiceResource.Sku.Name);
             Capacity = apiServiceResource.Sku.Capacity;
             CreatedTimeUtc = apiServiceResource.CreatedAtUtc;
             PublisherEmail = apiServiceResource.PublisherEmail;
@@ -162,7 +162,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 string Sku { get; set; }
 
         public int Capacity { get; set; }
 
@@ -258,7 +258,7 @@ public string ResourceGroupName
 
         public PsApiManagementRegion AddRegion(
             string location,
-            PsApiManagementSku sku = PsApiManagementSku.Developer,
+            string sku = SkuType.Developer,
             int capacity = 1,
             PsApiManagementVirtualNetwork virtualNetwork = null,
             string[] zone = null,
@@ -312,7 +312,7 @@ public bool RemoveRegion(string location)
 
         public void UpdateRegion(
             string location, 
-            PsApiManagementSku sku,
+            string sku,
             int capacity, 
             PsApiManagementVirtualNetwork virtualNetwork,
             string[] zone,
@@ -327,7 +327,7 @@ public void UpdateRegion(
             var regionToUpdate = AdditionalRegions.FirstOrDefault(r => location.Trim().Equals(r.Location, StringComparison.OrdinalIgnoreCase));
             if (regionToUpdate != null)
             {
-                // if this is additional region
+                // if this is additional region 
                 regionToUpdate.Sku = sku;
                 regionToUpdate.Capacity = capacity;
                 regionToUpdate.VirtualNetwork = virtualNetwork;
diff --git a/src/ApiManagement/ApiManagement/Models/PsApiManagementRegion.cs b/src/ApiManagement/ApiManagement/Models/PsApiManagementRegion.cs
@@ -59,7 +59,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 Sku { get; set; }
 
         public string Location { get; set; }
 
diff --git a/src/ApiManagement/ApiManagement/help/New-AzApiManagement.md b/src/ApiManagement/ApiManagement/help/New-AzApiManagement.md
@@ -16,7 +16,7 @@ Creates an API Management deployment.
 
 ```
 New-AzApiManagement -ResourceGroupName <String> -Name <String> -Location <String> -Organization <String>
- -AdminEmail <String> [-Sku <PsApiManagementSku>] [-Capacity <Int32>] [-VpnType <PsApiManagementVpnType>]
+ -AdminEmail <String> [-Sku <string>] [-Capacity <Int32>] [-VpnType <PsApiManagementVpnType>]
  [-VirtualNetwork <PsApiManagementVirtualNetwork>]
  [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
  [-AdditionalRegions <PsApiManagementRegion[]>]
diff --git a/src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md b/src/ApiManagement/ApiManagement/help/Update-AzApiManagementRegion.md
@@ -14,7 +14,7 @@ Updates existing deployment region in PsApiManagement instance.
 ## SYNTAX
 
 ```
-Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String> -Sku <PsApiManagementSku>
+Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Location <String> -Sku <string>
  -Capacity <Int32> [-VirtualNetwork <PsApiManagementVirtualNetwork>] [-Zone <String[]>]
  [-DisableGateway <Boolean>] [-PublicIpAddressId <String>] [-DefaultProfile <IAzureContextContainer>]
  [<CommonParameters>]
diff --git a/tools/StaticAnalysis/Exceptions/Az.ApiManagement/BreakingChangeIssues.csv b/tools/StaticAnalysis/Exceptions/Az.ApiManagement/BreakingChangeIssues.csv
