diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementAuthorizationServer.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementAuthorizationServer.cs index c5f4473c5be0..0021246e15c2 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementAuthorizationServer.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementIdentityProvider.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementIdentityProvider.cs index a8cf6136a563..f6484bbf755c 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementIdentityProvider.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementOpenIdConnectProvider.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementOpenIdConnectProvider.cs index 90ec889740c2..d161aac1b25f 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementOpenIdConnectProvider.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementProperty.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementProperty.cs index fceeb9c49b13..f19174921c5d 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementProperty.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementSubscription.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementSubscription.cs index 949382c52ae5..e8f257ca8b1f 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureApiManagementSubscription.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantAccess.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantAccess.cs index c9ba4f66f839..0bb73146606b 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantAccess.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantGitAccess.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantGitAccess.cs index 0c6e3650922a..449d42fabb70 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/GetAzureRmApiManagementTenantGitAccess.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/NewAzureApiManagmentProperty.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/NewAzureApiManagmentProperty.cs index 651b5c7717d6..c9c5a2cf709b 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/NewAzureApiManagmentProperty.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/RemoveAzureApiManagementProperty.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/RemoveAzureApiManagementProperty.cs index 4b684e39c3a1..4ca778921f97 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/RemoveAzureApiManagementProperty.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/SetAzureApiManagementProperty.cs b/src/ApiManagement/ApiManagement.ServiceManagement/Commands/SetAzureApiManagementProperty.cs index c60ae74ee258..7a0b131b6630 100644 --- a/src/ApiManagement/ApiManagement.ServiceManagement/Commands/SetAzureApiManagementProperty.cs +++ b/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 diff --git a/src/ApiManagement/ApiManagement/ChangeLog.md b/src/ApiManagement/ApiManagement/ChangeLog.md index 4113aae2b1a4..6ab7bf2e333b 100644 --- a/src/ApiManagement/ApiManagement/ChangeLog.md +++ b/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 diff --git a/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs b/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs index 75371544a0fe..3a68a2d4e2dd 100644 --- a/src/ApiManagement/ApiManagement/Commands/NewAzureApiManagement.cs +++ b/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, diff --git a/src/ApiManagement/ApiManagement/Commands/SetAzureApiManagement.cs b/src/ApiManagement/ApiManagement/Commands/SetAzureApiManagement.cs index e07756739320..b12d3a57f669 100644 --- a/src/ApiManagement/ApiManagement/Commands/SetAzureApiManagement.cs +++ b/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")]