Update-FabricSparkSettings
Updates Spark settings in a specified Microsoft Fabric workspace.
Syntax
Update-FabricSparkSettings [-WorkspaceId] <guid> [[-automaticLogEnabled] <bool>]
[[-notebookInteractiveRunEnabled] <bool>] [[-customizeComputeEnabled] <bool>]
[[-defaultPoolName] <string>] [[-defaultPoolType] <string>] [[-starterPoolMaxNode] <int>]
[[-starterPoolMaxExecutors] <int>] [[-EnvironmentName] <string>]
[[-EnvironmentRuntimeVersion] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
This function sends a PATCH request to the Microsoft Fabric API to update Spark settings in the specified workspace. It supports optional parameters for automatic logging, high concurrency, pool configuration, environment, and starter pool settings.
Examples
Example 1
This example enables automatic logging for the workspace with ID "workspace-12345".
Update-FabricSparkSettings -WorkspaceId "workspace-12345" -automaticLogEnabled $trueExample 2
This example sets the default pool for the workspace with ID "workspace-12345".
Update-FabricSparkSettings -WorkspaceId "workspace-12345" -defaultPoolName "MyPool" -defaultPoolType "Workspace"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace whose Spark settings will be updated. This parameter is mandatory. |
| -automaticLogEnabled | bool | 1 | – | Specifies whether automatic logging is enabled. This parameter is optional. Default: False |
|
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -customizeComputeEnabled | bool | 3 | – | Specifies whether compute customization is enabled for the pool. This parameter is optional. Default: False |
|
| -defaultPoolName | string | 4 | – | The name of the default pool. Must be provided together with defaultPoolType. This parameter is optional. |
|
| -defaultPoolType | string | 5 | – | The type of the default pool. Must be 'Workspace' or 'Capacity'. Must be provided together with defaultPoolName. This parameter is optional. |
|
| -EnvironmentName | string | 8 | – | The name of the environment. This parameter is optional. |
|
| -EnvironmentRuntimeVersion | string | 9 | – | The runtime version of the environment. This parameter is optional. |
|
| -notebookInteractiveRunEnabled | bool | 2 | – | Specifies whether notebook interactive run (high concurrency) is enabled. This parameter is optional. Default: False |
|
| -starterPoolMaxExecutors | int | 7 | – | The maximum number of executors for the starter pool. This parameter is optional. Default: 0 |
|
| -starterPoolMaxNode | int | 6 | – | The maximum number of nodes for the starter pool. This parameter is optional. Default: 0 |
|
| -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