[Az.Synapse] Remove the unnecessary breaking change of parameter '-SparkConfigFilePath' for Spark Pool related cmdlets (#21739)

* Remove the unnecessary breaking change of parameter '-SparkConfigFilePath' for  and  cmdlets

* add breaking changes to Az.Synapse BreakingChangeIssues.csv

Author: yanjungao718

src/Synapse/Synapse/ChangeLog.md

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Remove the unnecessary breaking change of parameter '-SparkConfigFilePath' for `New-AzSynapseSparkPool` and `Update-AzSynapseSparkPool` cmdlets
 
 ## Version 2.3.1
 * Updated Azure.Core to 1.31.0.

src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/NewAzureSynapseSparkPool.cs

@@ -20,7 +20,6 @@
 using Microsoft.Azure.Commands.Synapse.Properties;
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 using Microsoft.Azure.Management.Synapse.Models;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System.Collections;
 using System.IO;
@@ -130,12 +129,6 @@ public class NewAzureSynapseSparkPool : SynapseManagementCmdletBase
         [ValidateNotNullOrEmpty]
         public string SparkVersion { get; set; }
 
-        [CmdletParameterBreakingChange("SparkConfigFilePath", ReplaceMentCmdletParameterName = "SparkConfiguration")]
-        [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
-            HelpMessage = HelpMessages.SparkConfigPropertiesFilePath)]
-        [ValidateNotNullOrEmpty]
-        public string SparkConfigFilePath { get; set; }
-
         [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
           HelpMessage = HelpMessages.SparkConfigurationResource)]
         public PSSparkConfigurationResource SparkConfiguration { get; set; }
@@ -195,16 +188,6 @@ public override void ExecuteCmdlet()
             }
 
             SparkConfigProperties sparkConfigProperties = null;
-            if (this.IsParameterBound(c => c.SparkConfigFilePath))
-            {
-                string path = this.TryResolvePath(SparkConfigFilePath);
-                string filename = Path.GetFileNameWithoutExtension(path);
-                sparkConfigProperties = new SparkConfigProperties()
-                {
-                    Content = this.ReadFileAsText(this.SparkConfigFilePath),
-                    Filename = filename
-                };
-            }
 
             if (this.IsParameterBound(c => c.SparkConfiguration))
             {

src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/UpdateAzureSynapseSparkPool.cs

@@ -21,7 +21,6 @@
 using Microsoft.Azure.Commands.Synapse.Properties;
 using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
 using Microsoft.Azure.Management.Synapse.Models;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Collections;
@@ -143,11 +142,6 @@ public class UpdateAzureSynapseSparkPool : SynapseManagementCmdletBase
             HelpMessage = HelpMessages.LibraryRequirementsFilePath)]
         public string LibraryRequirementsFilePath { get; set; }
 
-        [CmdletParameterBreakingChange("SparkConfigFilePath", ReplaceMentCmdletParameterName = "SparkConfiguration")]
-        [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
-           HelpMessage = HelpMessages.SparkConfigPropertiesFilePath)]
-        public string SparkConfigFilePath { get; set; }
-
         [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
            HelpMessage = HelpMessages.SparkConfigurationResource)]
         public PSSparkConfigurationResource SparkConfiguration { get; set; }
@@ -222,7 +216,6 @@ public override void ExecuteCmdlet()
             existingSparkPool.IsComputeIsolationEnabled = this.EnableIsolatedCompute != null ? this.EnableIsolatedCompute : existingSparkPool.IsComputeIsolationEnabled ?? false;
             existingSparkPool.NodeSize = this.IsParameterBound(c => c.NodeSize) ? this.NodeSize : existingSparkPool.NodeSize;
             existingSparkPool.LibraryRequirements = this.IsParameterBound(c => c.LibraryRequirementsFilePath) ? CreateLibraryRequirements() : existingSparkPool.LibraryRequirements;
-            existingSparkPool.SparkConfigProperties = this.IsParameterBound(c => c.SparkConfigFilePath) ? CreateSparkConfigProperties() : existingSparkPool.SparkConfigProperties;
             existingSparkPool.SparkVersion = this.IsParameterBound(c => c.SparkVersion) ? this.SparkVersion : existingSparkPool.SparkVersion;
 
             if (this.IsParameterBound(c => c.EnableAutoScale)
@@ -333,22 +326,6 @@ private LibraryRequirements CreateLibraryRequirements()
             };
         }
 
