Get-FabricSparkCustomPool
Retrieves Spark custom pools from a specified workspace.
Syntax
Get-FabricSparkCustomPool [-WorkspaceId] <guid> [[-SparkCustomPoolId] <guid>]
[[-SparkCustomPoolName] <string>] [<CommonParameters>]Description
This function retrieves all Spark custom pools from a specified workspace using the provided WorkspaceId. It handles token validation, constructs the API URL, makes the API request, and processes the response. The function supports filtering by SparkCustomPoolId or SparkCustomPoolName, but not both simultaneously.
Examples
Example 1
This example retrieves all Spark custom pools from the workspace with ID "12345".
Get-FabricSparkCustomPool -WorkspaceId "12345"Example 2
This example retrieves the Spark custom pool with ID "pool1" from the workspace with ID "12345".
Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolId "pool1"Example 3
This example retrieves the Spark custom pool with name "MyPool" from the workspace with ID "12345".
Get-FabricSparkCustomPool -WorkspaceId "12345" -SparkCustomPoolName "MyPool"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -WorkspaceId | guid | ✓Required | 0 | – | The ID of the workspace from which to retrieve Spark custom pools. This parameter is mandatory. |
| -SparkCustomPoolId | guid | 1 | – | The ID of the specific Spark custom pool to retrieve. This parameter is optional. |
|
| -SparkCustomPoolName | string | 2 | – | The name of the specific Spark custom pool to retrieve. This parameter is optional. |
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