add New-AzSynapseSparkPool help doc

Author: Wan Yang

src/Synapse/Synapse.Test/ScenarioTests/SparkPoolTests.ps1

@@ -9,7 +9,7 @@ function Test-SynapseSparkPool
         $resourceGroupName = (Get-ResourceGroupName),
         $workspaceName = (Get-SynapseWorkspaceName),
         $sparkPoolName = (Get-SynapseSparkPoolName),
-        $sparkPoolName1 = $sparkPoolName + "1",
+        $sparkPoolNameForAutoScale = $sparkPoolName + "1",
         $sparkPoolNodeCount = 3,
         $sparkAutoScaleMinNodeCount = 3,
         $sparkAutoScaleMaxNodeCount = 6,
@@ -28,20 +28,20 @@ function Test-SynapseSparkPool
         Assert-False {Test-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName}
 
         # UnableAutoScale 
-        $sparkPoolCreated1 = New-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName -NodeCount $sparkPoolNodeCount -SparkVersion $sparkVersion -NodeSize $sparkPoolNodeSize
+        $sparkPoolCreatedForUnableAutoScale = New-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName -NodeCount $sparkPoolNodeCount -SparkVersion $sparkVersion -NodeSize $sparkPoolNodeSize
 
-        Assert-AreEqual $sparkPoolName $sparkPoolCreated1.Name
-        Assert-AreEqual $location $sparkPoolCreated1.Location
-        Assert-AreEqual "Microsoft.Synapse/Workspaces/bigDataPools" $sparkPoolCreated1.Type
-        Assert-True {$sparkPoolCreated1.Id -like "*$resourceGroupName*"}
+        Assert-AreEqual $sparkPoolName $sparkPoolCreatedForUnableAutoScale.Name
+        Assert-AreEqual $location $sparkPoolCreatedForUnableAutoScale.Location
+        Assert-AreEqual "Microsoft.Synapse/Workspaces/bigDataPools" $sparkPoolCreatedForUnableAutoScale.Type
+        Assert-True {$sparkPoolCreatedForUnableAutoScale.Id -like "*$resourceGroupName*"}
 
         # just test create for EnableAutoScale
-        $sparkPoolCreated2 = New-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName1 -AutoScaleMinNodeCount $sparkAutoScaleMinNodeCount -AutoScaleMaxNodeCount $sparkAutoScaleMaxNodeCount   -SparkVersion $sparkVersion -NodeSize $sparkPoolNodeSize
+        $sparkPoolCreatedForAutoScale = New-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolNameForAutoScale -AutoScaleMinNodeCount $sparkAutoScaleMinNodeCount -AutoScaleMaxNodeCount $sparkAutoScaleMaxNodeCount   -SparkVersion $sparkVersion -NodeSize $sparkPoolNodeSize
 
-        Assert-AreEqual $sparkPoolName1 $sparkPoolCreated2.Name
-        Assert-AreEqual $location $sparkPoolCreated2.Location
-        Assert-AreEqual "Microsoft.Synapse/Workspaces/bigDataPools" $sparkPoolCreated2.Type
-        Assert-True {$sparkPoolCreated2.Id -like "*$resourceGroupName*"}
+        Assert-AreEqual $sparkPoolNameForAutoScale $sparkPoolCreatedForAutoScale.Name
+        Assert-AreEqual $location $sparkPoolCreatedForAutoScale.Location
+        Assert-AreEqual "Microsoft.Synapse/Workspaces/bigDataPools" $sparkPoolCreatedForAutoScale.Type
+        Assert-True {$sparkPoolCreatedForAutoScale.Id -like "*$resourceGroupName*"}
 
         # In loop to check if Spark pool exists
         for ($i = 0; $i -le 60; $i++)
@@ -52,7 +52,7 @@ function Test-SynapseSparkPool
                 Assert-AreEqual $sparkPoolName $sparkPoolGet[0].Name
                 Assert-AreEqual $location $sparkPoolGet[0].Location
                 Assert-AreEqual "Microsoft.Synapse/Workspaces/bigDataPools" $sparkPoolGet[0].Type