-        private SparkConfigProperties CreateSparkConfigProperties()
-        {
-            if (string.IsNullOrEmpty(SparkConfigFilePath))
-            {
-                return null;
-            }
-
-            var powerShellDestinationPath = SessionState.Path.GetUnresolvedProviderPathFromPSPath(SparkConfigFilePath);
-
-            return new SparkConfigProperties
-            {
-                Filename = Path.GetFileName(powerShellDestinationPath),
-                Content = this.ReadFileAsText(powerShellDestinationPath)
-            };
-        }
-
         private class LibraryComparer : IEqualityComparer<LibraryInfo>
         {
             public bool Equals(LibraryInfo x, LibraryInfo y)

src/Synapse/Synapse/Common/HelpMessages.cs

@@ -116,8 +116,6 @@ public static class HelpMessages
 
         public const string LibraryRequirementsFilePath = "Environment configuration file (\"PIP freeze\" output).";
 
-        public const string SparkConfigPropertiesFilePath = "[Deprecated] Spark pool properties configuration file. This parameter is deprecated, please use \"-SparkConfiguration\" instead.";
-
         public const string SparkConfigurationResource = "Apache Spark configuration. When a job is submitted to the pool, the properties specified in the selected configuration will be referenced.";
 
         public const string Batch = "Indicates Spark batch.";

src/Synapse/Synapse/help/New-AzSynapseSparkPool.md

@@ -17,7 +17,7 @@ Creates a Synapse Analytics Spark pool.
 New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>]
  [-EnableIsolatedCompute] -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32>
  [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation]
