Skip to content

Commit

Permalink
edit breaking change messages
Browse files Browse the repository at this point in the history
  • Loading branch information
grhuangmsft committed Mar 13, 2024
1 parent 7eb61e6 commit b3765fb
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 56 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@

namespace Microsoft.Azure.Commands.Support.Communications
{
[GenericBreakingChangeWithVersion("The cmdlet Get-AzSupportTicketCommunication will be renamed to Get-AzSupportCommunication", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Input parameter 'Skip' will be removed", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Input parameter 'IncludeTotalCount' will be removed", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Parameter 'First' will be renamed to 'Top'", "12.0.0", "2.x")]
[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.x")]
[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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@

namespace Microsoft.Azure.Commands.Support.Communications
{
[GenericBreakingChangeWithVersion("The cmdlet New-AzSupportTicketCommunication will be renamed to New-AzSupportCommunication", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Piping of New-AzSupportTicketCommunication with a support ticket object will no longer be supported.", "12.0.0", "2.x")]
[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
Expand All @@ -50,12 +50,10 @@ public class NewAzSupportTicketCommunication : AzSupportCmdletBase
[ValidateNotNullOrEmpty]
public string Body { get; set; }

[CmdletParameterBreakingChangeWithVersion("Sender", "12.0.0", "2.x", ChangeDescription = "Parameter Sender will be a mandatory parameter")]
[Parameter(Mandatory = false, HelpMessage = "Email address of the sender.")]
[ValidateNotNullOrEmpty]
public string Sender { get; set; }

[CmdletParameterBreakingChangeWithVersion("AsJob", "12.0.0", "2.x", ChangeDescription = "Parameter AsJob will be deprecated without being replaced.")]
[Parameter(Mandatory = false, HelpMessage = "Run cmdlet in the background.")]
public SwitchParameter AsJob { get; set; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,18 @@

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.x")]
[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.x", ChangeDescription = "Parameter name 'ServiceId' will be changed to 'ServiceName'.")]
[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.x", ChangeDescription = "Parameter name 'Id' will be changed to 'Name'.")]
[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")]
Expand Down
4 changes: 2 additions & 2 deletions src/Support/Support/Services/GetAzSupportService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@

namespace Microsoft.Azure.Commands.Support.Services
{
[CmdletOutputBreakingChangeWithVersion(typeof(PSSupportService), "12.0.0", "2.x", ChangeDescription = "Output property name 'ResourceTypes' will be changed to 'ResourceType'.")]
[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.x", ChangeDescription = "Parameter name 'Id' will be changed to 'Name'.")]
[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()]
Expand Down
16 changes: 8 additions & 8 deletions src/Support/Support/SupportTickets/GetAzSupportTicket.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@

namespace Microsoft.Azure.Commands.Support.SupportTickets
{
[GenericBreakingChangeWithVersion("Input parameter 'Skip' will be removed", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Input parameter 'IncludeTotalCount' will be removed", "12.0.0", "2.x")]
[GenericBreakingChangeWithVersion("Parameter 'First' will be renamed to 'Top'", "12.0.0", "2.x")]
[CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.x", ChangeDescription = "The child output property ContactDetail will be deprecated. Use properties ContactDetailAdditionalEmailAddress," +
[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.x", ChangeDescription = "The child output property SupportEngineer will be deprecated. Use property SupportEngineerEmailAddress instead")]
[CmdletOutputBreakingChangeWithVersion(typeof(PSSupportTicket), "12.0.0", "2.x", ChangeDescription = "The child output property QuotaTicketDetail will be deprecated. Use properties QuotaTicketDetailQuotaChangeRequest," +
[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.x", 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.x")]
[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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

namespace Microsoft.Azure.PowerShell.Cmdlets.Support.SupportTickets
{
[CmdletDeprecationWithVersion("12.0.0", "2.x")]
[CmdletDeprecationWithVersion("12.0.0", "2.0.0")]
[Cmdlet(VerbsCommon.New, AzureRMConstants.AzureRMPrefix + "SupportContactProfileObject", SupportsShouldProcess = true),
OutputType(typeof(PSContactProfile))]
public class NewAzSupportContactProfileObject : AzSupportCmdletBase
Expand Down
Loading

0 comments on commit b3765fb

Please sign in to comment.