Update-FabricSparkCustomPool
Updates an existing Spark custom pool in a specified Microsoft Fabric workspace.
Syntax
Update-FabricSparkCustomPool [-WorkspaceId] <guid> [-SparkCustomPoolId] <guid>
[-InstancePoolName] <string> [-NodeFamily] <string> [-NodeSize] <string> [-AutoScaleEnabled] <bool>
[-AutoScaleMinNodeCount] <int> [-AutoScaleMaxNodeCount] <int>
[-DynamicExecutorAllocationEnabled] <bool> [-DynamicExecutorAllocationMinExecutors] <int>
[-DynamicExecutorAllocationMaxExecutors] <int> [-WhatIf] [-Confirm] [<CommonParameters>]Description
This function sends a PATCH request to the Microsoft Fabric API to update an existing Spark custom pool in the specified workspace. It supports various parameters for Spark custom pool configuration.
Examples
Example 1
This example updates the Spark custom pool with ID "pool-67890" in the workspace with ID "workspace-12345" with a new name and configuration.
Update-FabricSparkCustomPool -WorkspaceId "workspace-12345" -SparkCustomPoolId "pool-67890" -InstancePoolName "Updated Spark Pool" -NodeFamily "MemoryOptimized" -NodeSize "Large" -AutoScaleEnabled $true -AutoScaleMinNodeCount 1 -AutoScaleMaxNodeCount 10 -DynamicExecutorAllocationEnabled $true -DynamicExecutorAllocationMinExecutors 1 -DynamicExecutorAllocationMaxExecutors 10Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -AutoScaleEnabled | bool | ✓Required | 5 | – | Specifies whether auto-scaling is enabled for the Spark custom pool. This parameter is mandatory. Default: False |
| -AutoScaleMaxNodeCount | int | ✓Required | 7 | – | The maximum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. Default: 0 |
| -AutoScaleMinNodeCount | int | ✓Required | 6 | – | The minimum number of nodes for auto-scaling in the Spark custom pool. This parameter is mandatory. Default: 0 |
| -DynamicExecutorAllocationEnabled | bool | ✓Required | 8 | – | Specifies whether dynamic executor allocation is enabled for the Spark custom pool. This parameter is mandatory. Default: False |
| -DynamicExecutorAllocationMaxExecutors | int | ✓Required | 10 | – | The maximum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. Default: 0 |
| -DynamicExecutorAllocationMinExecutors | int | ✓Required | 9 | – | The minimum number of executors for dynamic executor allocation in the Spark custom pool. This parameter is mandatory. Default: 0 |
| -InstancePoolName | string | ✓Required | 2 | – | The new name of the Spark custom pool. This parameter is mandatory. |
| -NodeFamily | string | ✓Required | 3 | – | The family of nodes to be used in the Spark custom pool. This parameter is mandatory and must be 'MemoryOptimized'. |
| -NodeSize | string | ✓Required | 4 | – | The size of the nodes to be used in the Spark custom pool. This parameter is mandatory and must be one of 'Large', 'Medium', 'Small', 'XLarge', 'XXLarge'. |
| -SparkCustomPoolId | guid | ✓Required | 1 | – | The unique identifier of the Spark custom pool to be updated. This parameter is mandatory. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the Spark custom pool exists. This parameter is mandatory. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -WhatIfalias: wi | switch | Named | – | Runs the command in a mode that only reports what would happen without performing the actions. |
This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.
Notes
- Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski