Update-FabricSparkJobDefinition
Updates an existing SparkJobDefinition in a specified Microsoft Fabric workspace.
Syntax
Update-FabricSparkJobDefinition [-WorkspaceId] <guid> [-SparkJobDefinitionId] <guid>
[-SparkJobDefinitionName] <string> [[-SparkJobDefinitionDescription] <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]Description
This function sends a PATCH request to the Microsoft Fabric API to update an existing SparkJobDefinition in the specified workspace. It supports optional parameters for SparkJobDefinition description.
Examples
Example 1
This example updates the SparkJobDefinition with ID "SparkJobDefinition-67890" in the workspace with ID "workspace-12345" with a new name and description.
Update-FabricSparkJobDefinition -WorkspaceId "workspace-12345" -SparkJobDefinitionId "SparkJobDefinition-67890" -SparkJobDefinitionName "Updated SparkJobDefinition" -SparkJobDefinitionDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -SparkJobDefinitionId | guid | ✓Required | 1 | – | The unique identifier of the SparkJobDefinition to be updated. This parameter is mandatory. |
| -SparkJobDefinitionName | string | ✓Required | 2 | – | The new name of the SparkJobDefinition. This parameter is mandatory. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the SparkJobDefinition exists. This parameter is optional. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -SparkJobDefinitionDescription | string | 3 | – | An optional new description for the SparkJobDefinition. |
|
| -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