FabricTools v0.33.0 Public Preview

Get-FabricKQLDatabase

Retrieves an KQLDatabase or a list of KQLDatabases from a specified workspace in Microsoft Fabric.

Syntax

Get-FabricKQLDatabase [-WorkspaceId] <guid> [[-KQLDatabaseId] <guid>] [[-KQLDatabaseName] <string>]
 [<CommonParameters>]

Description

The Get-FabricKQLDatabase function sends a GET request to the Fabric API to retrieve KQLDatabase details for a given workspace. It can filter the results by KQLDatabaseName.

Examples

Example 1

Retrieves the "Development" KQLDatabase from workspace "12345".

Get-FabricKQLDatabase -WorkspaceId "12345" -KQLDatabaseName "Development"

Example 2

Retrieves all KQLDatabases in workspace "12345".

Get-FabricKQLDatabase -WorkspaceId "12345"

Example 3

Retrieves all KQLDatabases from every accessible workspace.

Get-FabricWorkspace | Get-FabricKQLDatabase

Parameters

NameTypeReq.Pos.PipelineDescription
-WorkspaceIdalias: Id guid ✓Required 0 Value, By name

(Mandatory) The ID of the workspace to query KQLDatabases. Accepts pipeline input by value or by the WorkspaceId or Id property.

-KQLDatabaseId guid 1 –

(Optional) The ID of a specific KQLDatabase to retrieve.

-KQLDatabaseName string 2 –

(Optional) The name of the specific KQLDatabase to retrieve.

This cmdlet also supports the common parameters, such as -Verbose and -ErrorAction. See about_CommonParameters.

Inputs

System.Guid

{{ Fill in the Description }}

Notes

  • Requires $FabricConfig global configuration, including BaseUrl and FabricHeaders.
  • Calls Confirm-TokenState to ensure token validity before making the API request.

Author: Tiago Balabuch, Kamil Nowinski