Get-FabricKQLDashboard
Retrieves an KQLDashboard or a list of KQLDashboards from a specified workspace in Microsoft Fabric.
Syntax
Get-FabricKQLDashboard [-WorkspaceId] <guid> [[-KQLDashboardId] <guid>]
[[-KQLDashboardName] <string>] [<CommonParameters>]Description
The Get-FabricKQLDashboard function sends a GET request to the Fabric API to retrieve KQLDashboard details for a given workspace. It can filter the results by KQLDashboardName.
Examples
Example 1
Retrieves the "Development" KQLDashboard from workspace "12345". .PARAMETER KQLDashboardID The Id of the KQLDashboard to retrieve. This parameter cannot be used together with KQLDashboardName. The value for KQLDashboardID is a GUID. An example of a GUID is '12345678-1234-1234-1234-123456789012'.
Get-FabricKQLDashboard -WorkspaceId "12345" -KQLDashboardName "Development"Example 2
Retrieves all KQLDashboards in workspace "12345".
Get-FabricKQLDashboard -WorkspaceId "12345"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -WorkspaceId | guid | ✓Required | 0 | – | (Mandatory) The ID of the workspace to query KQLDashboards. |
| -KQLDashboardId | guid | 1 | – | (Optional) The ID of the specific KQLDashboard to retrieve. |
|
| -KQLDashboardName | string | 2 | – | (Optional) The name of the specific KQLDashboard to retrieve. |
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