Szintaxiskonvenciák referenciadokumentációhoz

  • Cikk

Ez a cikk a Kusto lekérdezésnyelv (KQL) és a felügyeleti parancsok referenciadokumentációjában követett szintaxiskonvenciákat ismerteti.

Szintaxiskonvenciák

Konvenció Description
Block A sztringkonstansokat pontosan az ábrán látható módon kell megadni.
Italic A függvény vagy parancs használatakor értéket adni kívánt paraméterek.
[ ] Azt jelzi, hogy a mellékelt elem nem kötelező.
( ) Azt jelzi, hogy a mellékelt elemek közül legalább egyre szükség van.
| (cső) Szögletes vagy kerek szögletes zárójelben azt jelzi, hogy megadhatja a csőkarakter által elválasztott elemek egyikét. Ebben a formában a cső egyenértékű a logikai VAGY operátorral. Blokkban (|) a cső a KQL-lekérdezés szintaxisának része.
[, ...] Azt jelzi, hogy az előző paraméter többször is megismételhető, vesszővel elválasztva.
; Lekérdezési utasítás terminátora.

Példák

Skaláris függvény

Ez a példa a kivonatfüggvény szintaxisát és egy példahasználatát mutatja be, amelyet az egyes szintaxisösszetevők példahasználatra való lefordításának magyarázata követ.

Syntax

hash(source [,mod])

Példa a használatra

hash("World")
  • A függvény neve és hasha nyitó zárójel pontosan az ábrán látható módon lesz beírva.
  • A "World" paraméter a szükséges forrásparaméter argumentumaként van átadva.
  • A mod paraméterhez nem ad meg argumentumot, amely nem kötelező, ahogy a szögletes zárójelek jelzik.
  • A záró zárójel pontosan az ábrán látható módon van beírva.

Táblázatos operátor

Ez a példa a rendezési operátor szintaxisát és egy példahasználatát mutatja be, amelyet az egyes szintaxisösszetevők példahasználatra való lefordításának magyarázata követ.

Syntax

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

Példa a használatra

StormEvents
| sort by State asc, StartTime desc
  • A StormEvents tábla a szükséges T paraméter argumentumaként lesz átadva.
  • | sort by pontosan az ábrán látható módon van megadva. Ebben az esetben a cső karakter a táblázatos kifejezés utasításszintaxisának része, ahogyan azt a blokkszöveg is jelöli. További információ: Mi az a lekérdezési utasítás?
  • Az Állapot oszlop argumentumként lesz átadva a kötelező oszlopparaméterhez az opcionális asc jelzővel.
  • Vessző után a rendszer egy másik argumentumkészletet ad át: a StartTime oszlopot az opcionális desc jelzővel. A [, ...] szintaxis azt jelzi, hogy több argumentumhalmaz is átadható, de nem kötelező.

Választható paraméterek használata

Ha egy másik választható paramétert követő opcionális paraméter argumentumát szeretné megadni, meg kell adnia egy argumentumot az előző paraméterhez. Ennek a követelménynek az az oka, hogy az argumentumoknak a szintaxisban megadott sorrendet kell követnie. Ha nincs megadva egy adott érték a paraméterhez, használjon egy azonos típusú üres értéket.

Példa szekvenciális választható paraméterekre

Vegye figyelembe a http_request beépülő modul szintaxisát:

evaluatehttp_request(Uri [,RequestHeaders [,Beállítások]] )

A RequestHeaders és a Options a dinamikus típusú választható paraméterek. A Beállítások paraméter argumentumának megadásához meg kell adnia egy argumentumot is a RequestHeaders paraméterhez. Az alábbi példa bemutatja, hogyan adhat meg üres értéket az első opcionális paraméterhez, a RequestHeadershez, hogy meg lehessen adni egy értéket a második opcionális paraméterhez, a Beállításokhoz.

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

Kapcsolódó tartalom