Skip to content

Commit 60ec2df

Browse files
authored
[Config] Added upcoming breaking change warning for azconfig (#23606)
* add upcoming breaking change warning for config::DisableErrorRecordsPersistence * add changelog
1 parent e4e2930 commit 60ec2df

File tree

4 files changed

+7
-0
lines changed

4 files changed

+7
-0
lines changed

src/Accounts/Accounts/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020

2121
## Upcoming Release
22+
* Added upcoming breaking change warning for deprecation of config parameter `DisableErrorRecordsPersistence`.
2223

2324
## Version 2.13.2
2425
* Enabled in-tool notification for version upgrade by default.

src/Accounts/Accounts/Config/ClearConfigCommand.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
using Microsoft.Azure.Commands.Common.Exceptions;
1616
using Microsoft.Azure.Commands.ResourceManager.Common;
1717
using Microsoft.Azure.PowerShell.Common.Config;
18+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
1819
using Microsoft.WindowsAzure.Commands.Utilities.Common;
1920
using System;
2021
using System.Collections.Generic;
@@ -24,6 +25,7 @@
2425

2526
namespace Microsoft.Azure.Commands.Common.Authentication.Config
2627
{
28+
[GenericBreakingChangeWithVersion("Parameter `DisableErrorRecordsPersistence` will be deprecated, a new parameter `EnableErrorRecordsPersistence` will be added instead. Writing error records to file system will become opt-in instead of opt-out. This change will happen around May 2024", "12.0.0", "2.X")]
2729
[Cmdlet("Clear", AzureRMConstants.AzureRMPrefix + "Config", SupportsShouldProcess = true, DefaultParameterSetName = ClearAll)]
2830
[OutputType(typeof(bool))]
2931
public class ClearConfigCommand : ConfigCommandBase, IDynamicParameters

src/Accounts/Accounts/Config/GetConfigCommand.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
using Microsoft.Azure.Commands.Profile.Models;
1616
using Microsoft.Azure.Commands.ResourceManager.Common;
1717
using Microsoft.Azure.PowerShell.Common.Config;
18+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
1819
using Microsoft.WindowsAzure.Commands.Utilities.Common;
1920
using System;
2021
using System.Collections.Generic;
@@ -24,6 +25,7 @@
2425

2526
namespace Microsoft.Azure.Commands.Common.Authentication.Config
2627
{
28+
[GenericBreakingChangeWithVersion("Parameter `DisableErrorRecordsPersistence` will be deprecated, a new parameter `EnableErrorRecordsPersistence` will be added instead. Writing error records to file system will become opt-in instead of opt-out. This change will happen around May 2024", "12.0.0", "2.X")]
2729
[Cmdlet(VerbsCommon.Get, AzureRMConstants.AzureRMPrefix + "Config")]
2830
[OutputType(typeof(PSConfig))]
2931
public class GetConfigCommand : ConfigCommandBase, IDynamicParameters

src/Accounts/Accounts/Config/UpdateConfigCommand.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
using Microsoft.Azure.Commands.Profile.Models;
1717
using Microsoft.Azure.Commands.ResourceManager.Common;
1818
using Microsoft.Azure.PowerShell.Common.Config;
19+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
1920
using System;
2021
using System.Collections.Generic;
2122
using System.Collections.ObjectModel;
@@ -24,6 +25,7 @@
2425

2526
namespace Microsoft.Azure.Commands.Common.Authentication.Config
2627
{
28+
[GenericBreakingChangeWithVersion("Parameter `DisableErrorRecordsPersistence` will be deprecated, a new parameter `EnableErrorRecordsPersistence` will be added instead. Writing error records to file system will become opt-in instead of opt-out. This change will happen around May 2024", "12.0.0", "2.X")]
2729
[Cmdlet("Update", AzureRMConstants.AzureRMPrefix + "Config", SupportsShouldProcess = true)]
2830
[Alias("Set-AzConfig")]
2931
[OutputType(typeof(PSConfig))]

0 commit comments

Comments
 (0)