KQL 查询集定义

2025-03-22

本文详细介绍了 KQL 查询集（Real-Time Queryset）定义项的结构。

定义部件

下表列出了 KQL 查询集定义部分。

定义部件路径	类型	必填	说明
`RealTimeQueryset.json`	RealTimeQueryset （JSON）	是	描述有效负载的内容。
`.platform`	PlatformDetails （JSON）	假	描述项的常见详细信息

定义示例

{
  "parts": [
    {
      "path": "RealTimeQueryset.json",
      "payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
      "payloadType": "InlineBase64"
    },
    {
      "path": ".platform",
      "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
      "payloadType": "InlineBase64"
    }
  ]
}

RealTimeQueryset

payload 属性包含定义的内容，该定义是 Base64 编码的。内容是描述查询集的 JSON 对象。 JSON 对象包含名为 queryset的根对象，该根对象具有定义 Queryset 的多个属性。

查询集属性

描述用于构造 Queryset 对象的字段。

定义部件路径	类型	必填	说明
`version`	字符串	是	Queryset 的版本。
`dataSources`	DataSource （数组）	是	查询集中使用的数据源列表。
`tabs`	Tab （数组）	是	Queryset 中的选项卡列表。

DataSource

描述用于构造 DataSource 对象的字段。

定义部件路径	类型	必填	说明
`id`	字符串	是	数据源的唯一标识符。
`clusterUri`	字符串	是	数据源的 URI。
`type`	字符串	是	数据源的类型。有效值：`AzureDataExplorer`
`databaseName`	字符串	是	数据源中数据库的名称。

Tab

描述用于构造 Tab 对象的字段。

定义部件路径	类型	必填	说明
`id`	字符串	是	选项卡的唯一标识符。
`content`	字符串	是	选项卡的内容，即 KQL 查询。
`title`	字符串	是	选项卡的标题。
`dataSourceId`	字符串	是	选项卡中使用的数据源的唯一标识符。

RealTimeQueryset 示例

以下示例有效负载是一个 JSON 对象，该对象描述包含具有查询 StormEvents | count的单个选项卡的查询集。

此示例显示了 RealTimeQueryset 有效负载的解码 JSON 对象。

{
  "queryset": {
    "version": "1.0.0",
    "dataSources": [
      {
        "id": "c2434bf8-25bb-4aa0-8746-db470533adaf",
        "clusterUri": "https://help.kusto.windows.net/",
        "type": "AzureDataExplorer",
        "databaseName": "Samples"
      }
    ],
    "tabs": [
      {
        "id": "ccd7b90c-51fe-429f-a853-385b02bd74c9",
        "content": "StormEvents\\\\n| count",
        "title": "Tab1Name",
        "dataSourceId": "c2434bf8-25bb-4aa0-8746-db470533adaf"
      }
    ]
  }
}

通过