Items - List KQL Databases
Returns a list of KQL databases from the specified workspace.
This API supports pagination.
The caller must have viewer or higher workspace role.
Workspace.Read.All or Workspace.ReadWrite.All
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal and Managed identities | Yes |
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases?continuationToken={continuationToken}
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
continuation
|
query |
string |
A token for retrieving the next page of results. |
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Sample request
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases
Sample response
{
"value": [
{
"id": "3546052c-ae64-4526-b1a8-52af7761426f",
"displayName": "KQLDatabase_1",
"description": "A KQL database description.",
"type": "KQLDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"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"
}
},
{
"id": "340d91b9-5a39-409c-b9c0-05ba832c476e",
"displayName": "KQLDatabase_2",
"description": "A KQL database description.",
"type": "KQLDatabase",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"parentEventhouseItemId": "9add9a4d-079a-432a-b43a-70c899f2087b",
"queryServiceUri": "https://trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
"ingestionServiceUri": "https://ingest-trd-f7k1b2rzuqrjmb3wpd.z5.kusto.fabric.microsoft.com",
"databaseType": "ReadWrite"
}
}
]
}
Name | Description |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Item |
The type of the item. Additional item types may be added over time. |
KQLDatabase |
A KQL database object. |
KQLDatabase |
The KQL database properties. |
KQLDatabases |
A list of KQL databases. |
Kql |
The type of the database. |
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. |
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 |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
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 |
The error related resource details. |
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. |
Reflex |
string |
A Reflex. |
Report |
string |
PowerBI report. |
SQLEndpoint |
string |
An SQL endpoint. |
SemanticModel |
string |
PowerBI semantic model. |
SparkJobDefinition |
string |
A spark job definition. |
Warehouse |
string |
A warehouse. |
A KQL database object.
Name | Type | Description |
---|---|---|
description |
string |
The item description. |
displayName |
string |
The item display name. |
id |
string |
The item ID. |
properties |
The KQL database properties. |
|
type |
The item type. |
|
workspaceId |
string |
The workspace ID. |
The KQL database properties.
Name | Type | Description |
---|---|---|
databaseType |
The type of the database. |
|
ingestionServiceUri |
string |
Ingestion service URI. |
parentEventhouseItemId |
string |
Parent eventhouse ID. |
queryServiceUri |
string |
Query service URI. |
A list of KQL databases.
Name | Type | Description |
---|---|---|
continuationToken |
string |
The token for the next result set batch. If there are no more records, it's removed from the response. |
continuationUri |
string |
The URI of the next result set batch. If there are no more records, it's removed from the response. |
value |
A list of KQL databases. |
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. |