add breaking change announcements for Az.Support (#24359)

Author: grhuangmsft

src/Support/Support/ChangeLog.md

@@ -19,6 +19,35 @@
 -->
 
 ## Upcoming Release
+* Added breaking change warning messages for cmdlet deprecation
+    - New-AzSupportContactProfileObject
+* Added breaking change warning messages for cmdlet rename
+    - Get-AzSupportTicketCommunication
+    - New-AzSupportTicketCommunication
+* Added breaking change warning messages for parameter name and/or structure changes
+    - Get-AzSupportService
+    - Get-AzSupportProblemClassification
+    - Get-AzSupportTicketCommunication
+    - Get-AzSupportTicket
+    - New-AzSupportTicket
+    - Update-AzSupportTicket
+* Added breaking change warning messages for output property name and/or structure changes
+    - Get-AzSupportService
+    - Get-AzSupportTicket
+    - New-AzSupportTicket
+    - Update-AzSupportTicket
+* Added breaking change warning messages for new required parameters
+    - New-AzSupportTicket
+* Added breaking change warning messages for removed parameters
+    - Get-AzSupportTicket
+    - Get-AzSupportTicketCommunication
+    - New-AzSupportTicket
+* Added breaking change warning message for removal of pipe parameter set for list/new
+    - New-AzSupportTicketCommunication
+    - Get-AzSupportProblemClassification
+    - Get-AzSupportTicketCommunication
+* Added breaking change warning message for Get-AzSupportTicket retrieving tickets from the past week if no other parameters are specified
+    - Get-AzSupportTicket
 
 ## Version 1.0.0
 * General availability of `Az.Support` module

src/Support/Support/Communications/GetAzSupportTicketCommunication.cs

@@ -19,6 +19,7 @@
 using Microsoft.Azure.Management.Support;
 using Microsoft.Azure.Management.Support.Models;
 using Microsoft.Rest.Azure;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Collections.Generic;
@@ -27,6 +28,11 @@
 
 namespace Microsoft.Azure.Commands.Support.Communications
 {
+    [GenericBreakingChangeWithVersion("The cmdlet Get-AzSupportTicketCommunication will be renamed to Get-AzSupportCommunication", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Input parameter 'Skip' will be removed", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Input parameter 'IncludeTotalCount' will be removed", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Parameter 'First' will be renamed to 'Top'", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Piping of Get-AzSupportTicketCommunication with a support ticket object will no longer be supported for list. Get via piping will still be supported.", "12.0.0", "2.0.0")]
     [Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "SupportTicketCommunication", DefaultParameterSetName = GetByNameParameterSet, SupportsPaging = true), OutputType(typeof(PSSupportTicketCommunication))]
     public class GetAzSupportTicketCommunication : AzSupportCmdletBase
     {

src/Support/Support/Communications/NewAzSupportTicketCommunication.cs

@@ -18,11 +18,14 @@
 using Microsoft.Azure.Commands.Support.Models;
 using Microsoft.Azure.Management.Support;
 using Microsoft.Azure.Management.Support.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Support.Communications
 {
+    [GenericBreakingChangeWithVersion("The cmdlet New-AzSupportTicketCommunication will be renamed to New-AzSupportCommunication", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Piping of New-AzSupportTicketCommunication with a support ticket object will no longer be supported.", "12.0.0", "2.0.0")]
     [Cmdlet(VerbsCommon.New, AzureRMConstants.AzureRMPrefix + "SupportTicketCommunication", DefaultParameterSetName = CreateByNameParameterSet, SupportsShouldProcess = true),
      OutputType(typeof(PSSupportTicketCommunication))]
     public class NewAzSupportTicketCommunication : AzSupportCmdletBase

src/Support/Support/ProblemClassifications/GetAzSupportProblemClassification.cs

@@ -19,22 +19,26 @@
 using Microsoft.Azure.Management.Support;
 using Microsoft.Azure.Management.Support.Models;
 using Microsoft.Azure.PowerShell.Cmdlets.Support.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System.Linq;
 using System.Management.Automation;
 using static Microsoft.Azure.Commands.Support.Helpers.ResourceIdentifierHelper;
 
 namespace Microsoft.Azure.Commands.Support.ProblemClassifications
 {
+    [GenericBreakingChangeWithVersion("Piping of Get-AzSupportProblemClassification with a service object will no longer be supported for list. Get via piping will still be supported.", "12.0.0", "2.0.0")]
     [Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "SupportProblemClassification", DefaultParameterSetName = GetByNameParameterSet), OutputType(typeof(PSSupportProblemClassification))]
     public class GetAzSupportProblemClassification : AzSupportCmdletBase
     {
+        [CmdletParameterBreakingChangeWithVersion("ServiceId", "12.0.0", "2.0.0", ChangeDescription = "Parameter name 'ServiceId' will be changed to 'ServiceName'.")]
         [Parameter(Mandatory = true, ParameterSetName = GetByNameParameterSet, HelpMessage = "Service id for which all problem classifications are retrieved.")]
         [Alias("ServiceName")]
         [ServiceIdCompleter()]
         [ValidateNotNullOrEmpty]
         public string ServiceId { get; set; }
 
+        [CmdletParameterBreakingChangeWithVersion("Id", "12.0.0", "2.0.0", ChangeDescription = "Parameter name 'Id' will be changed to 'Name'.")]
         [Parameter(Mandatory = false, ParameterSetName = GetByNameParameterSet, HelpMessage = "Problem classification id.")]
         [Parameter(Mandatory = false, ParameterSetName = GetByParentObjectParameterSet, HelpMessage = "Problem classification id.")]
         [Alias("Name")]

src/Support/Support/Services/GetAzSupportService.cs

@@ -19,15 +19,18 @@
 using Microsoft.Azure.Management.Support;
 using Microsoft.Azure.Management.Support.Models;
 using Microsoft.Azure.PowerShell.Cmdlets.Support.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Linq;
 using System.Management.Automation;
 using static Microsoft.Azure.Commands.Support.Helpers.ResourceIdentifierHelper;
 
 namespace Microsoft.Azure.Commands.Support.Services
 {
+    [CmdletOutputBreakingChangeWithVersion(typeof(PSSupportService), "12.0.0", "2.0.0", ChangeDescription = "Output property name 'ResourceTypes' will be changed to 'ResourceType'.")]
     [Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "SupportService", DefaultParameterSetName = ListParameterSet), OutputType(typeof(PSSupportService))]
     public class GetAzSupportService : AzSupportCmdletBase
     {
+        [CmdletParameterBreakingChangeWithVersion("Id", "12.0.0", "2.0.0", ChangeDescription = "Parameter name 'Id' will be changed to 'Name'.")]
         [Parameter(Mandatory = true, ParameterSetName = GetByNameParameterSet, HelpMessage = "Service id.")]
         [Alias("Name")]
         [ServiceIdCompleter()]

src/Support/Support/SupportTickets/GetAzSupportTicket.cs

@@ -19,13 +19,25 @@
 using Microsoft.Azure.Management.Support;
 using Microsoft.Azure.Management.Support.Models;
 using Microsoft.Rest.Azure;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Support.SupportTickets
 {
+    [GenericBreakingChangeWithVersion("Input parameter 'Skip' will be removed", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Input parameter 'IncludeTotalCount' will be removed", "12.0.0", "2.0.0")]
+    [GenericBreakingChangeWithVersion("Parameter 'First' will be renamed to 'Top'", "12.0.0", "2.0.0")]
+    [CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.0.0", ChangeDescription = "The child output property ContactDetail will be deprecated. Use properties ContactDetailAdditionalEmailAddress," +
+        "ContactDetailCountry, ContactDetailFirstName, ContactDetailLastName, ContactDetailPhoneNumber, ContactDetailPreferredContactMethod, ContactDetailPreferredSupportLanguage, ContactDetailPreferredTimeZone, " +
+        "and ContactDetailPrimaryEmailAddress instead" )]
+    [CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.0.0", ChangeDescription = "The child output property SupportEngineer will be deprecated. Use property SupportEngineerEmailAddress instead")]
+    [CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.0.0", ChangeDescription = "The child output property QuotaTicketDetail will be deprecated. Use properties QuotaTicketDetailQuotaChangeRequest," +
+        "QuotaTicketDetailQuotaChangeRequestSubType, QuotaTicketDetailQuotaChangeRequestVersion instead")]
+    [CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.0.0", ChangeDescription = "The output property TechnicalTicketResourceId will be changed to TechnicalTicketDetailResourceId")]
+    [GenericBreakingChangeWithVersion("If no parameters are specified, Get-AzSupportTicket will return support tickets from the last week be default", "12.0.0", "2.0.0")]
     [Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "SupportTicket", DefaultParameterSetName = ListParameterSet, SupportsPaging = true), 
         OutputType(typeof(PSSupportTicket))]
     public class GetAzSupportTicket : AzSupportCmdletBase

src/Support/Support/SupportTickets/NewAzSupportContactProfileObject.cs

@@ -16,10 +16,12 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Commands.Support.Common;
 using Microsoft.Azure.Commands.Support.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.PowerShell.Cmdlets.Support.SupportTickets
 {
+    [CmdletDeprecationWithVersion("12.0.0", "2.0.0")]
     [Cmdlet(VerbsCommon.New, AzureRMConstants.AzureRMPrefix + "SupportContactProfileObject", SupportsShouldProcess = true), 
       OutputType(typeof(PSContactProfile))]
     public class NewAzSupportContactProfileObject : AzSupportCmdletBase