Addng breaking change notifications to ServiceBus and EventHub namesp… (#21332)

* Addng breaking change notifications to ServiceBus and EventHub namespace cmdlets

* fixing mistakes

* fixing mistakes

* fixing mistakes

* ChangeLog

* Update ChangeLog.md

* Update ChangeLog.md

---------

Co-authored-by: Yabo Hu <[email protected]>

Author: damodaravadhani

src/EventHub/EventHub/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added upcoming breaking change notifications for Az.EventHub module.
 
 ## Version 3.2.2
 * Added breaking change description for parameter `MessageRetentionInDays`, which would be deprecated and would be replaced by `RetentionTimeInHours`

src/EventHub/EventHub/Cmdlets/AzureEventHubsCmdletBase.cs

@@ -154,8 +154,8 @@ protected struct SKU
         private EventHubsClient  _client;
 
         public const string BreakingChangeNotification = "- PLEASE REFER OUR MIGRATION GUIDE https://go.microsoft.com/fwlink/?linkid=2204690 TO KNOW MORE ABOUT BREAKING CHANGES.";
-        public const string DeprecateByVersion = "Az 9.0";
-        public const string ChangeInEffectByDate = "12th October, 2022";
+        public const string DeprecateByVersion = "Az 10.0";
+        public const string ChangeInEffectByDate = "23rd May, 2023";
 
         public EventHubsClient UtilityClient
         {

src/EventHub/EventHub/Cmdlets/Namespace/GetAzureEventHubNamespace.cs

@@ -26,7 +26,7 @@ namespace Microsoft.Azure.Commands.EventHub.Commands.Namespace
     /// <para> If Namespace name provided, a single Namespace detials will be returned</para>
     /// <para> If Namespace name not provided, list of Namespace will be returned</para>
     /// </summary>
-    [CmdletOutputBreakingChange(typeof(PSNamespaceAttributes), DeprecatedOutputProperties = new string[] { "ResourceGroup" }, NewOutputProperties = new string[] { "ResourceGroupName", "Tags" })]
+    [GenericBreakingChange("Output type of the cmdlet would change to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEhNamespace`. This cmdlet would henceforth be alias cmdlet with Get-AzEventHubNamespaceV2.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "EventHubNamespace"), OutputType(typeof(PSNamespaceAttributes))]
     public class GetAzureRmEventHubNamespace : AzureEventHubsCmdletBase
     {

src/EventHub/EventHub/Cmdlets/Namespace/NewAzureEventHubNamespace.cs

@@ -27,7 +27,7 @@ namespace Microsoft.Azure.Commands.EventHub.Commands.Namespace
     /// <summary>
     /// this commandlet will let you Create Eventhub namespace.
     /// </summary>
-    [CmdletOutputBreakingChange(typeof(PSNamespaceAttributes), DeprecatedOutputProperties = new string[] {"ResourceGroup", "Identity"}, NewOutputProperties = new string[] { "ResourceGroupName", "Tags", "IdentityType"})]
+    [GenericBreakingChange("Output type of the cmdlet would change to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEhNamespace`. This cmdlet would henceforth be alias cmdlet with New-AzEventHubNamespaceV2.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "EventHubNamespace", SupportsShouldProcess = true, DefaultParameterSetName = NamespaceParameterSet), OutputType(typeof(PSNamespaceAttributes))]
     public class NewAzureEventHubNamespace : AzureEventHubsCmdletBase
     {
@@ -89,6 +89,7 @@ public class NewAzureEventHubNamespace : AzureEventHubsCmdletBase
         /// <summary>
         /// Upper limit of throughput units when AutoInflate is enabled.
         /// </summary>
+        [CmdletParameterBreakingChange("MaximumThroughputUnits", ReplaceMentCmdletParameterName = "MaximumThroughputUnit")]
         [Parameter(Mandatory = false, ParameterSetName = AutoInflateParameterSet, ValueFromPipelineByPropertyName = true, Position = 6, HelpMessage = "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units.")]
         [ValidateRange(0, 40)]
         public int? MaximumThroughputUnits { get; set; }
@@ -97,6 +98,7 @@ public class NewAzureEventHubNamespace : AzureEventHubsCmdletBase
         /// <summary>
         /// Indicates whether Kafka is enabled.
         /// </summary>
+        [GenericBreakingChange("This parameter would be removed in version " + DeprecateByVersion)]
         [Parameter(Mandatory = false, ParameterSetName = AutoInflateParameterSet, HelpMessage = "enabling or disabling Kafka for namespace")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, HelpMessage = "enabling or disabling Kafka for namespace")]
         public SwitchParameter EnableKafka { get; set; }
@@ -139,6 +141,7 @@ public class NewAzureEventHubNamespace : AzureEventHubsCmdletBase
         /// <summary>
         /// User Assigned Identity Id's
         /// </summary>
+        [CmdletParameterBreakingChange("IdentityId", ReplaceMentCmdletParameterName = "UserAssignedIdentityId")]
         [Parameter(Mandatory = false, ParameterSetName = AutoInflateParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "List of user assigned Identity Ids")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "List of user assigned Identity Ids")]
         public string[] IdentityId { get; set; }
@@ -147,6 +150,7 @@ public class NewAzureEventHubNamespace : AzureEventHubsCmdletBase
         /// <summary>
         /// List of KeyVaultProperties
         /// </summary>
+        [CmdletParameterBreakingChange("EncryptionConfig", OldParamaterType = typeof(PSEncryptionConfigAttributes[]), ReplaceMentCmdletParameterName = "KeyVaultProperty", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202210Preview.IKeyVaultProperties[]")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "Key Property")]
         [Parameter(Mandatory = false, ParameterSetName = AutoInflateParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "Key Property")]
         public PSEncryptionConfigAttributes[] EncryptionConfig { get; set; }

src/EventHub/EventHub/Cmdlets/Namespace/NewKeyVaultPropertyObject.cs

@@ -15,13 +15,15 @@
 using Microsoft.Azure.Commands.EventHub.Commands;
 using Microsoft.Azure.Commands.EventHub.Models;
 using Microsoft.Azure.Management.EventHub.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System;
 using System.Collections.Generic;
 using System.Management.Automation;
 using System.Text;
 
 namespace Microsoft.Azure.Commands.EventHub.Cmdlets.Namespace
 {
+    [GenericBreakingChange("Output type of the cmdlet would change to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.KeyVaultProperties`.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "EventHubEncryptionConfig", SupportsShouldProcess = false), OutputType(typeof(PSEncryptionConfigAttributes))]
     public class NewKeyVaultPropertyObject : AzureEventHubsCmdletBase
     {

src/EventHub/EventHub/Cmdlets/Namespace/RemoveAzureEventHubNamespace.cs

@@ -15,6 +15,7 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.EventHub.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.EventHub.Commands.Namespace
 {
@@ -34,10 +35,12 @@ public class RemoveAzureRmEventHubNamespace : AzureEventHubsCmdletBase
         [Alias(AliasNamespaceName)]
         public string Name { get; set; }
 
+        [GenericBreakingChange("The type of the `-InputObject` parameter would change to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEhNamespace`.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
         [Parameter(Mandatory = true, ParameterSetName = NamespaceInputObjectParameterSet, ValueFromPipeline = true, Position = 0, HelpMessage = "EventHubs Namespace Object")]
         [ValidateNotNullOrEmpty]
         public PSNamespaceAttributes InputObject { get; set; }
 
+        [GenericBreakingChange("This parameter would be removed. Henceforth, resource Id's can be provided as input to `-InputObject` parameter.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
         [Parameter(Mandatory = true, ParameterSetName = NamespaceResourceIdParameterSet, ValueFromPipelineByPropertyName = true, Position = 0, HelpMessage = "EventHubs Namespace Resource Id")]
         [ValidateNotNullOrEmpty]
         public string ResourceId { get; set; }

src/EventHub/EventHub/Cmdlets/Namespace/SetAzureEventHubNamespace.cs

@@ -28,7 +28,7 @@ namespace Microsoft.Azure.Commands.EventHub.Commands.Namespace
     /// <summary>
     /// 'Set-AzEventHubNamespace' Cmdlet updates the specified Eventhub Namespace
     /// </summary>
-    [CmdletOutputBreakingChange(typeof(PSNamespaceAttributes), DeprecatedOutputProperties = new string[] { "ResourceGroup", "IdentityUserDefined", "Identity", "KeyProperty" }, NewOutputProperties = new string[] { "ResourceGroupName", "Tags", "IdentityType", "EncryptionConfig" })]
+    [GenericBreakingChange("Output type of the cmdlet would change to `Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202201Preview.IEhNamespace`. This cmdlet would henceforth be alias cmdlet with Set-AzEventHubNamespaceV2.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
     [Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "EventHubNamespace", SupportsShouldProcess = true, DefaultParameterSetName = NamespaceParameterSet), OutputType(typeof(PSNamespaceAttributes))]
     public class SetAzureEventHubNamespace : AzureEventHubsCmdletBase
     {
@@ -69,12 +69,14 @@ public class SetAzureEventHubNamespace : AzureEventHubsCmdletBase
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, HelpMessage = "Indicates whether AutoInflate is enabled")]
         public SwitchParameter EnableAutoInflate { get; set; }
 
-        
+
+        [CmdletParameterBreakingChange("MaximumThroughputUnits", ReplaceMentCmdletParameterName = "MaximumThroughputUnit")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units.")]
         [ValidateRange(0,40)]        
         public int? MaximumThroughputUnits { get; set; }
 
 
+        [GenericBreakingChange("This parameter would be removed in version " + DeprecateByVersion)]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, HelpMessage = "enabling or disabling Kafka for namespace")]
         public SwitchParameter EnableKafka { get; set; }
 
@@ -88,10 +90,12 @@ public class SetAzureEventHubNamespace : AzureEventHubsCmdletBase
         public string IdentityType { get; set; }
 
 
+        [CmdletParameterBreakingChange("IdentityId", ReplaceMentCmdletParameterName = "UserAssignedIdentityId")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "List of user assigned Identity Ids")]
         public string[] IdentityId { get; set; }
 
-        
+
+        [CmdletParameterBreakingChange("EncryptionConfig", OldParamaterType = typeof(PSEncryptionConfigAttributes[]), ReplaceMentCmdletParameterName = "KeyVaultProperty", NewParameterTypeName = "Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202210Preview.IKeyVaultProperties[]")]
         [Parameter(Mandatory = false, ParameterSetName = NamespaceParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "Key Property")]
         public PSEncryptionConfigAttributes[] EncryptionConfig { get; set; }
 

src/ServiceBus/ServiceBus/ChangeLog.md

@@ -19,6 +19,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added upcoming breaking change notifications for Az.ServiceBus module.
 
 ## Version 2.2.0
 * Upgraded API version to 2022-10-01-preview

src/ServiceBus/ServiceBus/Cmdlets/AzureServiceBusCmdletBase.cs

@@ -159,8 +159,8 @@ protected struct RegeneKeys
         }
 
         public const string BreakingChangeNotification = "- PLEASE REFER OUR MIGRATION GUIDE https://go.microsoft.com/fwlink/?linkid=2204584 TO KNOW MORE ABOUT BREAKING CHANGES.";
-        public const string DeprecateByVersion = "Az 9.0";
-        public const string ChangeInEffectByDate = "12th October, 2022";
+        public const string DeprecateByVersion = "Az 10.0";
+        public const string ChangeInEffectByDate = "23rd May, 2023";
         public const string TimespanBreakingChange = "Input type of the parameter has been changed from System.String to System.Timespan. Hence, ISO 8601 format for timespan can NO longer be fed as input to these parameters. Please use New-TimeSpan cmdlet object to construct Timespan variables.";
 
         public static TimeSpan ParseTimespan(string strTimespan)

src/ServiceBus/ServiceBus/Cmdlets/Namespace/GetAzureServiceBusNamespace.cs

@@ -27,7 +27,7 @@ namespace Microsoft.Azure.Commands.ServiceBus.Commands.Namespace
     /// <para> If Namespace name provided, a single Namespace detials will be returned</para>
     /// <para> If Namespace name not provided, list of Namespace will be returned</para>
     /// </summary>
-    [CmdletOutputBreakingChange(typeof(PSNamespaceAttributes), DeprecatedOutputProperties = new string[] { "ResourceGroup" }, NewOutputProperties = new string[] { "ResourceGroupName"})]
+    [GenericBreakingChange("Output type of the cmdlet would change to `Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Models.Api20221001Preview.ISbNamespace`. This cmdlet would henceforth be alias cmdlet with Get-AzServiceBusNamespaceV2.", deprecateByVersion: DeprecateByVersion, changeInEfectByDate: ChangeInEffectByDate)]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ServiceBusNamespace"), OutputType(typeof(PSNamespaceAttributes))]
     public class GetAzureRmServiceBusNamespace : AzureServiceBusCmdletBase
     {