Get-FabricKQLDashboardDefinition

Retrieves the definition of a KQLDashboard from a specific workspace in Microsoft Fabric.

Syntax

Get-FabricKQLDashboardDefinition [-WorkspaceId] <guid> [[-KQLDashboardId] <guid>]
 [[-KQLDashboardFormat] <string>] [<CommonParameters>]

Description

This function fetches the KQLDashboard's content or metadata from a workspace. Handles both synchronous and asynchronous operations, with detailed logging and error handling.

Examples

Example 1

Retrieves the definition of the KQLDashboard with ID 67890 from the workspace with ID 12345 in the ipynb format.

Get-FabricKQLDashboardDefinition -WorkspaceId "12345" -KQLDashboardId "67890"

Example 2

Retrieves the definitions of all KQLDashboards in the workspace with ID 12345 in the ipynb format.

Get-FabricKQLDashboardDefinition -WorkspaceId "12345"

Parameters

Name	Type	Req.	Pos.	Pipeline	Description
-WorkspaceId	guid	✓Required	0	–	(Mandatory) The unique identifier of the workspace from which the KQLDashboard definition is to be retrieved.
-KQLDashboardFormat	string		2	–	Specifies the format of the KQLDashboard definition.
-KQLDashboardId	guid		1	–	(Optional)The unique identifier of the KQLDashboard whose definition needs to be retrieved.

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.
Handles long-running operations asynchronously.

Author: Tiago Balabuch, Kamil Nowinski

Edit this page on GitHub Report a docs issue