Skip to content

Commit 21f3dc6

Browse files
Ptnan7Jingnan XuCopilot
authored
Update Beaking change message for fd (#28763)
Co-authored-by: Jingnan Xu <jingnanxu@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent eec21c3 commit 21f3dc6

31 files changed

+114
-1
lines changed

src/FrontDoor/FrontDoor/ChangeLog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
-->
2020
## Upcoming Release
2121

22+
* Added breaking change messages for next version
23+
2224
## Version 1.13.0
2325
* Added support for Captcha
2426

src/FrontDoor/FrontDoor/Cmdlets/DisableFrontDoorCustomDomainHttps.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
using Microsoft.Azure.Management.FrontDoor;
2121
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
2222
using System.Management.Automation;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2526
{
2627
/// <summary>
2728
/// Defines the Enable-AzCustomDomainHttps cmdlet.
2829
/// </summary>
30+
[CmdletOutputBreakingChangeWithVersion(typeof(PSFrontendEndpoint), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "System.Boolean", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint'.")]
2931
[Cmdlet("Disable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorCustomDomainHttps", SupportsShouldProcess = true, DefaultParameterSetName = FieldsParameterSet), OutputType(typeof(PSFrontendEndpoint))]
3032
public class DisableFrontDoorCustomDomainHttps : AzureFrontDoorCmdletBase
3133
{

src/FrontDoor/FrontDoor/Cmdlets/EnableFrontDoorCustomDomainHttps.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
2222
using Microsoft.WindowsAzure.Commands.Utilities.Common;
2323
using System.Management.Automation;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2627
{
2728
/// <summary>
2829
/// Defines the Enable-AzCustomDomainHttps cmdlet.
2930
/// </summary>
31+
[CmdletOutputBreakingChangeWithVersion(typeof(PSFrontendEndpoint), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "System.Boolean", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint'.")]
3032
[Cmdlet("Enable", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorCustomDomainHttps", SupportsShouldProcess = true, DefaultParameterSetName = FieldsParameterSet), OutputType(typeof(PSFrontendEndpoint))]
3133
public class EnableFrontDoorCustomDomainHttps : AzureFrontDoorCmdletBase
3234
{

src/FrontDoor/FrontDoor/Cmdlets/GetFrontDoor.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
using System.Linq;
2121
using System.Management.Automation;
2222
using System.Net;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2526
{
2627
/// <summary>
2728
/// Defines the Get-AzFrontDoor cmdlet.
2829
/// </summary>
30+
[CmdletOutputBreakingChangeWithVersion(typeof(PSFrontDoor), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontDoor", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor'.")]
2931
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoor"), OutputType(typeof(PSFrontDoor))]
3032
public class GetFrontDoor : AzureFrontDoorCmdletBase
3133
{

src/FrontDoor/FrontDoor/Cmdlets/GetFrontDoorFrontendEndpoint.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
2222
using System.Linq;
2323
using System.Management.Automation;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2627
{
2728
/// <summary>
2829
/// Defines the Get-FrontDoorFrontendEndpoint cmdlet.
2930
/// </summary>
31+
[CmdletOutputBreakingChangeWithVersion(typeof(PSFrontendEndpoint), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontendEndpoint", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint'.")]
3032
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorFrontendEndpoint", DefaultParameterSetName = FieldsParameterSet), OutputType(typeof(PSFrontendEndpoint))]
3133
public class GetFrontDoorFrontendEndpoint : AzureFrontDoorCmdletBase
3234
{
@@ -57,6 +59,7 @@ public class GetFrontDoorFrontendEndpoint : AzureFrontDoorCmdletBase
5759
/// <summary>
5860
///The Front Door object.
5961
/// </summary>
62+
[CmdletParameterBreakingChangeWithVersion("FrontDoorObject", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontDoorIdentity", ChangeDescription = "The element type for parameter 'FrontDoorObject' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontDoorIdentity'.")]
6063
[Parameter(Mandatory = true, ParameterSetName = ObjectParameterSet, ValueFromPipeline = true, HelpMessage = "The FrontDoor object.")]
6164
[ValidateNotNullOrEmpty]
6265
public PSFrontDoor FrontDoorObject { get; set; }

src/FrontDoor/FrontDoor/Cmdlets/GetFrontDoorRulesEngine.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@
2121
using System.Collections.Generic;
2222
using System.Management.Automation;
2323
using System.Net;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2627
{
28+
[CmdletOutputBreakingChangeWithVersion(typeof(PSRulesEngine), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IRulesEngine", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSRulesEngine'.")]
2729
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoor" + "RulesEngine"), OutputType(typeof(PSRulesEngine))]
2830
public class GetFrontDoorRulesEngine : AzureFrontDoorCmdletBase
2931
{

src/FrontDoor/FrontDoor/Cmdlets/GetFrontDoorWafManagedRuleSetDefinition.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
using System.Collections.Generic;
2121
using System.Linq;
2222
using System.Management.Automation;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2526
{
2627
/// <summary>
2728
/// Defines the Get-AzFrontDoorWafManagedRuleSetDefinition cmdlet.
2829
/// </summary>
30+
[CmdletOutputBreakingChangeWithVersion(typeof(PSManagedRuleSetDefinition), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IManagedRuleSetDefinition", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSManagedRuleSetDefinition'.")]
2931
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorWafManagedRuleSetDefinition"), OutputType(typeof(PSManagedRuleSetDefinition))]
3032
public class GetFrontDoorWafManagedRuleSetDefinition : AzureFrontDoorCmdletBase
3133
{

src/FrontDoor/FrontDoor/Cmdlets/GetFrontDoorWafPolicy.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
using System.Linq;
2121
using System.Management.Automation;
2222
using System.Net;
23+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2324

2425
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2526
{
2627
/// <summary>
2728
/// Defines the Get-AzFrontDoorFireWallPolicy cmdlet.
2829
/// </summary>
30+
[CmdletOutputBreakingChangeWithVersion(typeof(PSPolicy), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IWebApplicationFirewallPolicy", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSPolicy'.")]
2931
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorWafPolicy"), OutputType(typeof(PSPolicy))]
3032
public class GetFrontDoorWafPolicy : AzureFrontDoorCmdletBase
3133
{

src/FrontDoor/FrontDoor/Cmdlets/NewFrontDoor.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
using System.Collections;
2222
using System.Linq;
2323
using System.Management.Automation;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2627
{
2728
/// <summary>
2829
/// Defines the New-AzFrontDoor cmdlet.
2930
/// </summary>
31+
[CmdletOutputBreakingChangeWithVersion(typeof(PSFrontDoor), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontDoor", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontDoor'.")]
3032
[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoor", DefaultParameterSetName = FieldsWithBackendPoolsSettingParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSFrontDoor))]
3133
public class NewFrontDoor : AzureFrontDoorCmdletBase
3234
{
@@ -47,30 +49,35 @@ public class NewFrontDoor : AzureFrontDoorCmdletBase
4749
/// <summary>
4850
/// Routing rules associated with this Front Door
4951
/// </summary>
52+
[CmdletParameterBreakingChangeWithVersion("RoutingRule", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IRoutingRule[]", ChangeDescription = "The element type for parameter 'RoutingRule' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSRoutingRule' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IRoutingRule'.")]
5053
[Parameter(Mandatory = true, HelpMessage = "Routing rules associated with this Front Door")]
5154
public PSRoutingRule[] RoutingRule { get; set; }
5255

5356
/// <summary>
5457
/// Backendpools available to routing rule.
5558
/// </summary>
59+
[CmdletParameterBreakingChangeWithVersion("BackendPool", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IBackendPool[]", ChangeDescription = "The element type for parameter 'BackendPool' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPool' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IBackendPool'.")]
5660
[Parameter(Mandatory = true, HelpMessage = "Backendpools available to routing rule.")]
5761
public PSBackendPool[] BackendPool { get; set; }
5862

5963
/// <summary>
6064
/// Frontend endpoints available to routing rule.
6165
/// </summary>
66+
[CmdletParameterBreakingChangeWithVersion("FrontendEndpoint", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontendEndpoint[]", ChangeDescription = "The element type for parameter 'FrontendEndpoint' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSFrontendEndpoint' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IFrontendEndpoint'.")]
6267
[Parameter(Mandatory = true, HelpMessage = "Frontend endpoints available to routing rule.")]
6368
public PSFrontendEndpoint[] FrontendEndpoint { get; set; }
6469

6570
/// <summary>
6671
/// Load balancing settings associated with this Front Door instance.
6772
/// </summary>
73+
[CmdletParameterBreakingChangeWithVersion("LoadBalancingSetting", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.ILoadBalancingSettingsModel[]", ChangeDescription = "The element type for parameter 'LoadBalancingSetting' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSLoadBalancingSetting' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.ILoadBalancingSettingsModel'.")]
6874
[Parameter(Mandatory = true, HelpMessage = "Load balancing settings associated with this Front Door instance.")]
6975
public PSLoadBalancingSetting[] LoadBalancingSetting { get; set; }
7076

7177
/// <summary>
7278
/// Health probe settings associated with this Front Door instance.
7379
/// </summary>
80+
[CmdletParameterBreakingChangeWithVersion("HealthProbeSetting", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IHealthProbeSettingsModel[]", ChangeDescription = "The element type for parameter 'HealthProbeSetting' has been changed from 'Microsoft.Azure.Commands.FrontDoor.Models.PSHealthProbeSetting' to 'Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IHealthProbeSettingsModel'.")]
7481
[Parameter(Mandatory = true, HelpMessage = "Health probe settings associated with this Front Door instance.")]
7582
public PSHealthProbeSetting[] HealthProbeSetting { get; set; }
7683

@@ -83,6 +90,7 @@ public class NewFrontDoor : AzureFrontDoorCmdletBase
8390
/// <summary>
8491
/// Enabled state of the Front Door load balancer.
8592
/// </summary>
93+
[CmdletParameterBreakingChangeWithVersion("EnabledState", "15.0.0", "6.0.0", NewParameterTypeName = "System.String", ChangeDescription = "no longer supports the type 'Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState' for parameter 'EnabledState'.")]
8694
[Parameter(Mandatory = false, HelpMessage = "Enabled state of the Front Door load balancer. Default value is Enabled")]
8795
public PSEnabledState EnabledState { get; set; }
8896

@@ -96,6 +104,7 @@ public class NewFrontDoor : AzureFrontDoorCmdletBase
96104
/// <summary>
97105
/// Settings for all backendPools
98106
/// </summary>
107+
[CmdletParameterBreakingChangeWithVersion("BackendPoolsSetting", "15.0.0", "6.0.0", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.IBackendPoolsSettings", ChangeDescription = "no longer supports the type 'Microsoft.Azure.Commands.FrontDoor.Models.PSBackendPoolsSetting' for parameter 'BackendPoolsSetting'.")]
99108
[Parameter(ParameterSetName = FieldsWithBackendPoolsSettingParameterSet,
100109
Mandatory = false, HelpMessage = "Settings for all backendPools")]
101110
public PSBackendPoolsSetting BackendPoolsSetting { get; set; }

src/FrontDoor/FrontDoor/Cmdlets/NewFrontDoorBackendObject.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616
using Microsoft.Azure.Commands.FrontDoor.Models;
1717
using Microsoft.WindowsAzure.Commands.Utilities.Common;
1818
using System.Management.Automation;
19+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
1920

2021
namespace Microsoft.Azure.Commands.FrontDoor.Cmdlets
2122
{
2223
/// <summary>
2324
/// Defines the New-AzFrontDoorRoutingRuleObject cmdlet.
2425
/// </summary>
26+
[CmdletOutputBreakingChangeWithVersion(typeof(PSBackend), "15.0.0", "6.0.0", ReplacementCmdletOutputTypeName = "Microsoft.Azure.PowerShell.Cmdlets.FrontDoor.Models.Backend", ChangeDescription = "no longer has output type 'Microsoft.Azure.Commands.FrontDoor.Models.PSBackend'.")]
2527
[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "FrontDoorBackendObject"), OutputType(typeof(PSBackend))]
2628
public class NewFrontDoorBackendObject : AzureFrontDoorCmdletBase
2729
{
@@ -63,6 +65,7 @@ public class NewFrontDoorBackendObject : AzureFrontDoorCmdletBase
6365
/// <summary>
6466
/// Whether to enable use of this backend.
6567
/// </summary>
68+
[CmdletParameterBreakingChangeWithVersion("EnabledState", "15.0.0", "6.0.0", NewParameterTypeName = "System.String", ChangeDescription = "no longer supports the type 'Microsoft.Azure.Commands.FrontDoor.Models.PSEnabledState' for parameter 'EnabledState'.")]
6669
[Parameter(Mandatory = false, HelpMessage = "Whether to enable use of this backend. Default value is Enabled")]
6770
public PSEnabledState EnabledState { get; set; }
6871

0 commit comments

Comments
 (0)