Condividi tramite

Convenzioni di sintassi per la documentazione di riferimento

  • Articolo

Questo articolo descrive le convenzioni di sintassi seguite nella documentazione di riferimento sui comandi di gestione e Linguaggio di query Kusto (KQL).

Convenzioni della sintassi

Convenzione Descrizione
Block Valori letterali stringa da immettere esattamente come illustrato.
Corsivo Parametri da fornire un valore quando si usa la funzione o il comando .
[ ] Indica che l'elemento racchiuso è facoltativo.
( ) Indica che è necessario almeno uno degli elementi racchiusi.
| (pipe) Utilizzato all'interno di parentesi quadre o arrotondate per indicare che è possibile specificare uno degli elementi separati dal carattere barra verticale. In questo formato, la pipe equivale all'operatore OR logico. Quando si trova in un blocco (|), la pipe fa parte della sintassi della query KQL.
[, ...] Indica che il parametro precedente può essere ripetuto più volte, separato da virgole.
; Terminatore dell'istruzione di query.

Esempi

Funzioni scalari

In questo esempio viene illustrata la sintassi e un esempio di utilizzo della funzione hash, seguita da una spiegazione del modo in cui ogni componente della sintassi viene convertito nell'utilizzo di esempio.

Sintassi

hash(source [, mod])

Esempio di utilizzo

hash("World")
  • Il nome della funzione, hashe la parentesi di apertura vengono immessi esattamente come illustrato.
  • "World" viene passato come argomento per il parametro di origine richiesto.
  • Non viene passato alcun argomento per il parametro mod , che è facoltativo come indicato dalle parentesi quadre.
  • La parentesi di chiusura viene immessa esattamente come illustrato.

Operatore tabulare

In questo esempio viene illustrata la sintassi e un esempio di utilizzo dell'operatore di ordinamento, seguita da una spiegazione del modo in cui ogni componente della sintassi viene convertito nell'utilizzo di esempio.

Sintassi

Colonna T | sort by [] [nulls first | ascdesc | nulls last] [, ...]

Esempio di utilizzo

StormEvents
| sort by State asc, StartTime desc
  • La tabella StormEvents viene passata come argomento per il parametro T obbligatorio.
  • | sort by viene immesso esattamente come illustrato. In questo caso, il carattere pipe fa parte della sintassi dell'istruzione dell'espressione tabulare, come rappresentato dal testo del blocco. Per altre informazioni, vedere Che cos'è un'istruzione di query.
  • La colonna State viene passata come argomento per il parametro di colonna obbligatorio con il flag facoltativoasc.
  • Dopo una virgola, viene passato un altro set di argomenti: la colonna StartTime con il flag facoltativo desc . La sintassi [, ...] indica che è possibile passare più set di argomenti, ma non sono necessari.

Uso dei parametri facoltativi

Per fornire un argomento per un parametro facoltativo successivo a un altro parametro facoltativo, è necessario specificare un argomento per il parametro precedente. Questo requisito è dovuto al fatto che gli argomenti devono seguire l'ordine specificato nella sintassi. Se non si ha un valore specifico da passare per il parametro, usare un valore vuoto dello stesso tipo.

Esempio di parametri facoltativi sequenziali

Si consideri la sintassi per il plug-in http_request:

evaluatehttp_request ( URI [ RequestHeaders [, , Opzioni]])

RequestHeaders e Options sono parametri facoltativi di tipo dinamico. Per specificare un argomento per il parametro Options , è necessario specificare anche un argomento per il parametro RequestHeaders . Nell'esempio seguente viene illustrato come specificare un valore vuoto per il primo parametro facoltativo, RequestHeaders, per poter specificare un valore per il secondo parametro facoltativo, Options.

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

Contenuto correlato