-                Assert-True {$sparkPoolCreated1.Id -like "*$resourceGroupName*"}
+                Assert-True {$sparkPoolCreatedForUnableAutoScale.Id -like "*$resourceGroupName*"}
                 break
             }
 
@@ -126,7 +126,7 @@ function Test-SynapseSparkPool
 
         # Delete SparkPool
         Assert-True {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName -PassThru} "Remove SparkPool failed."
-        Assert-True {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName1 -PassThru} "Remove SparkPool failed."
+        Assert-True {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolNameForAutoScale -PassThru} "Remove SparkPool failed."
 
         # Verify that it is gone by trying to get it again
         Assert-Throws {Get-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName}
@@ -135,6 +135,6 @@ function Test-SynapseSparkPool
     {
         # cleanup the spark pool that was used in case it still exists. This is a best effort task, we ignore failures here.
         Invoke-HandledCmdlet -Command {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName -ErrorAction SilentlyContinue} -IgnoreFailures
-        Invoke-HandledCmdlet -Command {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolName1 -ErrorAction SilentlyContinue} -IgnoreFailures
+        Invoke-HandledCmdlet -Command {Remove-AzSynapseSparkPool -ResourceGroupName $resourceGroupName -WorkspaceName $workspaceName -Name $sparkPoolNameForAutoScale -ErrorAction SilentlyContinue} -IgnoreFailures
     }
 }

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

@@ -68,7 +68,7 @@ public class NewAzureSynapseSparkPool : SynapseCmdletBase
         [ValidateSet(Management.Synapse.Models.NodeSize.Small, Management.Synapse.Models.NodeSize.Medium, Management.Synapse.Models.NodeSize.Large, IgnoreCase = true)]
         [PSArgumentCompleter(Management.Synapse.Models.NodeSize.Small, Management.Synapse.Models.NodeSize.Medium, Management.Synapse.Models.NodeSize.Large)]
         public string NodeSize { get; set; }
-        public SwitchParameter EnableAutoScale { get; set; }
+        private SwitchParameter EnableAutoScale { get; set; }
 
         [Parameter(ValueFromPipelineByPropertyName = false, ParameterSetName = CreateByNameAndEnableAutoScaleParameterSet,
             Mandatory = true, HelpMessage = HelpMessages.AutoScaleMinNodeCount)]

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

@@ -4,30 +4,44 @@ Module Name: Az.Synapse
 online version: https://docs.microsoft.com/en-us/powershell/module/az.synapse/new-azsynapsesparkpool
 schema: 2.0.0
 ---
-
+# test
 # New-AzSynapseSparkPool
 
 ## SYNOPSIS
 Creates a Synapse Analytics Spark pool.
 
 ## SYNTAX
 
-### CreateByNameParameterSet (Default)
+### CreateByNameAndEnableAutoScaleParameterSet (Default)
+```
+New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>]
+ -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32> [-EnableAutoPause]
+ [-AutoPauseDelayInMinute <Int32>] -SparkVersion <String> [-LibraryRequirementsFilePath <String>] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### CreateByNameAndUnableAutoScaleParameterSet
 ```
 New-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String> -Name <String> [-Tag <Hashtable>]
