Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breaking change notification #12649

Merged
merged 1 commit into from
Aug 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Aks/Aks/Commands/NewKubeBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand All @@ -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; }
Expand Down Expand Up @@ -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; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -30,6 +31,8 @@ public class GetAzureRmManagementGroup : AzureManagementGroupsCmdletBase
/// <summary>
/// Get-AzManagementGroup Cmdlet
/// </summary>
[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; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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)]
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Resources/help/Get-AzManagementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: GetOperation
Aliases:
Aliases: GroupId

Required: True
Position: 0
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Resources/help/New-AzManagementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: (All)
Aliases:
Aliases: GroupId

Required: True
Position: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: (All)
Aliases:
Aliases: GroupId

Required: True
Position: 0
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Resources/help/Remove-AzManagementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: GroupOperations
Aliases:
Aliases: GroupId

Required: True
Position: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: (All)
Aliases:
Aliases: GroupId

Required: True
Position: 0
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Resources/help/Update-AzManagementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Management Group Id
```yaml
Type: System.String
Parameter Sets: GroupOperations, ParentGroupObject
Aliases:
Aliases: GroupId

Required: True
Position: Named
Expand Down