Syntaxkonventionen für die Referenzdokumentation

  • Artikel

In diesem Artikel werden die Syntaxkonventionen beschrieben, die in der Referenzdokumentation zu Kusto-Abfragesprache (KQL) und Verwaltungsbefehlen befolgt werden.

Syntaxkonventionen

Konvention BESCHREIBUNG
Block Zeichenfolgenliterale, die genau wie gezeigt eingegeben werden sollen.
Kursiv Parameter, die bei Verwendung der Funktion oder des Befehls als Wert angegeben werden sollen.
[ ] Gibt an, dass das eingeschlossene Element optional ist.
( ) Gibt an, dass mindestens eines der eingeschlossenen Elemente erforderlich ist.
| (Pipe) Wird in eckigen oder runden Klammern verwendet, um anzugeben, dass Sie eines der durch das Pipezeichen getrennten Elemente angeben können. In dieser Form entspricht die Pipe dem logischen OR-Operator. In einem Block (|) ist die Pipe Teil der KQL-Abfragesyntax.
[, ...] Gibt an, dass der vorherige Parameter mehrmals wiederholt werden kann, getrennt durch Kommas.
; Abfrageanweisungsabschluss.

Beispiele

Skalarfunktion

Dieses Beispiel zeigt die Syntax und ein Beispiel für die Verwendung der Hashfunktion, gefolgt von einer Erklärung, wie jede Syntaxkomponente in die Beispielverwendung übersetzt wird.

Syntax

hash(Source [,mod])

Beispielverwendung

hash("World")
  • Der Name der Funktion , hashund die öffnende Klammer werden genau wie gezeigt eingegeben.
  • "World" wird als Argument für den erforderlichen Quellparameter übergeben.
  • Für den mod-Parameter wird kein Argument übergeben, der optional ist, wie in den eckigen Klammern angegeben.
  • Die schließende Klammer wird genau wie gezeigt eingegeben.

Tabellarischer Operator

Dieses Beispiel zeigt die Syntax und eine Beispielverwendung des Sortieroperators, gefolgt von einer Erklärung, wie die einzelnen Syntaxkomponenten in die Beispielverwendung übersetzt werden.

Syntax

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

Beispielverwendung

StormEvents
| sort by State asc, StartTime desc
  • Die StormEvents-Tabelle wird als Argument für den erforderlichen T-Parameter übergeben.
  • | sort by wird genau wie dargestellt eingegeben. In diesem Fall ist das Pipezeichen Teil der Anweisungssyntax des tabellarischen Ausdrucks , wie sie durch den Blocktext dargestellt wird. Weitere Informationen finden Sie unter Was ist eine Abfrageanweisung.
  • Die State-Spalte wird als Argument für den erforderlichen Spaltenparameter mit dem optionalen asc Flag übergeben.
  • Nach einem Komma wird ein weiterer Satz von Argumenten übergeben: die StartTime-Spalte mit dem optionalen desc Flag. Die Syntax [, ...] gibt an, dass weitere Argumentsätze möglicherweise übergeben, aber nicht erforderlich sind.

Arbeiten mit optionalen Parametern

Um ein Argument für einen optionalen Parameter bereitzustellen, der nach einem anderen optionalen Parameter kommt, müssen Sie ein Argument für den vorherigen Parameter angeben. Diese Anforderung liegt daran, dass Argumente der in der Syntax angegebenen Reihenfolge entsprechen müssen. Wenn Sie keinen bestimmten Wert für den Parameter übergeben müssen, verwenden Sie einen leeren Wert desselben Typs.

Beispiel für sequenzielle optionale Parameter

Betrachten Sie die Syntax für das http_request-Plug-In:

evaluatehttp_request(Uri [,RequestHeaders [,Optionen]] )

RequestHeaders und Options sind optionale Parameter vom Typ dynamisch. Um ein Argument für den Options-Parameter bereitzustellen, müssen Sie auch ein Argument für den RequestHeaders-Parameter angeben. Das folgende Beispiel zeigt, wie Sie einen leeren Wert für den ersten optionalen Parameter RequestHeaders bereitstellen, um einen Wert für den zweiten optionalen Parameter, Options, angeben zu können.

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

Verwandte Inhalte