[Storage] Added breaking change warning message for upcoming cmdlet output change (#12898)

msJinLei · blueww · web-flow · commit 1b9a02171d0b · 2020-09-10T09:55:34.000+08:00
* [Storage] Added breaking change warning message for upcoming cmdlet output change

* Add reference of KeyVault to Network.Test

Co-authored-by: Wei Wei &lt;weiwei@microsoft.com&gt;
diff --git a/src/Network/Network.sln b/src/Network/Network.sln
@@ -38,6 +38,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Sql.LegacySdk", "..\Sql\Sql
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PrivateDns", "..\PrivateDns\PrivateDns\PrivateDns.csproj", "{70D3A1D4-42FE-4697-AFC7-AC0FEAB0420B}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KeyVault", "..\KeyVault\KeyVault\KeyVault.csproj", "{5423D705-89D5-47D8-8298-BF1342D3A808}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -112,10 +114,10 @@ Global
 		{70D3A1D4-42FE-4697-AFC7-AC0FEAB0420B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{70D3A1D4-42FE-4697-AFC7-AC0FEAB0420B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{70D3A1D4-42FE-4697-AFC7-AC0FEAB0420B}.Release|Any CPU.Build.0 = Release|Any CPU
-		{AD8D31C1-3C84-4213-A13A-A21C7440E591}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{AD8D31C1-3C84-4213-A13A-A21C7440E591}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{AD8D31C1-3C84-4213-A13A-A21C7440E591}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{AD8D31C1-3C84-4213-A13A-A21C7440E591}.Release|Any CPU.Build.0 = Release|Any CPU
+		{5423D705-89D5-47D8-8298-BF1342D3A808}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5423D705-89D5-47D8-8298-BF1342D3A808}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5423D705-89D5-47D8-8298-BF1342D3A808}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5423D705-89D5-47D8-8298-BF1342D3A808}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -131,6 +133,7 @@ Global
 		{1DE566DF-628F-4B55-8EBE-5077293169D8} = {95C16AED-FD57-42A0-86C3-2CF4300A4817}
 		{B71E1AFD-6A00-49BA-B18E-BF710B531E73} = {95C16AED-FD57-42A0-86C3-2CF4300A4817}
 		{70D3A1D4-42FE-4697-AFC7-AC0FEAB0420B} = {95C16AED-FD57-42A0-86C3-2CF4300A4817}
