Items - Get KQL Database

Service:

KQLDatabase

API Version:

v1

Returns properties of the specified KQL database.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

KQLDatabase.Read.All or KQLDatabase.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal	Yes
Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}

URI Parameters

Name	In	Required	Type	Description
kqlDatabaseId	path	True	string uuid	The KQL database ID.
workspaceId	path	True	string uuid	The workspace ID.

Responses

Name	Type	Description
200 OK	KQLDatabase	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

Examples

Get a KQL database example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases/5b218778-e7a5-4d73-8187-f10824047715

Sample response

Status code:

200

{
  "displayName": "KQLDatabase_1",
  "description": "A KQL database description.",
  "type": "KQLDatabase",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "parentEventhouseItemId": "6a437a7c-1a28-4fd0-a362-11308b94c79b",
    "queryServiceUri": "https://trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "ingestionServiceUri": "https://ingest-trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
    "databaseType": "ReadWrite"
  }
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemType	The type of the item. Additional item types may be added over time.
KQLDatabase	A KQL database object.
KQLDatabaseProperties	The KQL database properties.
KqlDatabaseType	The type of the database.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name	Type	Description
Dashboard	string	PowerBI dashboard.
DataPipeline	string	A data pipeline.
Datamart	string	PowerBI datamart.
Environment	string	An environment.
Eventhouse	string	An eventhouse.
Eventstream	string	An eventstream.
KQLDashboard	string	A KQL dashboard.
KQLDatabase	string	A KQL database.
KQLQueryset	string	A KQL queryset.
Lakehouse	string	A lakehouse.
MLExperiment	string	A machine learning experiment.
MLModel	string	A machine learning model.
MirroredDatabase	string	A mirrored database.
MirroredWarehouse	string	A mirrored warehouse.
Notebook	string	A notebook.
PaginatedReport	string	PowerBI paginated report.
Report	string	PowerBI report.
SQLEndpoint	string	An SQL endpoint.
SemanticModel	string	PowerBI semantic model.
SparkJobDefinition	string	A spark job definition.
Warehouse	string	A warehouse.

KQLDatabase

A KQL database object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
id	string	The item ID.
properties	KQLDatabaseProperties	The KQL database properties.
type	ItemType	The item type.
workspaceId	string	The workspace ID.

KQLDatabaseProperties

The KQL database properties.

Name	Type	Description
databaseType	KqlDatabaseType	The type of the database.
ingestionServiceUri	string	Ingestion service URI.
parentEventhouseItemId	string	Parent eventhouse ID.
queryServiceUri	string	Query service URI.

KqlDatabaseType

The type of the database.

Name	Type	Description
ReadWrite	string	Allows read and write operations on the database.
Shortcut	string	A shortcut is an embedded reference allowing read only operations on a source database. The source can be in the same or different tenants, either in an Azure Data Explorer cluster or a Fabric Eventhouse.