- -NodeCount <Int32> -NodeSize <String> [-EnableAutoScale] [-AutoScaleMinNodeCount <Int32>]
- [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] -SparkVersion <String>
- [-LibraryRequirementsFilePath <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
- [-Confirm] [<CommonParameters>]
+ -NodeCount <Int32> -NodeSize <String> [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>]
+ -SparkVersion <String> [-LibraryRequirementsFilePath <String>] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
-### CreateByParentObjectParameterSet
+### CreateByParentObjectAndEnableAutoScaleParameterSet
 ```
 New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>]
- -NodeCount <Int32> -NodeSize <String> [-EnableAutoScale] [-AutoScaleMinNodeCount <Int32>]
- [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>] -SparkVersion <String>
- [-LibraryRequirementsFilePath <String>] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
- [-Confirm] [<CommonParameters>]
+ -NodeSize <String> -AutoScaleMinNodeCount <Int32> -AutoScaleMaxNodeCount <Int32> [-EnableAutoPause]
+ [-AutoPauseDelayInMinute <Int32>] -SparkVersion <String> [-LibraryRequirementsFilePath <String>] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### CreateByParentObjectAndUnableAutoScaleParameterSet
+```
+New-AzSynapseSparkPool -WorkspaceObject <PSSynapseWorkspace> -Name <String> [-Tag <Hashtable>]
+ -NodeCount <Int32> -NodeSize <String> [-EnableAutoPause] [-AutoPauseDelayInMinute <Int32>]
+ -SparkVersion <String> [-LibraryRequirementsFilePath <String>] [-AsJob]
+ [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -40,15 +54,30 @@ The **New-AzSynapseSparkPool** cmdlet creates an Azure Synapse Analytics Spark p
 PS C:\> New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -NodeCount 3 -SparkVersion 2.4 -NodeSize Small
 ```
 
-This command creates an Azure Synapse Analytics Spark pool.
+This command creates a non-scalable Azure Synapse Analytics Spark pool
 
 ### Example 2
 ```powershell
+PS C:\> New-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSparkPool -AutoScaleMinNodeCount 3 -AutoScaleMaxNodeCount 10 -SparkVersion 2.4 -NodeSize Small
+```
+
+This command creates a scalable Azure Synapse Analytics Spark pool
+
+### Example 3
+```powershell
 PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
 PS C:\> $ws | New-AzSynapseSparkPool -Name ContosoSparkPool -NodeCount 3 -SparkVersion 2.4 -NodeSize Small
 ```
 
-This command creates an Azure Synapse Analytics Spark pool through pipeline.
+This command creates a non-scalable Azure Synapse Analytics Spark pool through pipeline.
+
+### Example 4
+```powershell
+PS C:\> $ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
+PS C:\> $ws | New-AzSynapseSparkPool -Name ContosoSparkPool -AutoScaleMinNodeCount 3 -AutoScaleMaxNodeCount 10 -SparkVersion 2.4 -NodeSize Small
+```
+
+This command creates a scalable Azure Synapse Analytics Spark pool through pipeline.
 
 ## PARAMETERS
 
@@ -88,10 +117,10 @@ This parameter must be specified when Auto-scale is enabled.
 
 ```yaml
 Type: System.Int32
-Parameter Sets: (All)
+Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByParentObjectAndEnableAutoScaleParameterSet
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -104,10 +133,10 @@ This parameter must be specified when Auto-scale is enabled.
 
 ```yaml
 Type: System.Int32
-Parameter Sets: (All)
+Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByParentObjectAndEnableAutoScaleParameterSet
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -144,21 +173,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -EnableAutoScale
-Indicates whether Auto-scale should be enabled
-
-```yaml
-Type: System.Management.Automation.SwitchParameter
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -LibraryRequirementsFilePath
 Environment configuration file ("PIP freeze" output).
 
@@ -194,7 +208,7 @@ Number of nodes to be allocated in the specified Spark pool.
 
 ```yaml
 Type: System.Int32
-Parameter Sets: (All)
+Parameter Sets: CreateByNameAndUnableAutoScaleParameterSet, CreateByParentObjectAndUnableAutoScaleParameterSet
 Aliases:
 
 Required: True
@@ -226,7 +240,7 @@ Resource group name.
 
 ```yaml
 Type: System.String
-Parameter Sets: CreateByNameParameterSet
+Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByNameAndUnableAutoScaleParameterSet
 Aliases:
 
 Required: False
@@ -272,7 +286,7 @@ Name of Synapse workspace.
 
 ```yaml
 Type: System.String
-Parameter Sets: CreateByNameParameterSet
+Parameter Sets: CreateByNameAndEnableAutoScaleParameterSet, CreateByNameAndUnableAutoScaleParameterSet
 Aliases:
 
 Required: True
@@ -287,7 +301,7 @@ workspace input object, usually passed through the pipeline.
 
 ```yaml
 Type: Microsoft.Azure.Commands.Synapse.Models.PSSynapseWorkspace
-Parameter Sets: CreateByParentObjectParameterSet
+Parameter Sets: CreateByParentObjectAndEnableAutoScaleParameterSet, CreateByParentObjectAndUnableAutoScaleParameterSet
 Aliases:
 
 Required: True