[Storage] Add breaking notice for File cmdlets in Build (Azure#11493)

blueww · web-flow · commit 744ae6dcf6f0 · 2020-04-07T18:49:53.000+08:00
diff --git a/src/Storage/Storage.Management/ChangeLog.md b/src/Storage/Storage.Management/ChangeLog.md
@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Add breaking change notice for Azure File cmdlets output change in a future release
 * Support new SkuName StandardGZRS, StandardRAGZRS when create/update Storage account
     - New-AzStorageAccount
     - Set-AzStorageAccount
diff --git a/src/Storage/Storage/File/Cmdlet/GetAzureStorageFile.cs b/src/Storage/Storage/File/Cmdlet/GetAzureStorageFile.cs
@@ -16,12 +16,14 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     using Microsoft.Azure.Storage;
     using Microsoft.Azure.Storage.File;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Globalization;
     using System.Management.Automation;
     using System.Net;
 
     [Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFile", DefaultParameterSetName = Constants.ShareNameParameterSetName)]
     [OutputType(typeof(CloudFile))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class GetAzureStorageFile : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/GetAzureStorageFileContent.cs b/src/Storage/Storage/File/Cmdlet/GetAzureStorageFileContent.cs
@@ -28,9 +28,11 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
     using LocalDirectory = System.IO.Directory;
     using LocalPath = System.IO.Path;
     using System.Runtime.InteropServices;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileContent", SupportsShouldProcess = true, DefaultParameterSetName = LocalConstants.ShareNameParameterSetName)]
     [OutputType(typeof(CloudFile))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class GetAzureStorageFileContent : StorageFileDataManagementCmdletBase, IDynamicParameters
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/GetAzureStorageFileCopyState.cs b/src/Storage/Storage/File/Cmdlet/GetAzureStorageFileCopyState.cs
@@ -22,11 +22,13 @@
 using System.Security.Permissions;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     [Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileCopyState")]
     [OutputType(typeof(CloudFile))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class GetAzureStorageFileCopyStateCommand : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/GetAzureStorageShare.cs b/src/Storage/Storage/File/Cmdlet/GetAzureStorageShare.cs
@@ -21,9 +21,11 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
     using System;
     using System.Globalization;
     using System.Management.Automation;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShare", DefaultParameterSetName = Constants.MatchingPrefixParameterSetName)]
     [OutputType(typeof(CloudFileShare))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileShare to AzureStorageFileShare, and AzureStorageFileShare will have CloudFileShare as a child property.")]
     public class GetAzureStorageShare : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/NewAzureStorageDirectory.cs b/src/Storage/Storage/File/Cmdlet/NewAzureStorageDirectory.cs
@@ -15,10 +15,12 @@
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     using Microsoft.Azure.Storage.File;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Globalization;
     using System.Management.Automation;
 
     [Cmdlet("New", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageDirectory", DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFileDirectory))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileDirectory to AzureStorageFileDirectory, and AzureStorageFileDirectory will have CloudFileDirectory as a child property.")]
     public class NewAzureStorageDirectory : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/NewAzureStorageShare.cs b/src/Storage/Storage/File/Cmdlet/NewAzureStorageShare.cs
@@ -16,8 +16,10 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     using System.Management.Automation;
     using Azure.Storage.File;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("New", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShare", DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFileShare))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileShare to AzureStorageFileShare, and AzureStorageFileShare will have CloudFileShare as a child property.")]
     public class NewAzureStorageShare : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageDirectory.cs b/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageDirectory.cs
@@ -15,10 +15,12 @@
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     using Microsoft.Azure.Storage.File;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Globalization;
     using System.Management.Automation;
 
     [Cmdlet("Remove", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageDirectory",SupportsShouldProcess = true,DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFileDirectory))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileDirectory to AzureStorageFileDirectory, and AzureStorageFileDirectory will have CloudFileDirectory as a child property.")]
     public class RemoveAzureStorageDirectory : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageFile.cs b/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageFile.cs
@@ -15,10 +15,12 @@
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     using Microsoft.Azure.Storage.File;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
     using System.Globalization;
     using System.Management.Automation;
 
     [Cmdlet("Remove", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFile",SupportsShouldProcess = true,DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFile))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class RemoveAzureStorageFile : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageShare.cs b/src/Storage/Storage/File/Cmdlet/RemoveAzureStorageShare.cs
@@ -19,8 +19,10 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
     using Microsoft.Azure.Storage.File;
     using System.Globalization;
     using System.Management.Automation;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("Remove", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShare",DefaultParameterSetName = Constants.ShareNameParameterSetName,SupportsShouldProcess = true), OutputType(typeof(CloudFileShare))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileShare to AzureStorageFileShare, and AzureStorageFileShare will have CloudFileShare as a child property.")]
     public class RemoveAzureStorageShare : AzureStorageFileCmdletBase
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/SetAzureStorageFileContent.cs b/src/Storage/Storage/File/Cmdlet/SetAzureStorageFileContent.cs
@@ -28,8 +28,10 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
     using LocalConstants = Microsoft.WindowsAzure.Commands.Storage.File.Constants;
     using System.Runtime.InteropServices;
     using Microsoft.Azure.Storage.DataMovement;
+    using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
     [Cmdlet("Set", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileContent", SupportsShouldProcess = true, DefaultParameterSetName = LocalConstants.ShareNameParameterSetName), OutputType(typeof(CloudFile))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class SetAzureStorageFileContent : StorageFileDataManagementCmdletBase, IDynamicParameters
     {
         [Parameter(
diff --git a/src/Storage/Storage/File/Cmdlet/SetAzureStorageShareQuota.cs b/src/Storage/Storage/File/Cmdlet/SetAzureStorageShareQuota.cs
@@ -17,10 +17,12 @@
 using System.Globalization;
 using System.Management.Automation;
 using System.Security.Permissions;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     [Cmdlet("Set", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShareQuota"), OutputType(typeof(FileShareProperties))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from FileShareProperties to AzureStorageFileShare, and AzureStorageFileShare will have FileShareProperties in child property.")]
     public class SetAzureStorageShareQuota : AzureStorageFileCmdletBase
     {
         [Alias("N", "Name")]
diff --git a/src/Storage/Storage/File/Cmdlet/StartAzureStorageFileCopy.cs b/src/Storage/Storage/File/Cmdlet/StartAzureStorageFileCopy.cs
@@ -23,10 +23,12 @@
 using System.Management.Automation;
 using System.Security.Permissions;
 using System.Threading.Tasks;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet
 {
     [Cmdlet("Start", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileCopy", SupportsShouldProcess = true), OutputType(typeof(void))]
+    [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]
     public class StartAzureStorageFileCopyCommand : StorageFileDataManagementCmdletBase
     {
         private const string ContainerNameParameterSet = "ContainerName";

Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,14 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`16`	`16`	`{`
`17`	`17`	`using Microsoft.Azure.Storage;`
`18`	`18`	`using Microsoft.Azure.Storage.File;`
	`19`	`+ using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`19`	`20`	`using System.Globalization;`
`20`	`21`	`using System.Management.Automation;`
`21`	`22`	`using System.Net;`
`22`	`23`
`23`	`24`	`[Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFile", DefaultParameterSetName = Constants.ShareNameParameterSetName)]`
`24`	`25`	`[OutputType(typeof(CloudFile))]`
	`26`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]`
`25`	`27`	`public class GetAzureStorageFile : AzureStorageFileCmdletBase`
`26`	`28`	`{`
`27`	`29`	`[Parameter(`
Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,13 @@`
`22`	`22`	`using System.Security.Permissions;`
`23`	`23`	`using System.Threading;`
`24`	`24`	`using System.Threading.Tasks;`
	`25`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`25`	`26`
`26`	`27`	`namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`27`	`28`	`{`
`28`	`29`	`[Cmdlet("Get", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileCopyState")]`
`29`	`30`	`[OutputType(typeof(CloudFile))]`
	`31`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]`
`30`	`32`	`public class GetAzureStorageFileCopyStateCommand : AzureStorageFileCmdletBase`
`31`	`33`	`{`
`32`	`34`	`[Parameter(`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,12 @@`
`15`	`15`	`namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`16`	`16`	`{`
`17`	`17`	`using Microsoft.Azure.Storage.File;`
	`18`	`+ using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`18`	`19`	`using System.Globalization;`
`19`	`20`	`using System.Management.Automation;`
`20`	`21`
`21`	`22`	`[Cmdlet("New", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageDirectory", DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFileDirectory))]`
	`23`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileDirectory to AzureStorageFileDirectory, and AzureStorageFileDirectory will have CloudFileDirectory as a child property.")]`
`22`	`24`	`public class NewAzureStorageDirectory : AzureStorageFileCmdletBase`
`23`	`25`	`{`
`24`	`26`	`[Parameter(`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,10 @@ namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`16`	`16`	`{`
`17`	`17`	`using System.Management.Automation;`
`18`	`18`	`using Azure.Storage.File;`
	`19`	`+ using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`19`	`20`
`20`	`21`	`[Cmdlet("New", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShare", DefaultParameterSetName = Constants.ShareNameParameterSetName), OutputType(typeof(CloudFileShare))]`
	`22`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFileShare to AzureStorageFileShare, and AzureStorageFileShare will have CloudFileShare as a child property.")]`
`21`	`23`	`public class NewAzureStorageShare : AzureStorageFileCmdletBase`
`22`	`24`	`{`
`23`	`25`	`[Parameter(`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,12 @@`
`17`	`17`	`using System.Globalization;`
`18`	`18`	`using System.Management.Automation;`
`19`	`19`	`using System.Security.Permissions;`
	`20`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`20`	`21`
`21`	`22`	`namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`22`	`23`	`{`
`23`	`24`	`[Cmdlet("Set", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageShareQuota"), OutputType(typeof(FileShareProperties))]`
	`25`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from FileShareProperties to AzureStorageFileShare, and AzureStorageFileShare will have FileShareProperties in child property.")]`
`24`	`26`	`public class SetAzureStorageShareQuota : AzureStorageFileCmdletBase`
`25`	`27`	`{`
`26`	`28`	`[Alias("N", "Name")]`
Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,12 @@`
`23`	`23`	`using System.Management.Automation;`
`24`	`24`	`using System.Security.Permissions;`
`25`	`25`	`using System.Threading.Tasks;`
	`26`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`26`	`27`
`27`	`28`	`namespace Microsoft.WindowsAzure.Commands.Storage.File.Cmdlet`
`28`	`29`	`{`
`29`	`30`	`[Cmdlet("Start", Azure.Commands.ResourceManager.Common.AzureRMConstants.AzurePrefix + "StorageFileCopy", SupportsShouldProcess = true), OutputType(typeof(void))]`
	`31`	`+ [CmdletOutputBreakingChange(typeof(CloudFile), ChangeDescription = "The output type will change from CloudFile to AzureStorageFile, and AzureStorageFile will have CloudFile as a child property.")]`
`30`	`32`	`public class StartAzureStorageFileCopyCommand : StorageFileDataManagementCmdletBase`
`31`	`33`	`{`
`32`	`34`	`private const string ContainerNameParameterSet = "ContainerName";`