Add deprecation warning message on WSC cmdlets (#21584)

ayeshurun · wyunchi-ms · web-flow · commit 1a13331d9c3d · 2023-04-18T21:55:26.000+08:00
* mark wsc cmdlets as deprecated

* Update ChangeLog.md

---------

Co-authored-by: Yunchi Wang &lt;54880216+wyunchi-ms@users.noreply.github.com&gt;
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded.sln b/src/PowerBIEmbedded/PowerBIEmbedded.sln
@@ -1,6 +1,6 @@
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.27703.2042
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.33530.505
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PowerBIEmbedded", "PowerBIEmbedded\PowerBIEmbedded.csproj", "{50C2BA13-7203-4A70-9058-19FB15C730DA}"
 EndProject
@@ -94,6 +94,18 @@ Global
 		{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Release|x64.Build.0 = Release|Any CPU
 		{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Release|x86.ActiveCfg = Release|Any CPU
 		{142D7B0B-388A-4CEB-A228-7F6D423C5C2E}.Release|x86.Build.0 = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|x64.Build.0 = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Debug|x86.Build.0 = Debug|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|x64.ActiveCfg = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|x64.Build.0 = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|x86.ActiveCfg = Release|Any CPU
+		{6BD6B80A-06AF-4B5B-9230-69CCFC6C8D64}.Release|x86.Build.0 = Release|Any CPU
 		{FF81DC73-B8EC-4082-8841-4FBF2B16E7CE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{FF81DC73-B8EC-4082-8841-4FBF2B16E7CE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FF81DC73-B8EC-4082-8841-4FBF2B16E7CE}.Debug|x64.ActiveCfg = Debug|Any CPU
@@ -153,4 +165,4 @@ Global
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DB4F6337-206E-4CC4-9940-C24794336EEB}
 	EndGlobalSection
-EndGlobal
+EndGlobal
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/ChangeLog.md b/src/PowerBIEmbedded/PowerBIEmbedded/ChangeLog.md
@@ -18,7 +18,8 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
-
+* Added deprecate warning message for workspace collection cmdlets
+  
 ## Version 1.2.0
 * Updated SKU allowed values to support A7 and A8
 
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspace.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspace.cs
@@ -16,9 +16,11 @@
 using Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models;
 using Microsoft.Azure.Management.PowerBIEmbedded;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
+    [CmdletDeprecation()]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspace"), OutputType(typeof(PSWorkspace))]
     public class GetWorkspace : WorkspaceCollectionBaseCmdlet
     {
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspaceCollection.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspaceCollection.cs
@@ -17,9 +17,11 @@
 using Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models;
 using Microsoft.Azure.Management.PowerBIEmbedded;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
+    [CmdletDeprecation()]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollection"), OutputType(typeof(PSWorkspaceCollection))]
     public class GetWorkspaceCollection : WorkspaceCollectionBaseCmdlet
     {
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspaceCollectionAccessKeys.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/GetWorkspaceCollectionAccessKeys.cs
@@ -20,7 +20,7 @@
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
-    [GenericBreakingChange("Get-AzPowerBIWorkspaceCollectionAccessKeys alias will be removed in an upcoming breaking change release", "2.0.0")]
+    [CmdletDeprecation()]
     [Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollectionAccessKey"), OutputType(typeof(PSWorkspaceCollectionAccessKey))]
     [Alias("Get-AzPowerBIWorkspaceCollectionAccessKeys")]
     public class GetWorkspaceCollectionAccessKeys : WorkspaceCollectionBaseCmdlet
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/NewWorkspaceCollection.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/NewWorkspaceCollection.cs
@@ -18,9 +18,11 @@
 using Microsoft.Azure.Management.PowerBIEmbedded;
 using Microsoft.Azure.Management.PowerBIEmbedded.Models;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
+    [CmdletDeprecation()]
     [Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollection", SupportsShouldProcess = true), OutputType(typeof(PSWorkspaceCollection))]
     public class NewWorkspaceCollection : WorkspaceCollectionBaseCmdlet
     {
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/RemoveWorkspaceCollection.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/RemoveWorkspaceCollection.cs
@@ -16,9 +16,11 @@
 using Microsoft.Azure.Commands.Management.PowerBIEmbedded.Properties;
 using Microsoft.Azure.Management.PowerBIEmbedded;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
+    [CmdletDeprecation()]
     [Cmdlet("Remove", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollection", SupportsShouldProcess = true), OutputType(typeof(void))]
     public class RemoveWorkspaceCollection : WorkspaceCollectionBaseCmdlet
     {
diff --git a/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/ResetWorkspaceCollectionAccessKeys.cs b/src/PowerBIEmbedded/PowerBIEmbedded/WorkspaceCollection/ResetWorkspaceCollectionAccessKeys.cs
@@ -25,7 +25,7 @@
 
 namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection
 {
-    [GenericBreakingChange("Reset-AzPowerBIWorkspaceCollectionAccessKeys alias will be removed in an upcoming breaking change release", "2.0.0")]
+    [CmdletDeprecation()]
     [Cmdlet("Reset", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollectionAccessKey", SupportsShouldProcess = true), OutputType(typeof(PSWorkspaceCollectionAccessKey))]
     [Alias("Reset-AzPowerBIWorkspaceCollectionAccessKeys")]
     public class ResetWorkspaceCollectionAccessKeys : WorkspaceCollectionBaseCmdlet

Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,11 @@`
`16`	`16`	`using Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models;`
`17`	`17`	`using Microsoft.Azure.Management.PowerBIEmbedded;`
`18`	`18`	`using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;`
	`19`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`19`	`20`
`20`	`21`	`namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection`
`21`	`22`	`{`
	`23`	`+ [CmdletDeprecation()]`
`22`	`24`	`[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspace"), OutputType(typeof(PSWorkspace))]`
`23`	`25`	`public class GetWorkspace : WorkspaceCollectionBaseCmdlet`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,11 @@`
`17`	`17`	`using Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models;`
`18`	`18`	`using Microsoft.Azure.Management.PowerBIEmbedded;`
`19`	`19`	`using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;`
	`20`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`20`	`21`
`21`	`22`	`namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection`
`22`	`23`	`{`
	`24`	`+ [CmdletDeprecation()]`
`23`	`25`	`[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollection"), OutputType(typeof(PSWorkspaceCollection))]`
`24`	`26`	`public class GetWorkspaceCollection : WorkspaceCollectionBaseCmdlet`
`25`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`
`21`	`21`	`namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection`
`22`	`22`	`{`
`23`		`- [GenericBreakingChange("Get-AzPowerBIWorkspaceCollectionAccessKeys alias will be removed in an upcoming breaking change release", "2.0.0")]`
	`23`	`+ [CmdletDeprecation()]`
`24`	`24`	`[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollectionAccessKey"), OutputType(typeof(PSWorkspaceCollectionAccessKey))]`
`25`	`25`	`[Alias("Get-AzPowerBIWorkspaceCollectionAccessKeys")]`
`26`	`26`	`public class GetWorkspaceCollectionAccessKeys : WorkspaceCollectionBaseCmdlet`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,11 @@`
`18`	`18`	`using Microsoft.Azure.Management.PowerBIEmbedded;`
`19`	`19`	`using Microsoft.Azure.Management.PowerBIEmbedded.Models;`
`20`	`20`	`using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;`
	`21`	`+using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;`
`21`	`22`
`22`	`23`	`namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection`
`23`	`24`	`{`
	`25`	`+ [CmdletDeprecation()]`
`24`	`26`	`[Cmdlet("New", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollection", SupportsShouldProcess = true), OutputType(typeof(PSWorkspaceCollection))]`
`25`	`27`	`public class NewWorkspaceCollection : WorkspaceCollectionBaseCmdlet`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`
`26`	`26`	`namespace Microsoft.Azure.Commands.Management.PowerBIEmbedded.WorkspaceCollection`
`27`	`27`	`{`
`28`		`- [GenericBreakingChange("Reset-AzPowerBIWorkspaceCollectionAccessKeys alias will be removed in an upcoming breaking change release", "2.0.0")]`
	`28`	`+ [CmdletDeprecation()]`
`29`	`29`	`[Cmdlet("Reset", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "PowerBIWorkspaceCollectionAccessKey", SupportsShouldProcess = true), OutputType(typeof(PSWorkspaceCollectionAccessKey))]`
`30`	`30`	`[Alias("Reset-AzPowerBIWorkspaceCollectionAccessKeys")]`
`31`	`31`	`public class ResetWorkspaceCollectionAccessKeys : WorkspaceCollectionBaseCmdlet`