New-FabricKQLDashboard
Creates a new KQLDashboard in a specified Microsoft Fabric workspace.
Syntax
New-FabricKQLDashboard [-WorkspaceId] <guid> [-KQLDashboardName] <string>
[[-KQLDashboardDescription] <string>] [[-KQLDashboardPathDefinition] <string>]
[[-KQLDashboardPathPlatformDefinition] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
This function sends a POST request to the Microsoft Fabric API to create a new KQLDashboard in the specified workspace. It supports optional parameters for KQLDashboard description and path definitions for the KQLDashboard content.
Examples
Example 1
Creates a new KQLDashboard named "New KQLDashboard" in the workspace with ID "workspace-12345".
New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard"Example 2
Creates a new KQLDashboard with a definition file and platform definition.
New-FabricKQLDashboard -WorkspaceId "workspace-12345" -KQLDashboardName "New KQLDashboard" -KQLDashboardPathDefinition "C:\KQLDashboards\example.ipynb" -KQLDashboardPathPlatformDefinition "C:\KQLDashboards\platform.json"Parameters
| Name | Type | Req. | Pos. | Pipeline | Description |
|---|---|---|---|---|---|
| -KQLDashboardName | string | ✓Required | 1 | – | The name of the KQLDashboard to be created. |
| -WorkspaceId | guid | ✓Required | 0 | – | The unique identifier of the workspace where the KQLDashboard will be created. |
| -Confirmalias: cf | switch | Named | – | Prompts you for confirmation before running the cmdlet. |
|
| -KQLDashboardDescription | string | 2 | – | An optional description for the KQLDashboard. |
|
| -KQLDashboardPathDefinition | string | 3 | – | An optional path to the KQLDashboard definition file (e.g., .ipynb file) to upload. |
|
| -KQLDashboardPathPlatformDefinition | string | 4 | – | An optional path to the platform-specific definition (e.g., .platform file) to upload. |
|
| -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