add breaking change attribute of acr (#21328)

* add breaking change attribute of acr

* add breaking change attribute of acr

* added changelog

Author: Nickcandy

src/ContainerRegistry/ContainerRegistry/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Added breaking change attributes for cmdlets
 
 ## Version 3.0.2
 * Updated Azure.Core to 1.28.0.

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistry.cs

@@ -15,9 +15,12 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0", "05/23/2023")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistry", DefaultParameterSetName = ListRegistriesParameterSet)]
     [OutputType(typeof(PSContainerRegistry))]
     public class GetAzureContainerRegistry : ContainerRegistryCmdletBase
@@ -35,7 +38,8 @@ public class GetAzureContainerRegistry : ContainerRegistryCmdletBase
 
         [Parameter(Mandatory = false, HelpMessage = "Show more details about the container registry.")]
         public SwitchParameter IncludeDetail { get; set; }
-
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced";
+        [CmdletParameterBreakingChange("ResourceId", "4.0.0.0", "05/23/2023", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistryCredential.cs

@@ -14,9 +14,12 @@
 
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryCredential", DefaultParameterSetName = NameResourceGroupParameterSet)]
     [OutputType(typeof(PSContainerRegistryCredential))]
     public class GetAzureContainerRegistryCredential : ContainerRegistryCmdletBase
@@ -34,7 +37,8 @@ public class GetAzureContainerRegistryCredential : ContainerRegistryCmdletBase
         [Parameter(Mandatory = true, ParameterSetName = RegistryObjectParameterSet, HelpMessage = "Container Registry Object.")]
         [ValidateNotNull]
         public PSContainerRegistry Registry { get; set; }
-
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced";
+        
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistryReplication.cs

@@ -15,9 +15,12 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryReplication", DefaultParameterSetName = ListReplicationByNameResourceGroupParameterSet)]
     [OutputType(typeof(PSContainerRegistryReplication))]
     public class GetAzureContainerRegistryReplication : ContainerRegistryCmdletBase
@@ -45,6 +48,8 @@ public class GetAzureContainerRegistryReplication : ContainerRegistryCmdletBase
         [ValidateNotNull]
         public PSContainerRegistry Registry { get; set; }
 
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced";
+        [CmdletParameterBreakingChange("ResourceId", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry replication resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistryUsage.cs

@@ -19,9 +19,11 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.ContainerRegistry.Commands
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryUsage")]
     [OutputType(typeof(PSRegistryUsage))]
     public class GetAzureContainerRegistryUsage : ContainerRegistryCmdletBase

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistryWebhook.cs

@@ -15,13 +15,17 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryWebhook", DefaultParameterSetName = ListWebhookByNameResourceGroupParameterSet)]
     [OutputType(typeof(PSContainerRegistryWebhook))]
     public class GetAzureContainerRegistryWebhook : ContainerRegistryCmdletBase
     {
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced"; 
         [Parameter(Position = 0, Mandatory = true, ParameterSetName = ShowWebhookByNameResourceGroupParameterSet, HelpMessage = "Webhook Name.")]
         [Parameter(Position = 0, Mandatory = true, ParameterSetName = ShowWebhookByRegistryObjectParameterSet, HelpMessage = "Webhook Name.")]
         [ValidateNotNullOrEmpty]
@@ -45,9 +49,12 @@ public class GetAzureContainerRegistryWebhook : ContainerRegistryCmdletBase
         [ValidateNotNull]
         public PSContainerRegistry Registry { get; set; }
 
+
+        [CmdletParameterBreakingChange("IncludeConfiguration", "4.0.0.0", "05/23/2023", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = false, HelpMessage = "Get the configuration information for a webhook.")]
         public SwitchParameter IncludeConfiguration { get; set; }
 
+        [CmdletParameterBreakingChange("ResourceId", "4.0.0.0", "05/23/2023", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry Webhook resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]

src/ContainerRegistry/ContainerRegistry/Commands/GetAzureContainerRegistryWebhookEvent.cs

@@ -15,13 +15,18 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using System.Collections.Generic;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryWebhookEvent", DefaultParameterSetName = ListWebhookEventsByNameResourceGroupParameterSet)]
     [OutputType(typeof(PSContainerRegistryWebhookEvent))]
     public class GetAzureContainerRegistryWebhookEvent : ContainerRegistryCmdletBase
     {
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced"; 
+
         [Parameter(Position = 0, Mandatory = true, ParameterSetName = ListWebhookEventsByNameResourceGroupParameterSet, HelpMessage = "Webhook Name.")]
         [ValidateNotNullOrEmpty]
         public string WebhookName { get; set; }
@@ -40,6 +45,7 @@ public class GetAzureContainerRegistryWebhookEvent : ContainerRegistryCmdletBase
         [ValidateNotNull]
         public PSContainerRegistryWebhook Webhook { get; set; }
 
+        [CmdletParameterBreakingChange("ResourceId", "4.0.0.0", "05/23/2023", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry Webhook resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]

src/ContainerRegistry/ContainerRegistry/Commands/NewAzureContainerRegistry.cs

@@ -20,9 +20,11 @@
 using System;
 using System.Collections;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistry", SupportsShouldProcess = true)]
     [OutputType(typeof(PSContainerRegistry))]
     public class NewAzureContainerRegistry : ContainerRegistryCmdletBase

src/ContainerRegistry/ContainerRegistry/Commands/NewAzureContainerRegistryNetworkRule.cs

@@ -21,9 +21,12 @@
 using System;
 using System.Collections;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry.Commands
 {
+    [CmdletDeprecation("4.0.0.0", "05/23/2023", ReplacementCmdletName = "New-AzContainerRegistryIPRuleObject")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryNetworkRule", DefaultParameterSetName = ByVirtualNetworkRule)]
     [OutputType(typeof(IPSNetworkRule))]
     public class NewAzureContainerRegistryNetworkRule : ContainerRegistryCmdletBase

src/ContainerRegistry/ContainerRegistry/Commands/NewAzureContainerRegistryReplication.cs

@@ -16,9 +16,12 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.Tags;
 using System.Collections;
 using System.Management.Automation;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
+
 
 namespace Microsoft.Azure.Commands.ContainerRegistry
 {
+    [GenericBreakingChange("The Az.ContainerRegistry module is upgrading. The output properties may have some changes", "4.0.0.0")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "ContainerRegistryReplication", DefaultParameterSetName = NameResourceGroupParameterSet, SupportsShouldProcess = true)]
     [OutputType(typeof(PSContainerRegistryReplication))]
     public class NewAzureContainerRegistryReplication : ContainerRegistryCmdletBase
@@ -53,6 +56,8 @@ public class NewAzureContainerRegistryReplication : ContainerRegistryCmdletBase
         [Alias(TagsAlias)]
         public Hashtable Tag { get; set; }
 
+        public const string ChangeDesc = "Parameter is being deprecated without being replaced"; 
+        [CmdletParameterBreakingChange("ResourceId", "4.0.0.0", "05/23/2023", ChangeDescription = ChangeDesc)]
         [Parameter(Mandatory = true, ParameterSetName = ResourceIdParameterSet, ValueFromPipelineByPropertyName = true, HelpMessage = "The container registry resource id")]
         [ValidateNotNullOrEmpty]
         [Alias(ResourceIdAlias)]