參考文件的語法慣例
本文概述 Kusto 查詢語言 (KQL) 和管理命令參考檔中所遵循的語法慣例。
語法慣例
慣例 | Description |
---|---|
Block |
要輸入的字串常值完全如所示。 |
斜體 | 在函式或命令使用時提供值的參數。 |
[ ] | 表示已封入的項目是選擇性的。 |
( ) | 表示至少需要其中一個已封入的專案。 |
| (管道) | 用於方括弧或圓括弧內,表示您可以指定其中一個專案以管道字元分隔。 在此形式中,管道相當於邏輯 OR 運算元。 在區塊 (| ) 時,管道是 KQL 查詢語法的一部分。 |
[, ...] |
表示上述參數可以重複多次,並以逗號分隔。 |
; |
查詢語句終止符。 |
範例
純量函數
此範例顯示 哈希函式的語法和範例用法,後面接著說明每個語法元件如何轉譯成範例使用方式。
語法
hash(
source [,
mod])
使用方式範例
hash("World")
- 函式的名稱
hash
和左括弧會完全如所示輸入。 - “World” 會當做必要 來源 參數的自變數傳遞。
- mod 參數不會 傳遞任何自變數,這是以方括弧表示的選擇性參數。
- 右括弧的輸入方式完全如所示。
表格式運算子
此範例顯示 排序運算符的語法和範例使用方式,後面接著說明每個語法元件如何轉譯成範例使用方式。
語法
T| sort by
column [asc
| desc
] [nulls first
| nulls last
] [,
...]
使用方式範例
StormEvents
| sort by State asc, StartTime desc
- StormEvents 數據表會當做必要 T 參數的自變數傳遞。
| sort by
輸入的完全如所示。 在此情況下,管道字元是 表格式表達式語句 語法的一部分,如區塊文字所表示。 若要深入瞭解,請參閱 什麼是查詢語句。- [狀態] 資料行會以選擇性
asc
旗標傳遞為必要數據行參數的自變數。 - 在逗號之後,會傳遞另一組自變數:具有選擇性
desc
旗標的 StartTime 數據行。 [,
...] 語法表示可能會傳遞更多自變數集,但並非必要。
使用選擇性參數
若要為另一個選擇性參數之後的選擇性參數提供自變數,您必須提供先前參數的自變數。 此需求是因為自變數必須遵循語法中指定的順序。 如果您沒有要為 參數傳遞的特定值,請使用相同類型的空值。
循序選擇性參數的範例
請考慮 http_request外掛程式的語法:
evaluate
http_request
(
Uri [RequestHeaders [,
,
選項]])
RequestHeaders 和 Options 是 動態類型的選擇性參數。 若要提供 Options 參數的自變數,您也必須提供 RequestHeaders 參數的自變數。 下列範例示範如何為第一個選擇性參數 RequestHeaders 提供空值,以便指定第二個選擇性參數 Options 的值。
evaluate http_request ( "https://contoso.com/", dynamic({}), dynamic({ EmployeeName: Nicole }) )
相關內容
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應