Items - List KQL Databases

服务:

KQLDatabase

API 版本:

v1

从指定的工作区返回 KQL 数据库的列表。
此 API 支持 分页。

权限

调用方必须具有 查看器 或更高版本的工作区角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

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

具有可选参数:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases?continuationToken={continuationToken}

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。
continuationToken	query		string	用于检索下一页结果的令牌。

响应

名称	类型	说明
200 OK	KQLDatabases	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效

示例

List KQL databases in workspace example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases

示例响应

状态代码:

200

{
  "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"
      }
    }
  ]
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemTag	表示应用于项的标记。
ItemType	项的类型。 可能会随着时间的推移添加其他项类型。
KQLDatabase	KQL 数据库对象。
KQLDatabaseProperties	KQL 数据库属性。
KQLDatabases	KQL 数据库的列表。
KqlDatabaseType	数据库的类型。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ItemTag

Object

表示应用于项的标记。

名称	类型	说明
displayName	string	标签的名称。
id	string (uuid)	标记 ID。

ItemType

枚举

项的类型。 可能会随着时间的推移添加其他项类型。

值	说明
CopyJob	复制作业。
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
VariableLibrary	VariableLibrary。
Warehouse	仓库。

KQLDatabase

Object

KQL 数据库对象。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
folderId	string (uuid)	文件夹 ID。
id	string (uuid)	项 ID。
properties	KQLDatabaseProperties	KQL 数据库属性。
tags	ItemTag[]	已应用的标记列表。
type	ItemType	项类型。
workspaceId	string (uuid)	工作区 ID。

KQLDatabaseProperties

Object

KQL 数据库属性。

名称	类型	说明
databaseType	KqlDatabaseType	数据库的类型。
ingestionServiceUri	string	引入服务 URI。
parentEventhouseItemId	string	父事件屋 ID。
queryServiceUri	string	查询服务 URI。

KQLDatabases

Object

KQL 数据库的列表。

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value	KQLDatabase[]	KQL 数据库的列表。

KqlDatabaseType

枚举

数据库的类型。

值	说明
ReadWrite	允许对数据库执行读取和写入作。
Shortcut	快捷方式是允许对源数据库执行只读作的嵌入引用。 源可以位于 Azure 数据资源管理器群集或 Fabric Eventhouse 中的相同或不同的租户中。