Определение набора запросов KQL

Статья
03/22/2025

В этой статье представлена разбивка структуры для элементов определения KQL Queryset (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.

Путь к части определения	тип	Обязательно	Описание
`version`	струна	верно	Версия набора запросов.
`dataSources`	DataSource (Array)	верно	Список источников данных, используемых в наборе запросов.
`tabs`	Tab (Array)	верно	Список вкладок в наборе запросов.

DataSource

Описывает поля, используемые для создания объекта DataSource.

Путь к части определения	тип	Обязательно	Описание
`id`	струна	верно	Уникальный идентификатор источника данных.
`clusterUri`	струна	верно	Универсальный код ресурса (URI) источника данных.
`type`	струна	верно	Тип источника данных. Допустимые значения: `AzureDataExplorer`
`databaseName`	струна	верно	Имя базы данных в источнике данных.

вкладка

Описывает поля, используемые для создания объекта Tab.

Путь к части определения	тип	Обязательно	Описание
`id`	струна	верно	Уникальный идентификатор вкладки.
`content`	струна	верно	Содержимое вкладки, которая является запросом KQL.
`title`	струна	верно	Заголовок вкладки.
`dataSourceId`	струна	верно	Уникальный идентификатор источника данных, используемого на вкладке.

Пример RealTimeQueryset

В следующем примере полезные данные — это объект JSON, описывающий набор запросов, содержащий одну вкладку с StormEvents | countзапроса.

В этом примере показан декодированные объекты JSON для полезных данных RealTimeQueryset.

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

Поделиться через