add breaking changes information for SqlVirtualMachine (#21265)

* add breaking changes for SqlVirtualMachine

* update changelog for breaking changes of sqlvm

Author: YanaXu

src/SqlVirtualMachine/SqlVirtualMachine/AvailabilityGroupListener/Cmdlet/AzureAvailabilityGroupListenerCmdletBase.cs

@@ -19,6 +19,7 @@
 using System.Management.Automation;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Text.RegularExpressions;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet
 {
@@ -51,6 +52,7 @@ public abstract class AzureAvailabilityGroupListenerCmdletBase : AzureSqlVirtual
         /// <summary>
         /// SqlVmGroup Object of the AG Listener
         /// </summary>
+        [CmdletParameterBreakingChange("SqlVMGroupObject", ChangeDescription = "SqlVMGroupObject parameter is being deprecated without being replaced.")]
         [Parameter(
             Mandatory = true,
             ParameterSetName = ParameterSet.SqlVMGroupObject,

src/SqlVirtualMachine/SqlVirtualMachine/AvailabilityGroupListener/Cmdlet/UpdateAzureAvailabilityGroupListener.cs

@@ -18,13 +18,15 @@
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common;
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
 using Microsoft.Azure.Management.SqlVirtualMachine.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet
 {
     /// <summary>
     /// This class implements the Update-AzAvailabilityGroupListener cmdlet. It allows to update the information relative to an Azure Sql Virtual Machine
     /// Group and return to the user an AzureAvailabilityGroupListenerModel object corresponding to the instance updated.
     /// </summary>
+    [CmdletDeprecation()]
     [Cmdlet(VerbsData.Update, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "AvailabilityGroupListener", DefaultParameterSetName = ParameterSet.Name, SupportsShouldProcess = true)]
     [OutputType(typeof(AzureAvailabilityGroupListenerModel))]
     public class UpdateAzureAvailabilityGroupListener : AzureAvailabilityGroupListenerUpsertCmdletBase

src/SqlVirtualMachine/SqlVirtualMachine/ChangeLog.md

@@ -18,6 +18,14 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added breaking change notification for cmdlets to be removed and parameters to be changed.
+    * Cmdlet `New-AzSqlVMConfig` will be removed.
+    * Cmdlet `Set-AzSqlVMConfigGroup` will be removed.
+    * Cmdlet `Update-AzAvailabilityGroupListener` will be removed.
+    * Parameter `SqlVM` will be removed from cmdlet `New-AzSqlVM`.
+    * Parameter `SqlVMGroupObject` will be removed from cmdlet `Get-AzAvailabilityGroupListener` and `Remove-AzAvailabilityGroupListener`.
+    * Parameter alias `SqlVM` will be removed from `InputObject` of cmdlet `Remove-AzSqlVM`.
+    * Parameter alias `SqlVMGroup` will be removed from `InputObject` of cmdlet `Update-AzSqlVMGroup` and `Remove-AzSqlVMGroup`.
 * Added breaking change notification for SqlManagementType
 
 ## Version 1.1.0

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachine/Cmdlet/Config/NewAzureSqlVMConfig.cs

@@ -16,6 +16,7 @@
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common;
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common.ArgumentCompleters;
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
@@ -27,6 +28,7 @@ namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet.Co
     /// This class implements the New-AzVMConfig cmdlet. It will create a local AzureSqlVMModel powershell object that can be used as configuration settings 
     /// for the creation of a sql virtual machine on Azure.
     /// </summary>
+    [CmdletDeprecation()]
     [Cmdlet(VerbsCommon.New, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SqlVMConfig", DefaultParameterSetName = NameParameterList, SupportsShouldProcess = true)]
     [OutputType(typeof(AzureSqlVMModel))]
     public class NewAzureSqlVMConfig : AzureSqlVMUpsertCmdletBase

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachine/Cmdlet/Config/SetAzureSqlVMConfigGroup.cs

@@ -21,6 +21,7 @@
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
 using Microsoft.Azure.Management.SqlVirtualMachine.Models;
 using Microsoft.WindowsAzure.Commands.Common;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet.Config
 {
@@ -29,6 +30,7 @@ namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet.Co
     /// Sql Virtual Machine group to the local copy of the powershell object. It returns an instance of AzureSqlVMModel that can be used as configuration
     /// for an Azure Sql Virtual Machine.
     /// </summary>
+    [CmdletDeprecation()]
     [Cmdlet(VerbsCommon.Set, ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "SqlVMConfigGroup", SupportsShouldProcess = true)]
     [OutputType(typeof(AzureSqlVMModel))]
     public class SetAzureSqlVMConfigGroup : AzureSqlVirtualMachineCmdletBase<IEnumerable<AzureSqlVMModel>, AzureSqlVMAdapter>

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachine/Cmdlet/NewAzureSqlVM.cs

@@ -69,6 +69,7 @@ public class NewAzureSqlVM : AzureSqlVMUpsertCmdletBase
         /// Sql virtual machine to be updated
         /// </summary>
         [CmdletParameterBreakingChange("SqlManagementType", ChangeDescription = "SqlManagementType parameter is being deprecated")]
+        [CmdletParameterBreakingChange("SqlVM", ChangeDescription = "SqlVM parameter is being deprecated without being replaced.")]
         [Parameter(Mandatory = true,
             ParameterSetName = NameInputObject,
             ValueFromPipeline = true,

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachine/Cmdlet/RemoveAzureSqlVM.cs

@@ -51,10 +51,11 @@ public class RemoveAzureSqlVM : AzureSqlVMCmdletBase
         [Alias("SqlVMName")]
         [ResourceNameCompleter("Microsoft.SqlVirtualMachine/SqlVirtualMachines", "ResourceGroupName")]
         public virtual string Name { get; set; }
-        
+
         /// <summary>
         /// Sql virtual machine resource to be removed
         /// </summary>
+        [CmdletParameterBreakingChange("InputObject", ChangeDescription = "InputObject parameter alias 'SqlVM' will be removed.")]
         [Parameter(Mandatory = true,
             ParameterSetName = ParameterSet.InputObject,
             ValueFromPipeline = true,

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachine/Cmdlet/UpdateAzureSqlVM.cs

@@ -22,8 +22,8 @@
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common;
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common.ArgumentCompleters;
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
-using static Microsoft.Azure.Commands.SqlVirtualMachine.Common.ParameterSet;
 using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+using static Microsoft.Azure.Commands.SqlVirtualMachine.Common.ParameterSet;
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet
 {
@@ -129,6 +129,7 @@ public class UpdateAzureSqlVM : AzureSqlVMUpsertCmdletBase
         /// <summary>
         /// Sql virtual machine to be updated
         /// </summary>
+        [CmdletParameterBreakingChange("InputObject", ChangeDescription = "InputObject parameter alias 'SqlVM' will be removed.")]
         [Parameter(Mandatory = true,
             ParameterSetName = NameInputObject,
             ValueFromPipeline = true,

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachineGroup/Cmdlet/RemoveAzureSqlVMGroup.cs

@@ -16,6 +16,7 @@
 using System.Management.Automation;
 using Microsoft.Azure.Commands.SqlVirtualMachine.Common;
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet
@@ -31,6 +32,7 @@ public class RemoveAzureSqlVMGroup : AzureSqlVMGroupCmdletBase
         /// <summary>
         /// Sql virtual machine group resource to be removed
         /// </summary>
+        [CmdletParameterBreakingChange("InputObject", ChangeDescription = "InputObject parameter alias 'SqlVMGroup' will be removed.")]
         [Parameter(Mandatory = true,
             ParameterSetName = ParameterSet.InputObject,
             Position = 0,

src/SqlVirtualMachine/SqlVirtualMachine/SqlVirtualMachineGroup/Cmdlet/UpdateAzureSqlVMGroup.cs

@@ -20,6 +20,7 @@
 using Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Model;
 using Microsoft.Azure.Management.SqlVirtualMachine.Models;
 using Microsoft.WindowsAzure.Commands.Common;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.SqlVirtualMachine.SqlVirtualMachine.Cmdlet
 {
@@ -34,6 +35,7 @@ public class UpdateAzureSqlVMGroup : AzureSqlVMGroupUpsertCmdletBase
         /// <summary>
         /// Sql virtual machine group to be updated
         /// </summary>
+        [CmdletParameterBreakingChange("InputObject", ChangeDescription = "InputObject parameter alias 'SqlVMGroup' will be removed.")]
         [Parameter(Mandatory = true,
             ParameterSetName = ParameterSet.InputObject,
             ValueFromPipeline = true,