From 15c29da513f37e47be721068afc669dc8037f50d Mon Sep 17 00:00:00 2001 From: wyunchi-ms Date: Wed, 12 Aug 2020 14:01:55 +0800 Subject: [PATCH] Add breaking change notification --- src/Aks/Aks/Commands/NewKubeBase.cs | 4 ++++ .../Resources/ManagementGroups/GetAzureRmManagementGroup.cs | 3 +++ .../Resources/ManagementGroups/NewAzureRmManagementGroup.cs | 4 ++++ .../ManagementGroups/NewAzureRmManagementGroupSubscription.cs | 3 +++ .../ManagementGroups/RemoveAzureRmManagementGroup.cs | 3 +++ .../RemoveAzureRmManagementGroupSubscription.cs | 3 +++ .../ManagementGroups/UpdateAzureRmManagementGroup.cs | 3 +++ src/Resources/Resources/help/Get-AzManagementGroup.md | 2 +- src/Resources/Resources/help/New-AzManagementGroup.md | 2 +- .../Resources/help/New-AzManagementGroupSubscription.md | 2 +- src/Resources/Resources/help/Remove-AzManagementGroup.md | 2 +- .../Resources/help/Remove-AzManagementGroupSubscription.md | 2 +- src/Resources/Resources/help/Update-AzManagementGroup.md | 2 +- 13 files changed, 29 insertions(+), 6 deletions(-) diff --git a/src/Aks/Aks/Commands/NewKubeBase.cs b/src/Aks/Aks/Commands/NewKubeBase.cs index 044ff23fcc12..c559f6f25d9f 100644 --- a/src/Aks/Aks/Commands/NewKubeBase.cs +++ b/src/Aks/Aks/Commands/NewKubeBase.cs @@ -21,12 +21,14 @@ using Microsoft.Azure.Commands.ResourceManager.Common.Tags; using Microsoft.Azure.Management.ContainerService.Models; using Microsoft.WindowsAzure.Commands.Common; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; using Microsoft.WindowsAzure.Commands.Utilities.Common; namespace Microsoft.Azure.Commands.Aks { public abstract class NewKubeBase : CreateOrUpdateKubeBase { + [CmdletParameterBreakingChange("NodeVmSetType", ChangeDescription = "Default value will be changed from AvailabilitySet to VirtualMachineScaleSets.")] [Parameter(Mandatory = false, HelpMessage = "Represents types of an node pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'")] [PSArgumentCompleter("AvailabilitySet", "VirtualMachineScaleSets")] public string NodeVmSetType { get; set; } @@ -37,6 +39,7 @@ public abstract class NewKubeBase : CreateOrUpdateKubeBase [Parameter(Mandatory = false, HelpMessage = "Maximum number of pods that can run on node.")] public int NodeMaxPodCount { get; set; } + [CmdletParameterBreakingChange("NodeOsType", ChangeDescription = "NodeOsType will be removed as it supports only one value Linux.")] [Parameter(Mandatory = false, HelpMessage = "OsType to be used to specify os type, currently support 'Linux' only here.")] [PSArgumentCompleter("Linux")] public string NodeOsType { get; set; } @@ -92,6 +95,7 @@ public abstract class NewKubeBase : CreateOrUpdateKubeBase + "At least one lower case, one upper case, one special character !@#$%^&*(), the minimum lenth is 12.")] public SecureString WindowsProfileAdminUserPassword { get; set; } + [CmdletParameterBreakingChange("NetworkPlugin", ChangeDescription = "Default value will be changed from None to azure.")] [Parameter(Mandatory = false, HelpMessage = "Network plugin used for building Kubernetes network.")] [PSArgumentCompleter("azure", "kubenet")] public string NetworkPlugin { get; set; } diff --git a/src/Resources/Resources/ManagementGroups/GetAzureRmManagementGroup.cs b/src/Resources/Resources/ManagementGroups/GetAzureRmManagementGroup.cs index f16141650f4f..18729c76f284 100644 --- a/src/Resources/Resources/ManagementGroups/GetAzureRmManagementGroup.cs +++ b/src/Resources/Resources/ManagementGroups/GetAzureRmManagementGroup.cs @@ -18,6 +18,7 @@ using Microsoft.Azure.Commands.Resources.Models.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; namespace Microsoft.Azure.Commands.Resources.ManagementGroups { @@ -30,6 +31,8 @@ public class GetAzureRmManagementGroup : AzureManagementGroupsCmdletBase /// /// Get-AzManagementGroup Cmdlet /// + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.GetParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] public string GroupName { get; set; } diff --git a/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroup.cs b/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroup.cs index 2e10eafb18bf..d0945fd4e024 100644 --- a/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroup.cs +++ b/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroup.cs @@ -17,6 +17,8 @@ using Microsoft.Azure.Commands.Resources.Models.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; + using Newtonsoft.Json; using Newtonsoft.Json.Linq; @@ -28,6 +30,8 @@ namespace Microsoft.Azure.Commands.Resources.ManagementGroups [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ManagementGroup", DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, SupportsShouldProcess = true), OutputType(typeof(PSManagementGroup))] public class NewAzureRmManagementGroup : AzureManagementGroupsCmdletBase { + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] [Parameter(ParameterSetName = Constants.ParameterSetNames.ParentGroupParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.ParentObject)] diff --git a/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroupSubscription.cs b/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroupSubscription.cs index 76f67ee42ee6..919e292f5f71 100644 --- a/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroupSubscription.cs +++ b/src/Resources/Resources/ManagementGroups/NewAzureRmManagementGroupSubscription.cs @@ -17,6 +17,7 @@ using Microsoft.Azure.Commands.Resources.ManagementGroups.Common; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; namespace Microsoft.Azure.Commands.Resources.ManagementGroups { @@ -26,6 +27,8 @@ namespace Microsoft.Azure.Commands.Resources.ManagementGroups [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ManagementGroupSubscription",DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet,SupportsShouldProcess = true), OutputType(typeof(bool))] public class NewAzureRmManagementGroupSubscription : AzureManagementGroupsCmdletBase { + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] [ValidateNotNullOrEmpty] diff --git a/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroup.cs b/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroup.cs index 46a2f6c43472..a04206f8c8c7 100644 --- a/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroup.cs +++ b/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroup.cs @@ -17,6 +17,7 @@ using Microsoft.Azure.Commands.Resources.Models.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; namespace Microsoft.Azure.Commands.Resources.ManagementGroups { @@ -32,6 +33,8 @@ public class RemoveAzureRmManagementGroup : AzureManagementGroupsCmdletBase [ValidateNotNullOrEmpty] public PSManagementGroup InputObject { get; set; } + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] [ValidateNotNullOrEmpty] diff --git a/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroupSubscription.cs b/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroupSubscription.cs index 0d0051a80360..09e1a74bd09a 100644 --- a/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroupSubscription.cs +++ b/src/Resources/Resources/ManagementGroups/RemoveAzureRmManagementGroupSubscription.cs @@ -17,6 +17,7 @@ using Microsoft.Azure.Commands.Resources.ManagementGroups.Common; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; namespace Microsoft.Azure.Commands.Resources.ManagementGroups { @@ -26,6 +27,8 @@ namespace Microsoft.Azure.Commands.Resources.ManagementGroups [Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ManagementGroupSubscription",DefaultParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet,SupportsShouldProcess = true), OutputType(typeof(bool))] public class RemoveAzureRmManagementGroupSubscription : AzureManagementGroupsCmdletBase { + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] [ValidateNotNullOrEmpty] diff --git a/src/Resources/Resources/ManagementGroups/UpdateAzureRmManagementGroup.cs b/src/Resources/Resources/ManagementGroups/UpdateAzureRmManagementGroup.cs index 7912e504abc4..558c4a2ea9ee 100644 --- a/src/Resources/Resources/ManagementGroups/UpdateAzureRmManagementGroup.cs +++ b/src/Resources/Resources/ManagementGroups/UpdateAzureRmManagementGroup.cs @@ -17,6 +17,7 @@ using Microsoft.Azure.Commands.Resources.Models.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups; using Microsoft.Azure.Management.ManagementGroups.Models; +using Microsoft.WindowsAzure.Commands.Common.CustomAttributes; namespace Microsoft.Azure.Commands.Resources.ManagementGroups { @@ -30,6 +31,8 @@ public class UpdateAzureRmManagementGroup : AzureManagementGroupsCmdletBase [ValidateNotNullOrEmpty] public PSManagementGroup InputObject { get; set; } + [Alias("GroupId")] + [CmdletParameterBreakingChange("GroupName", ReplaceMentCmdletParameterName = "GroupId", ChangeDescription = "We will repleace GroupName with GroupId to make it more clear.")] [Parameter(ParameterSetName = Constants.ParameterSetNames.ParentGroupParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.InputObject, ValueFromPipeline = false)] [Parameter(ParameterSetName = Constants.ParameterSetNames.GroupOperationsParameterSet, Mandatory = true, HelpMessage = Constants.HelpMessages.GroupName, Position = 0)] diff --git a/src/Resources/Resources/help/Get-AzManagementGroup.md b/src/Resources/Resources/help/Get-AzManagementGroup.md index 21422710fbc1..fe5b4cc3b4b1 100644 --- a/src/Resources/Resources/help/Get-AzManagementGroup.md +++ b/src/Resources/Resources/help/Get-AzManagementGroup.md @@ -161,7 +161,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: GetOperation -Aliases: +Aliases: GroupId Required: True Position: 0 diff --git a/src/Resources/Resources/help/New-AzManagementGroup.md b/src/Resources/Resources/help/New-AzManagementGroup.md index 432ce8eba7fc..2b571dd66c0f 100644 --- a/src/Resources/Resources/help/New-AzManagementGroup.md +++ b/src/Resources/Resources/help/New-AzManagementGroup.md @@ -136,7 +136,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: GroupId Required: True Position: 0 diff --git a/src/Resources/Resources/help/New-AzManagementGroupSubscription.md b/src/Resources/Resources/help/New-AzManagementGroupSubscription.md index c956b1ed3b7a..a49fcbd9c5af 100644 --- a/src/Resources/Resources/help/New-AzManagementGroupSubscription.md +++ b/src/Resources/Resources/help/New-AzManagementGroupSubscription.md @@ -50,7 +50,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: GroupId Required: True Position: 0 diff --git a/src/Resources/Resources/help/Remove-AzManagementGroup.md b/src/Resources/Resources/help/Remove-AzManagementGroup.md index c037e864a906..d7ed5e381132 100644 --- a/src/Resources/Resources/help/Remove-AzManagementGroup.md +++ b/src/Resources/Resources/help/Remove-AzManagementGroup.md @@ -62,7 +62,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: GroupOperations -Aliases: +Aliases: GroupId Required: True Position: 0 diff --git a/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md b/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md index 67e02d872fbe..de28874f8db4 100644 --- a/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md +++ b/src/Resources/Resources/help/Remove-AzManagementGroupSubscription.md @@ -50,7 +50,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: GroupId Required: True Position: 0 diff --git a/src/Resources/Resources/help/Update-AzManagementGroup.md b/src/Resources/Resources/help/Update-AzManagementGroup.md index 0aa26677df51..ddb97ab8cf3e 100644 --- a/src/Resources/Resources/help/Update-AzManagementGroup.md +++ b/src/Resources/Resources/help/Update-AzManagementGroup.md @@ -145,7 +145,7 @@ Management Group Id ```yaml Type: System.String Parameter Sets: GroupOperations, ParentGroupObject -Aliases: +Aliases: GroupId Required: True Position: Named