- [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfigFilePath <String>]
+ [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String>
  [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
@@ -27,17 +27,16 @@ New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Na
 New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>]
  -NodeCount <Int32> [-EnableIsolatedCompute] -NodeSize <String> [-EnableAutoPause]
  [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] [-MinExecutorCount <Int32>]
- [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfigFilePath <String>]
- [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfiguration <PSSparkConfigurationResource>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### CreateByParentObjectAndEnableAutoScaleParameterSet
 ```
 New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>]
  [-EnableIsolatedCompute] -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32>
  [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation]
- [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfigFilePath <String>]
+ [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] -SparkVersion <String>
  [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
@@ -47,9 +46,8 @@ New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Ta
 New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>]
  -NodeCount <Int32> [-EnableIsolatedCompute] -NodeSize <String> [-EnableAutoPause]
  [-AutoPauseDelayInMinute <Int32>] [-EnableDynamicExecutorAllocation] [-MinExecutorCount <Int32>]
- [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfigFilePath <String>]
- [-SparkConfiguration <PSSparkConfigurationResource>] [-AsJob] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ [-MaxExecutorCount <Int32>] -SparkVersion <String> [-SparkConfiguration <PSSparkConfigurationResource>]
+ [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -326,21 +324,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SparkConfigFilePath
-[Deprecated] Spark pool properties configuration file. This parameter is deprecated, please use "-SparkConfiguration" instead.
-
-```yaml
-Type: System.String
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -SparkConfiguration
 Apache Spark configuration. When a job is submitted to the pool, the properties specified in the selected configuration will be referenced.
 

src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md

@@ -19,7 +19,7 @@ Update-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String>
  [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>]
  [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>]
  [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>]
- [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] [-SparkConfigFilePath <String>]
+ [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>]
  [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>]
  [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
@@ -33,8 +33,8 @@ Update-AzSynapseSparkPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [
  [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>]
  [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>] [-EnableDynamicExecutorAllocation <Boolean>]
  [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>] [-SparkVersion <String>]
- [-LibraryRequirementsFilePath <String>] [-SparkConfigFilePath <String>]
- [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>]
+ [-LibraryRequirementsFilePath <String>] [-SparkConfiguration <PSSparkConfigurationResource>]
+ [-PackageAction <PackageActionType>]
  [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
@@ -46,7 +46,7 @@ Update-AzSynapseSparkPool -InputObject <PSSynapseSparkPool> [-Tag <Hashtable>] [
  [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>]
  [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>]
  [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>]
- [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] [-SparkConfigFilePath <String>]
+ [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>]
  [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>]
  [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
@@ -59,7 +59,7 @@ Update-AzSynapseSparkPool -ResourceId <String> [-Tag <Hashtable>] [-EnableAutoSc
  [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>]
  [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-EnableIsolatedCompute <Boolean>] [-NodeSize <String>]
  [-EnableDynamicExecutorAllocation <Boolean>] [-MinExecutorCount <Int32>] [-MaxExecutorCount <Int32>]
- [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>] [-SparkConfigFilePath <String>]
+ [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>]
  [-SparkConfiguration <PSSparkConfigurationResource>] [-PackageAction <PackageActionType>]
  [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-ForceApplySetting] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
@@ -533,21 +533,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -SparkConfigFilePath
-[Deprecated] Spark pool properties configuration file. This parameter is deprecated, please use "-SparkConfiguration" instead.
-
-```yaml
-Type: System.String
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -SparkConfiguration
 Apache Spark configuration. When a job is submitted to the pool, the properties specified in the selected configuration will be referenced.
 

tools/StaticAnalysis/Exceptions/Az.Synapse/BreakingChangeIssues.csv

@@ -0,0 +1,13 @@
+"Module","ClassName","Target","Severity","ProblemId","Description","Remediation"
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","2000","The cmdlet 'New-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias was found for the original parameter name.","Add the parameter 'SparkConfigFilePath' back to the cmdlet 'New-AzSynapseSparkPool', or add an alias to the original parameter name."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","1050","The parameter set 'CreateByNameAndEnableAutoScaleParameterSet' for cmdlet 'New-AzSynapseSparkPool' has been removed.","Add parameter set 'CreateByNameAndEnableAutoScaleParameterSet' back to cmdlet 'New-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","1050","The parameter set 'CreateByNameAndDisableAutoScaleParameterSet' for cmdlet 'New-AzSynapseSparkPool' has been removed.","Add parameter set 'CreateByNameAndDisableAutoScaleParameterSet' back to cmdlet 'New-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","1050","The parameter set 'CreateByParentObjectAndEnableAutoScaleParameterSet' for cmdlet 'New-AzSynapseSparkPool' has been removed.","Add parameter set 'CreateByParentObjectAndEnableAutoScaleParameterSet' back to cmdlet 'New-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","1050","The parameter set 'CreateByParentObjectAndDisableAutoScaleParameterSet' for cmdlet 'New-AzSynapseSparkPool' has been removed.","Add parameter set 'CreateByParentObjectAndDisableAutoScaleParameterSet' back to cmdlet 'New-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.NewAzureSynapseSparkPool","New-AzSynapseSparkPool","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzSynapseSparkPool' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","2000","The cmdlet 'Update-AzSynapseSparkPool' no longer supports the parameter 'SparkConfigFilePath' and no alias was found for the original parameter name.","Add the parameter 'SparkConfigFilePath' back to the cmdlet 'Update-AzSynapseSparkPool', or add an alias to the original parameter name."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","1050","The parameter set 'SetByNameParameterSet' for cmdlet 'Update-AzSynapseSparkPool' has been removed.","Add parameter set 'SetByNameParameterSet' back to cmdlet 'Update-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","1050","The parameter set 'SetByParentObjectParameterSet' for cmdlet 'Update-AzSynapseSparkPool' has been removed.","Add parameter set 'SetByParentObjectParameterSet' back to cmdlet 'Update-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","1050","The parameter set 'SetByInputObjectParameterSet' for cmdlet 'Update-AzSynapseSparkPool' has been removed.","Add parameter set 'SetByInputObjectParameterSet' back to cmdlet 'Update-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","1050","The parameter set 'SetByResourceIdParameterSet' for cmdlet 'Update-AzSynapseSparkPool' has been removed.","Add parameter set 'SetByResourceIdParameterSet' back to cmdlet 'Update-AzSynapseSparkPool'."
+"Az.Synapse","Microsoft.Azure.Commands.Synapse.UpdateAzureSynapseSparkPool","Update-AzSynapseSparkPool","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Update-AzSynapseSparkPool' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Update-AzSynapseSparkPool'."