+		{5423D705-89D5-47D8-8298-BF1342D3A808} = {95C16AED-FD57-42A0-86C3-2CF4300A4817}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {81FE5D8D-D707-4DBC-9782-95E44EA873C3}
diff --git a/src/Storage/Storage.Management/ChangeLog.md b/src/Storage/Storage.Management/ChangeLog.md
@@ -20,12 +20,20 @@
 ## Upcoming Release
 * Fixed upload blob fail by upgrade to Microsoft.Azure.Storage.DataMovement 2.0.0 [#12220]
 * Supported Point In Time Restore
-    - Enable-AzStorageBlobRestorePolicy
-    - Disable-AzStorageBlobRestorePolicy
-    - New-AzStorageBlobRangeToRestore
-    - Restore-AzStorageBlobRange
+    - `Enable-AzStorageBlobRestorePolicy`
+    - `Disable-AzStorageBlobRestorePolicy`
+    - `New-AzStorageBlobRangeToRestore`
+    - `Restore-AzStorageBlobRange`
 * Supported get blob restore status of Storage account by run get-AzureRMStorageAccount with parameter -IncludeBlobRestoreStatus 
-    - Get-AzureRMStorageAccount
+    - `Get-AzureRMStorageAccount`
+* Added breaking change warning message for upcoming cmdlet output change
+    - `Get-AzStorageContainerStoredAccessPolicy`
+    - `Set-AzStorageContainerStoredAccessPolicy`
+    - `Set-AzStorageAccountManagementPolicy`
+    - `Get-AzStorageAccountManagementPolicy`
+    - `Add-AzStorageAccountManagementPolicyAction`
+    - `New-AzStorageAccountManagementPolicyRule`
+
     
 ## Version 2.5.0
 * Supported blob query acceleration
diff --git a/src/Storage/Storage.Management/StorageAccount/AddAzureStorageAccountManagementPolicyAction.cs b/src/Storage/Storage.Management/StorageAccount/AddAzureStorageAccountManagementPolicyAction.cs
@@ -16,11 +16,13 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.Storage;
 using Microsoft.Azure.Management.Storage.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Globalization;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Management.Storage
 {
+    [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]
     [Cmdlet("Add", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicyAction", DefaultParameterSetName = BaseBlobParameterSet), OutputType(typeof(PSManagementPolicyActionGroup))]
     public class AddAzureStorageAccountManagementPolicyActionCommand : StorageAccountBaseCmdlet
     {
diff --git a/src/Storage/Storage.Management/StorageAccount/GetAzureStorageAccountManagementPolicy.cs b/src/Storage/Storage.Management/StorageAccount/GetAzureStorageAccountManagementPolicy.cs
@@ -17,10 +17,12 @@
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 using Microsoft.Azure.Management.Storage;
 using Microsoft.Azure.Management.Storage.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Management.Storage
 {
+    [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicy", DefaultParameterSetName = AccountNameParameterSet), OutputType(typeof(PSManagementPolicy))]
     public class GetAzureStorageAccountManagementPolicyCommand : StorageAccountBaseCmdlet
     {
diff --git a/src/Storage/Storage.Management/StorageAccount/NewAzureStorageAccountManagementPolicyRule.cs b/src/Storage/Storage.Management/StorageAccount/NewAzureStorageAccountManagementPolicyRule.cs
@@ -16,10 +16,12 @@
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.Management.Storage;
 using Microsoft.Azure.Management.Storage.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using System.Management.Automation;
 
 namespace Microsoft.Azure.Commands.Management.Storage
 {
+    [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicyRule"), OutputType(typeof(PSManagementPolicyRule))]
     public class NewAzureStorageAccountManagementPolicyRuleCommand : StorageAccountBaseCmdlet
     {
diff --git a/src/Storage/Storage.Management/StorageAccount/SetAzureStorageAccountManagementPolicy.cs b/src/Storage/Storage.Management/StorageAccount/SetAzureStorageAccountManagementPolicy.cs
@@ -21,9 +21,11 @@
 using System.Globalization;
 using System.Collections.Generic;
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.Management.Storage
 {
+    [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]
     [Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicy", SupportsShouldProcess = true, DefaultParameterSetName = AccountNamePolicyRuleParameterSet), OutputType(typeof(PSManagementPolicy))]
     public class SetAzureStorageAccountManagementPolicyCommand : StorageAccountBaseCmdlet
     {
diff --git a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainerStoredAccessPolicy.cs b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainerStoredAccessPolicy.cs
@@ -16,6 +16,7 @@ namespace Microsoft.WindowsAzure.Commands.Storage.Blob.Cmdlet
 {
     using Common;
     using Microsoft.Azure.Storage.Blob;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using Model.Contract;
     using System;
     using System.Globalization;
@@ -26,6 +27,7 @@ namespace Microsoft.WindowsAzure.Commands.Storage.Blob.Cmdlet
     /// <summary>
     /// create a new azure container
     /// </summary>
+    [CmdletOutputBreakingChange(typeof(SharedAccessBlobPolicy), ChangeDescription = "The output type will change from 'SharedAccessBlobPolicy' to 'PSObject', with the child property 'Permissions' type change from enum to string in a future release.")]
     [Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageContainerStoredAccessPolicy"), OutputType(typeof(SharedAccessBlobPolicy))]
     public class GetAzureStorageContainerStoredAccessPolicyCommand : StorageCloudBlobCmdletBase
     {
diff --git a/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerStoredAccessPolicy.cs b/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerStoredAccessPolicy.cs
@@ -16,6 +16,7 @@ namespace Microsoft.WindowsAzure.Commands.Storage.Blob.Cmdlet
 {
     using Common;
     using Microsoft.Azure.Storage.Blob;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using Model.Contract;
     using System;
     using System.Globalization;
@@ -25,6 +26,7 @@ namespace Microsoft.WindowsAzure.Commands.Storage.Blob.Cmdlet
     /// <summary>
     /// create a new azure container
     /// </summary>
+    [CmdletOutputBreakingChange(typeof(SharedAccessBlobPolicy), ChangeDescription = "The output type will change from 'SharedAccessBlobPolicy' to 'PSObject', with the child property 'Permissions' type change from enum to string in a future release.")]
     [Cmdlet("Set", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageContainerStoredAccessPolicy", SupportsShouldProcess = true), OutputType(typeof(String))]
     public class SetAzureStorageContainerStoredAccessPolicyCommand : StorageCloudBlobCmdletBase
     {

Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,13 @@`
`16`	`16`	`using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;`
`17`	`17`	`using Microsoft.Azure.Management.Storage;`
`18`	`18`	`using Microsoft.Azure.Management.Storage.Models;`
	`19`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`19`	`20`	`using System.Globalization;`
`20`	`21`	`using System.Management.Automation;`
`21`	`22`
`22`	`23`	`namespace Microsoft.Azure.Commands.Management.Storage`
`23`	`24`	`{`
	`25`	`+ [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]`
`24`	`26`	`[Cmdlet("Add", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicyAction", DefaultParameterSetName = BaseBlobParameterSet), OutputType(typeof(PSManagementPolicyActionGroup))]`
`25`	`27`	`public class AddAzureStorageAccountManagementPolicyActionCommand : StorageAccountBaseCmdlet`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,12 @@`
`17`	`17`	`using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;`
`18`	`18`	`using Microsoft.Azure.Management.Storage;`
`19`	`19`	`using Microsoft.Azure.Management.Storage.Models;`
	`20`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`20`	`21`	`using System.Management.Automation;`
`21`	`22`
`22`	`23`	`namespace Microsoft.Azure.Commands.Management.Storage`
`23`	`24`	`{`
	`25`	`+ [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]`
`24`	`26`	`[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicy", DefaultParameterSetName = AccountNameParameterSet), OutputType(typeof(PSManagementPolicy))]`
`25`	`27`	`public class GetAzureStorageAccountManagementPolicyCommand : StorageAccountBaseCmdlet`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,12 @@`
`16`	`16`	`using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;`
`17`	`17`	`using Microsoft.Azure.Management.Storage;`
`18`	`18`	`using Microsoft.Azure.Management.Storage.Models;`
	`19`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`19`	`20`	`using System.Management.Automation;`
`20`	`21`
`21`	`22`	`namespace Microsoft.Azure.Commands.Management.Storage`
`22`	`23`	`{`
	`24`	`+ [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]`
`23`	`25`	`[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicyRule"), OutputType(typeof(PSManagementPolicyRule))]`
`24`	`26`	`public class NewAzureStorageAccountManagementPolicyRuleCommand : StorageAccountBaseCmdlet`
`25`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,11 @@`
`21`	`21`	`using System.Globalization;`
`22`	`22`	`using System.Collections.Generic;`
`23`	`23`	`using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;`
	`24`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`24`	`25`
`25`	`26`	`namespace Microsoft.Azure.Commands.Management.Storage`
`26`	`27`	`{`
	`28`	`+ [CmdletOutputBreakingChange(typeof(PSManagementPolicyActionGroup), ChangeDescription = "The type of sub child property DaysAfterModificationGreaterThan will change from int to int? in a future release.")]`
`27`	`29`	`[Cmdlet("Set", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "StorageAccountManagementPolicy", SupportsShouldProcess = true, DefaultParameterSetName = AccountNamePolicyRuleParameterSet), OutputType(typeof(PSManagementPolicy))]`
`28`	`30`	`public class SetAzureStorageAccountManagementPolicyCommand : StorageAccountBaseCmdlet`
`29`	`31`	`{`