KQL クエリセットの定義

この記事では、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 でエンコードされた定義の内容が含まれています。 コンテンツは、Queryset を記述する JSON オブジェクトです。 JSON オブジェクトには、querysetという名前のルート オブジェクトが含まれています。このオブジェクトには、Queryset を定義するいくつかのプロパティがあります。

Queryset プロパティ

Queryset オブジェクトの構築に使用するフィールドについて説明します。

定義パーツのパス	種類	必須	説明
version	糸	ほんとう	クエリセットのバージョン。
dataSources	DataSource (配列)	ほんとう	クエリセットで使用されるデータ ソースの一覧。
tabs	Tab (配列)	ほんとう	クエリセット内のタブの一覧。

DataSource

DataSource オブジェクトの構築に使用するフィールドについて説明します。

定義パーツのパス	種類	必須	説明
id	糸	ほんとう	データ ソースの一意識別子。
clusterUri	糸	ほんとう	データ ソースの URI。
type	糸	ほんとう	データ ソースの型。 有効な値: AzureDataExplorer
databaseName	糸	ほんとう	データ ソース内のデータベースの名前。

タブ

Tab オブジェクトの構築に使用するフィールドについて説明します。

定義パーツのパス	種類	必須	説明
id	糸	ほんとう	タブの一意識別子。
content	糸	ほんとう	KQL クエリであるタブの内容。
title	糸	ほんとう	タブのタイトル。
dataSourceId	糸	ほんとう	タブで使用されるデータ ソースの一意識別子。

RealTimeQueryset の例

次のペイロードの例は、クエリ StormEvents | countを含む 1 つのタブを含む Queryset を記述する JSON オブジェクトです。

この例では、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"
      }
    ]
  }
}