Share via


リファレンス ドキュメントの構文規則

この記事では、Kusto 照会言語 (KQL) および管理コマンドリファレンス ドキュメントに従う構文規則について説明します。

構文表記規則

表記 説明
Block 示されているとおりに入力される文字列リテラル。
斜体 関数またはコマンドの使用時に値を指定するパラメーター。
[ ] 囲まれた項目が省略可能であることを示します。
( ) 囲まれた項目の少なくとも 1 つが必要であることを示します。
|(パイプ) パイプ文字で区切られた項目の 1 つを指定できる場合は、角かっこまたは丸かっこで囲んで使用します。 この形式では、パイプは論理 OR 演算子と同じです。 ブロック (|) 内にある場合、パイプは KQL クエリ構文の一部です。
[, ...] 前のパラメーターをコンマで区切って複数回繰り返すことができることを示します。
; クエリ ステートメントターミネータ。

スカラー関数

この例では、 ハッシュ関数の構文と使用例を示し、その後に各構文コンポーネントがどのように使用例に変換されるかについて説明します。

構文

hash(source [,mod])

使用例

hash("World")
  • 関数の名前 、、 hashおよび始めかっこは、示されているとおりに入力されます。
  • "World" は、必要な ソース パラメーターの引数として渡されます。
  • 角かっこで示すように省略可能な mod パラメーターには引数が渡されません。
  • 右かっこは、次のように入力されます。

表形式演算子

この例では、 並べ替え演算子の構文と使用例を示し、その後に各構文コンポーネントがどのように使用例に変換されるかについて説明します。

構文

T| sort bycolumn [asc | desc] [nulls first | nulls last] [, ...]

使用例

StormEvents
| sort by State asc, StartTime desc
  • StormEvents テーブルは、必要な T パラメーターの引数として渡されます。
  • | sort by は、示されているとおりに入力されます。 この場合、パイプ文字は、ブロック テキストで表される 表形式式ステートメント 構文の一部です。 詳細については、「 クエリ ステートメントとは」を参照してください。
  • State 列は、省略可能ascなフラグを持つ必須の列パラメーターの引数として渡されます。
  • コンマの後に、別の引数のセット (省略可能な desc フラグを持つ StartTime 列) が渡されます。 [, ...] 構文は、より多くの引数セットを渡すことができますが、必須ではないことを示します。

省略可能なパラメーターの操作

別の省略可能なパラメーターの後にある省略可能なパラメーターの引数を指定するには、前のパラメーターの引数を指定する必要があります。 この要件は、引数が構文で指定された順序に従う必要があるためです。 パラメーターに渡す特定の値がない場合は、同じ型の空の値を使用します。

シーケンシャル省略可能なパラメーターの例

http_request プラグインの構文を考えてみましょう。

evaluatehttp_request(Uri [,RequestHeaders [,オプション]] )

RequestHeadersOptions は、 dynamic 型の省略可能なパラメーターです。 Options パラメーターの引数を指定するには、RequestHeaders パラメーターの引数も指定する必要があります。 次の例では、2 番目の省略可能なパラメーター Options の値を指定できるように、最初の省略可能なパラメーター RequestHeaders に空の値を指定する方法を示 します

evaluate http_request ( "https://contoso.com/", dynamic({}), dynamic({ EmployeeName: Nicole }) )