Update-FabricNotebook
Updates the properties of a Fabric Notebook.
Syntax
Update-FabricNotebook [-WorkspaceId] <guid> [-NotebookId] <guid> [-NotebookName] <string>
[[-NotebookDescription] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
The Update-FabricNotebook function updates the name and/or description of a specified Fabric Notebook by making a PATCH request to the API.
Examples
Example 1
Updates the name of the Notebook with the ID "Notebook123" to "NewNotebookName".
Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewNotebookName"Example 2
Updates both the name and description of the Notebook "Notebook123".
Update-FabricNotebook -NotebookId "Notebook123" -NotebookName "NewName" -NotebookDescription "Updated description"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -NotebookId | guid | ✓Required | 1 | – | The unique identifier of the Notebook to be updated. |
| -NotebookName | string | ✓Required | 2 | – | The new name for the Notebook. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the Notebook exists. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -NotebookDescription | string | 3 | – | (Optional) The new description for the Notebook. |
|
| -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
- Requires
$FabricConfigglobal configuration, includingBaseUrlandFabricHeaders. - Calls
Confirm-TokenStateto ensure token validity before making the API request.
Author: Tiago Balabuch, Kamil Nowinski