azure api management breaking change notifications (#11602)

* azure api management breaking change notifications

* notification param fixed

Co-authored-by: vfedonkin <[email protected]>

Author: vfedonkin

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementAuthorizationServer.cs

@@ -17,7 +17,9 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
     using System;
     using System.Management.Automation;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
+    [GenericBreakingChange("Output changed: ClientSecret will not be returned anymore. Additional cmdlet will be added to retrieve ClientSecret.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementAuthorizationServer", DefaultParameterSetName = ContextParameterSet)]
     [OutputType(typeof(PsApiManagementOAuth2AuthorizationServer))]
     public class GetAzureApiManagementAuthorizationServer : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementIdentityProvider.cs

@@ -17,7 +17,9 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
     using System;
     using System.Management.Automation;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
+    [GenericBreakingChange("Output changed: ClientSecret will not be returned anymore. Additional cmdlet will be added to retrieve ClientSecret.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementIdentityProvider", DefaultParameterSetName = AllIdentityProviders)]
     [OutputType(typeof(PsApiManagementIdentityProvider))]
     public class GetAzureApiManagementIdentityProvider : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementOpenIdConnectProvider.cs

@@ -15,10 +15,12 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Collections.Generic;
     using System.Management.Automation;
 
+    [GenericBreakingChange("Output changed: ClientSecret will not be returned anymore. Additional cmdlet will be added to retrieve ClientSecret.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementOpenIdConnectProvider", DefaultParameterSetName = GetAll)]
     [OutputType(typeof(PsApiManagementOpenIdConnectProvider))]
     public class GetAzureApiManagementOpenIdConnectProvider : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementProperty.cs

@@ -15,10 +15,12 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Collections.Generic;
     using System.Management.Automation;
 
+    [CmdletDeprecation(ReplacementCmdletName = "Get-AzureApiManagementNamedValue")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementProperty", DefaultParameterSetName = GetAll)]
     [OutputType(typeof(PsApiManagementProperty))]
     public class GetAzureApiManagementProperty : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementSubscription.cs

@@ -15,9 +15,11 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Management.Automation;
 
+    [GenericBreakingChange("Output changed: Subscription keys will not be returned anymore. Additional cmdlet will be added to retrieve subscription keys.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementSubscription", DefaultParameterSetName = GetAll)]
     [OutputType(typeof(PsApiManagementSubscription), ParameterSetName = new[] { GetAll, GetBySubscriptionId, GetByUserId, GetByScope, GetByProductIdAndUser, GetByProductId })]
     public class GetAzureApiManagementSubscription : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantAccess.cs

@@ -15,8 +15,10 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Management.Automation;
 
+    [GenericBreakingChange("Output changed: Keys will not be returned anymore. Additional cmdlet will be added to retrieve the keys.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementTenantAccess")]
     [OutputType(typeof(PsApiManagementAccessInformation))]
     public class GetAzureRmApiManagementTenantAccess : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantGitAccess.cs

@@ -15,8 +15,10 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Management.Automation;
 
+    [GenericBreakingChange("Output changed: Keys will not be returned anymore. Additional cmdlet will be added to retrieve the keys.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementTenantGitAccess")]
     [OutputType(typeof(PsApiManagementAccessInformation))]
     public class GetAzureRmApiManagementTenantGitAccess : AzureApiManagementCmdletBase

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

@@ -15,9 +15,11 @@
 namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Management.Automation;
 
+    [CmdletDeprecation(ReplacementCmdletName = "New-AzureApiManagementNamedValue")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementProperty")]
     [OutputType(typeof(PsApiManagementProperty))]
     public class NewAzureApiManagementProperty : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement.ServiceManagement/Commands/RemoveAzureApiManagementProperty.cs

@@ -16,10 +16,12 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Properties;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Globalization;
     using System.Management.Automation;
 
+    [CmdletDeprecation(ReplacementCmdletName = "Remove-AzureApiManagementNamedValue")]
     [Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementProperty", SupportsShouldProcess = true)]
     [OutputType(typeof(bool))]
     public class RemoveAzureApiManagementProperty : AzureApiManagementCmdletBase

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

@@ -16,9 +16,11 @@ namespace Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models;
     using Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Properties;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System;
     using System.Management.Automation;
 
+    [CmdletDeprecation(ReplacementCmdletName = "Set-AzureApiManagementNamedValue")]
     [Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ApiManagementProperty", SupportsShouldProcess = true)]
     [OutputType(typeof(PsApiManagementProperty))]
     public class SetAzureApiManagementProperty : AzureApiManagementCmdletBase

src/ApiManagement/ApiManagement/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Add breaking change notice for Azure File cmdlets output change in a future release
 * `Set-AzApiManagementGroup` Updated documentation to specify the GroupId parameter
 
 ## Version 1.4.0

src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs

@@ -15,6 +15,7 @@
 namespace Microsoft.Azure.Commands.ApiManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using ResourceManager.Common.ArgumentCompleters;
     using System.Collections.Generic;
     using System.Management.Automation;
@@ -119,6 +120,7 @@ public class NewAzureApiManagement : AzureApiManagementCmdletBase
 
         [Parameter(Mandatory = false,
             HelpMessage = "Generate and assign an Azure Active Directory Identity for this service for use with key management services like Azure KeyVault.")]
+        [CmdletParameterBreakingChange("AssignIdentity", ChangeDescription = "The AssignIdentity parameter will be renamed as SystemAssignedIdentity. Also new parameter will be added: UserAssignedIdentity.")]
         public SwitchParameter AssignIdentity { get; set; }
 
         [Parameter(Mandatory = false,

src/ApiManagement/ApiManagement/Commands/SetAzureApiManagement.cs

@@ -15,6 +15,7 @@
 namespace Microsoft.Azure.Commands.ApiManagement.Commands
 {
     using Microsoft.Azure.Commands.ApiManagement.Models;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using Properties;
     using System.Management.Automation;
 
@@ -30,6 +31,7 @@ public class SetAzureApiManagement : AzureApiManagementCmdletBase
 
         [Parameter(Mandatory = false,
             HelpMessage = "Generate and assign an Azure Active Directory Identity for this server for use with key management services like Azure KeyVault.")]
+        [CmdletParameterBreakingChange("AssignIdentity", ChangeDescription = "The AssignIdentity parameter will be renamed as SystemAssignedIdentity. Also new parameter will be added: UserAssignedIdentity.")]
         public SwitchParameter AssignIdentity { get; set; }
 
         [Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background")]