Start-FabricNotebook
Starts a notebook in Microsoft Fabric.
Syntax
Start-FabricNotebook -WorkspaceId <guid> -NotebookId <guid> [-NoWait] [-WhatIf] [-Confirm]
[<CommonParameters>]Start-FabricNotebook -WorkspaceId <guid> -NotebookName <string> [-NoWait] [-WhatIf] [-Confirm]
[<CommonParameters>]Description
Submits a RunNotebook job in the specified workspace and waits for its terminal job status by default. Notebook names must match exactly one notebook in that workspace. Polling follows the job-instance Location and honors Retry-After, rather than using the generic LRO endpoints.
Examples
Example 1
Start-FabricNotebook -WorkspaceId '11111111-1111-1111-1111-111111111111' -NotebookName 'Daily load'Runs Daily load and returns its final job instance.
Example 2
Start-FabricNotebook -WorkspaceId '11111111-1111-1111-1111-111111111111' -NotebookId '22222222-2222-2222-2222-222222222222' -NoWaitSubmits the notebook and returns its current job instance promptly.
Example 3
Start-FabricNotebook -WorkspaceId '11111111-1111-1111-1111-111111111111' -NotebookName 'Daily load' -WhatIfResolves the notebook and previews execution without submitting a job.
Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -NotebookId | guid | ✓Required | Named | – | The ID of the notebook to run. Cannot be combined with NotebookName. |
| -NotebookName | string | ✓Required | Named | – | The display name of the notebook to run. Cannot be combined with NotebookId. |
| -WorkspaceId | guid | ✓Required | Named | – | The ID of the workspace containing the notebook. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -NoWait | switch | Named | – | Returns the submitted job's current instance without waiting for completion. Default: False |
|
| -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.
Outputs
System.Management.Automation.PSCustomObject
The current or final job instance
{{ Fill in the Description }}
Notes
Requires an authenticated Fabric session. Notebook parameters and compute configuration are not supported.
Author: FabricTools Team