Refresh help doc

Azure · Aug 24, 2021 · 3818844 · 3818844
1 parent ba050bb
commit 3818844
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 16 deletions.
diff --git a/src/Synapse/Synapse/ChangeLog.md b/src/Synapse/Synapse/ChangeLog.md
@@ -32,8 +32,8 @@
 	- Added `New-AzSynapseWorkspacePackage` cmdlet
 	- Added `Get-AzSynapseWorkspacePackage` cmdlet
 	- Added `Remove-AzSynapseWorkspacePackage` cmdlet
-	- Updated `New-AzSynapseSparkPool` cmdlet to add parameter `-WorkspacePackages`
-	- Updated `Updated-AzSynapseSparkPool` cmdlet to add parameter `-WorkspacePackages`
+	- Updated `New-AzSynapseSparkPool` cmdlet to add parameter `-Package`
+	- Updated `Updated-AzSynapseSparkPool` cmdlet to add parameter `-Package`
 
 ## Version 0.14.0
 * Added parameter `-ManagedResourceGroupName` for the `New-AzSynapseWorkspace` cmdlet

diff --git a/src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/NewAzureSynapseSparkPool.cs b/src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/NewAzureSynapseSparkPool.cs
@@ -110,9 +110,8 @@ public class NewAzureSynapseSparkPool : SynapseManagementCmdletBase
 
         [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
             HelpMessage = HelpMessages.WorkspacePackages)]
-        [Alias("WorkspacePackages")]
         [ValidateNotNullOrEmpty]
-        public List<PSSynapseWorkspacePackage> WorkspacePackages { get; set; }
+        public List<PSSynapseWorkspacePackage> Package { get; set; }
 
         [Parameter(Mandatory = false, HelpMessage = HelpMessages.AsJob)]
         public SwitchParameter AsJob { get; set; }
@@ -200,7 +199,7 @@ public override void ExecuteCmdlet()
                 },
                 SparkVersion = this.SparkVersion,
                 LibraryRequirements = libraryRequirements,
-                CustomLibraries = WorkspacePackages != null ? this.WorkspacePackages?.Select(psPackage => new LibraryInfo
+                CustomLibraries = Package != null ? this.Package?.Select(psPackage => new LibraryInfo
                 {
                     Name = psPackage?.Name,
                     Type = psPackage?.PackageType,

diff --git a/src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/UpdateAzureSynapseSparkPool.cs b/src/Synapse/Synapse/Commands/ManagementCommands/SparkPool/UpdateAzureSynapseSparkPool.cs
@@ -111,8 +111,7 @@ public class UpdateAzureSynapseSparkPool : SynapseManagementCmdletBase
 
         [Parameter(ValueFromPipelineByPropertyName = false, Mandatory = false,
             HelpMessage = HelpMessages.WorkspacePackages)]
-        [Alias("WorkspacePackages")]
-        public List<PSSynapseWorkspacePackage> Packages { get; set; }
+        public List<PSSynapseWorkspacePackage> Package { get; set; }
 
         [Parameter(Mandatory = false, HelpMessage = HelpMessages.AsJob)]
         public SwitchParameter AsJob { get; set; }
@@ -193,9 +192,9 @@ public override void ExecuteCmdlet()
                 };
             }
 
-            if (this.IsParameterBound(c => c.Packages))
+            if (this.IsParameterBound(c => c.Package))
             {
-                existingSparkPool.CustomLibraries = this.Packages?.Select(psPackage => new LibraryInfo
+                existingSparkPool.CustomLibraries = this.Package?.Select(psPackage => new LibraryInfo
                 {
                     Name = psPackage?.Name,
                     Type = psPackage?.PackageType,

diff --git a/src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md b/src/Synapse/Synapse/help/Update-AzSynapseSparkPool.md
@@ -18,7 +18,7 @@ Update-AzSynapseSparkPool [-ResourceGroupName <String>] -WorkspaceName <String>
  [-Tag <Hashtable>] [-EnableAutoScale <Boolean>] [-AutoScaleMinNodeCount <Int32>]
  [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>]
  [-NodeCount <Int32>] [-NodeSize <String>] [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>]
- [-Packages <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
+ [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -28,7 +28,7 @@ Update-AzSynapseSparkPool -Name <String> -WorkspaceObject <PSSynapseWorkspace> [
  [-EnableAutoScale <Boolean>] [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>]
  [-EnableAutoPause <Boolean>] [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-NodeSize <String>]
  [-SparkVersion <String>] [-LibraryRequirementsFilePath <String>]
- [-Packages <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
+ [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -38,7 +38,7 @@ Update-AzSynapseSparkPool -InputObject <PSSynapseSparkPool> [-Tag <Hashtable>] [
  [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>]
  [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SparkVersion <String>]
  [-LibraryRequirementsFilePath <String>]
- [-Packages <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
+ [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -48,7 +48,7 @@ Update-AzSynapseSparkPool -ResourceId <String> [-Tag <Hashtable>] [-EnableAutoSc
  [-AutoScaleMinNodeCount <Int32>] [-AutoScaleMaxNodeCount <Int32>] [-EnableAutoPause <Boolean>]
  [-AutoPauseDelayInMinute <Int32>] [-NodeCount <Int32>] [-NodeSize <String>] [-SparkVersion <String>]
  [-LibraryRequirementsFilePath <String>]
- [-Packages <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
+ [-Package <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]>]
  [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -118,7 +118,7 @@ This command disables auto-pause for an Azure Synapse Analytics Spark pool.
 ### Example 9
 ```powershell
 PS C:\> $packages = Get-AzSynapseWorkspacePackage -WorkspaceName ContosoWorkspace
-PS C:\> Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -WorkspacePackages $packages
+PS C:\> Update-AzSynapseSparkPool -WorkspaceName ContosoWorkspace -Name ContosoSqlPool -Package $packages
 ```
 
 The first command retrieves workspace packages. The second command links these workspaces packages to an Azure Synapse Analytics Spark pool.
@@ -309,13 +309,13 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Packages
+### -Package
 The workspace packages.
 
 ```yaml
 Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Synapse.Models.WorkspacePackages.PSSynapseWorkspacePackage]
 Parameter Sets: (All)
-Aliases: WorkspacePackages
+Aliases:
 
 Required: False
 Position: Named