Update-FabricKQLDashboardDefinition

Updates the definition of a KQLDashboard in a Microsoft Fabric workspace.

Syntax

Update-FabricKQLDashboardDefinition [-WorkspaceId] <guid> [-KQLDashboardId] <guid>
 [-KQLDashboardPathDefinition] <string> [[-KQLDashboardPathPlatformDefinition] <string>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Description

This function allows updating the content or metadata of a KQLDashboard in a Microsoft Fabric workspace. The KQLDashboard content can be provided as file paths, and metadata updates can optionally be enabled.

Examples

Example 1

Updates the content of the KQLDashboard with ID 67890 in the workspace 12345 using the specified KQLDashboard file.

Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb"

Example 2

Updates both the content and metadata of the KQLDashboard with ID 67890 in the workspace 12345.

Update-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890" -KQLDashboardPathDefinition "C:\KQLDashboards\KQLDashboard.ipynb"

Parameters

Name	Type	Req.	Pos.	Pipeline	Description
-KQLDashboardId	guid	✓Required	1	–	(Mandatory) The unique identifier of the KQLDashboard to be updated.
-KQLDashboardPathDefinition	string	✓Required	2	–	(Mandatory) The file path to the KQLDashboard content definition file. The content will be encoded as Base64 and sent in the request.
-WorkspaceId	guid	✓Required	0	–	(Mandatory) The unique identifier of the workspace where the KQLDashboard resides.
-Confirmalias: cf	switch		Named	–	Prompts you for confirmation before running the cmdlet.
-KQLDashboardPathPlatformDefinition	string		3	–	(Optional) The file path to the KQLDashboard's platform-specific definition file. The content will be encoded as Base64 and sent in the request.
-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 $FabricConfig global configuration, including BaseUrl and FabricHeaders.
Calls Confirm-TokenState to ensure token validity before making the API request.
The KQLDashboard content is encoded as Base64 before being sent to the Fabric API.
This function handles asynchronous operations and retrieves operation results if required.

Author: Tiago Balabuch, Kamil Nowinski

Edit this page on GitHub Report a docs issue