Merge pull request #5976 from cormacpayne/breaking-changes

Minor breaking changes for Build release

Author: cormacpayne

src/ResourceManager/ApiManagement/ChangeLog.md

@@ -19,6 +19,8 @@
 -->
 ## Current Release
 * Set minimum dependency of module to PowerShell 5.0
+* Introduce multiple breaking changes
+    - Please refer to the migration guide for more information
 
 ## Version 5.1.2
 * Updated to the latest version of the Azure ClientRuntime

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/NewAzureApiManagmentProperty.cs

@@ -1,11 +1,11 @@
-//  
+//
 // Copyright (c) Microsoft.  All rights reserved.
-// 
+//
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
 //  You may obtain a copy of the License at
 //    http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 //  Unless required by applicable law or agreed to in writing, software
 //  distributed under the License is distributed on an "AS IS" BASIS,
 //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -64,23 +64,19 @@ public class NewAzureApiManagementProperty : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "Tags to be associated with Property. This parameter is optional.")]
-        [Obsolete("New-AzureRmApiManagementProperty: -Tags will be removed in favor of -Tag in an upcoming breaking change release.  Please start using the -Tag parameter to avoid breaking scripts.")]
-        [Alias("Tags")]
         public string[] Tag { get; set; }
 
         public override void ExecuteApiManagementCmdlet()
         {
             string propertyId = PropertyId ?? Guid.NewGuid().ToString("N");
 
-#pragma warning disable CS0618
             var logger = Client.PropertyCreate(
                 Context,
                 propertyId,
                 Name,
                 Value,
                 Secret,
                 Tag);
-#pragma warning restore CS0618
 
             WriteObject(logger);
         }

src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementProperty.cs

@@ -1,11 +1,11 @@
-//  
+//
 // Copyright (c) Microsoft.  All rights reserved.
-// 
+//
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
 //  You may obtain a copy of the License at
 //    http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 //  Unless required by applicable law or agreed to in writing, software
 //  distributed under the License is distributed on an "AS IS" BASIS,
 //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -62,8 +62,6 @@ public class SetAzureApiManagementProperty : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "Tags associated with a property. This parameter is optional.")]
-        [Obsolete("Set-AzureRmApiManagementProperty: -Tags will be removed in favor of -Tag in an upcoming breaking change release.  Please start using the -Tag parameter to avoid breaking scripts.")]
-        [Alias("Tags")]
         public string[] Tag { get; set; }
 
         [Parameter(
@@ -76,15 +74,13 @@ public class SetAzureApiManagementProperty : AzureApiManagementCmdletBase
 
         public override void ExecuteApiManagementCmdlet()
         {
-#pragma warning disable CS0618
             Client.PropertySet(
                 Context,
                 PropertyId,
                 Name,
                 Value,
                 Secret,
                 Tag);
-#pragma warning restore CS0618
 
             if (PassThru)
             {

src/ResourceManager/ApiManagement/Commands.ApiManagement/Commands/NewAzureApiManagement.cs

@@ -1,11 +1,11 @@
-//  
+//
 // Copyright (c) Microsoft.  All rights reserved.
-// 
+//
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
 //  You may obtain a copy of the License at
 //    http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 //  Unless required by applicable law or agreed to in writing, software
 //  distributed under the License is distributed on an "AS IS" BASIS,
 //  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -77,7 +77,7 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = false,
             Mandatory = false,
             HelpMessage = "Virtual Network Type of the ApiManagement Deployment. Valid Values are " +
-                     " - None (Default Value. ApiManagement is not part of any Virtual Network)" + 
+                     " - None (Default Value. ApiManagement is not part of any Virtual Network)" +
                      " - External (ApiManagement Deployment is setup inside a Virtual Network having an Internet Facing Endpoint) " +
                      " - Internal (ApiManagement Deployment is setup inside a Virtual Network having an Intranet Facing Endpoint)")]
         [ValidateSet("None", "External", "Internal"), PSDefaultValue(Value = "None")]
@@ -93,8 +93,6 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
             ValueFromPipelineByPropertyName = true,
             Mandatory = false,
             HelpMessage = "Tags dictionary.")]
-        [Obsolete("New-AzureRmApiManagement: -Tags will be removed in favor of -Tag in an upcoming breaking change release.  Please start using the -Tag parameter to avoid breaking scripts.")]
-        [Alias("Tags")]
         public Dictionary<string, string> Tag { get; set; }
 
         [Parameter(
@@ -105,7 +103,6 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
 
         public override void ExecuteCmdlet()
         {
-#pragma warning disable CS0618
             ExecuteLongRunningCmdletWrap(
                 () => Client.BeginCreateApiManagementService(
                     ResourceGroupName,
@@ -120,7 +117,6 @@ public override void ExecuteCmdlet()
                     VirtualNetwork,
                     AdditionalRegions),
                 passThru: true);
-#pragma warning restore CS0618
         }
     }
 }

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagement.md

@@ -215,7 +215,7 @@ Tags dictionary.
 ```yaml
 Type: System.Collections.Generic.Dictionary`2[System.String,System.String]
 Parameter Sets: (All)
-Aliases: Tags
+Aliases:
 
 Required: False
 Position: Named

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementProperty.md

@@ -129,7 +129,7 @@ Tags to be associated with Property. This parameter is optional.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: Tags
+Aliases:
 
 Required: False
 Position: Named

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementProperty.md

@@ -144,7 +144,7 @@ Tags associated with a property. This parameter is optional.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: Tags
+Aliases:
 
 Required: False
 Position: Named