FabricTools v0.33.0 Public Preview

Get-FabricSparkJobDefinition

Retrieves Spark Job Definition details from a specified Microsoft Fabric workspace.

Syntax

Get-FabricSparkJobDefinition [-WorkspaceId] <guid> [[-SparkJobDefinitionId] <guid>]
 [[-SparkJobDefinitionName] <string>] [<CommonParameters>]

Description

This function retrieves SparkJobDefinition details from a specified workspace using either the provided SparkJobDefinitionId or SparkJobDefinitionName. It handles token validation, constructs the API URL, makes the API request, and processes the response.

Examples

Example 1

This example retrieves the SparkJobDefinition details for the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345".

Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890"

Example 2

This example retrieves the SparkJobDefinition details for the SparkJobDefinition named "My SparkJobDefinition" in the workspace with ID "workspace-12345".

Get-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionName "My SparkJobDefinition"

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceId guid ✓Required 0 –

The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is mandatory.

-SparkJobDefinitionId guid 1 –

The unique identifier of the SparkJobDefinition to retrieve. This parameter is optional.

-SparkJobDefinitionName string 2 –

The name of the SparkJobDefinition to retrieve. This parameter is optional.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Notes

Author: Tiago Balabuch, Kamil Nowinski