Conventions de syntaxe pour la documentation de référence

  • Article

Cet article décrit les conventions de syntaxe suivies dans la documentation de référence sur les commandes Langage de requête Kusto (KQL) et de gestion.

Conventions de syntaxe

Convention Description
Block Littéraux de chaîne à entrer exactement comme indiqué.
Italique Paramètres à fournir une valeur lors de l’utilisation de la fonction ou de la commande.
[ ] Indique que l’élément placé est facultatif.
( ) Indique qu’au moins un des éléments placés est requis.
| (canal) Utilisé entre crochets ou crochets pour indiquer que vous pouvez spécifier l’un des éléments séparés par le caractère de canal. Sous cette forme, le canal équivaut à l’opérateur OR logique. Dans un bloc (|), le canal fait partie de la syntaxe de requête KQL.
[, ...] Indique que le paramètre précédent peut être répété plusieurs fois, séparé par des virgules.
; Fin de l’instruction de requête.

Exemples

Fonction scalaire

Cet exemple montre la syntaxe et un exemple d’utilisation de la fonction de hachage, suivi d’une explication de la façon dont chaque composant de syntaxe se traduit en exemple d’utilisation.

Syntax

hash(source [,mod])

Exemple d’utilisation

hash("World")
  • Le nom de la fonction , hashet la parenthèse ouvrante sont entrés exactement comme indiqué.
  • « World » est passé comme argument pour le paramètre source requis.
  • Aucun argument n’est passé pour le paramètre mod , qui est facultatif comme indiqué par les crochets.
  • La parenthèse fermante est entrée exactement comme indiqué.

Opérateur tabulaire

Cet exemple montre la syntaxe et un exemple d’utilisation de l’opérateur de tri, suivi d’une explication de la façon dont chaque composant de syntaxe se traduit en exemple d’utilisation.

Syntax

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

Exemple d’utilisation

StormEvents
| sort by State asc, StartTime desc
  • La table StormEvents est passée en tant qu’argument pour le paramètre T requis.
  • | sort by est entré exactement comme indiqué. Dans ce cas, le caractère de canal fait partie de la syntaxe de l’instruction d’expression tabulaire , telle que représentée par le texte de bloc. Pour plus d’informations, consultez Qu’est-ce qu’une instruction de requête.
  • La colonne State est passée en tant qu’argument pour le paramètre de colonne requis avec l’indicateur facultatif asc .
  • Après une virgule, un autre ensemble d’arguments est transmis : la colonne StartTime avec l’indicateur facultatif desc . La syntaxe [, ...] indique que d’autres jeux d’arguments peuvent être passés, mais ne sont pas obligatoires.

Utilisation de paramètres facultatifs

Pour fournir un argument pour un paramètre facultatif qui vient après un autre paramètre facultatif, vous devez fournir un argument pour le paramètre précédent. Cette exigence est due au fait que les arguments doivent suivre l’ordre spécifié dans la syntaxe. Si vous n’avez pas de valeur spécifique à passer pour le paramètre, utilisez une valeur vide du même type.

Exemple de paramètres facultatifs séquentiels

Considérez la syntaxe du plug-in http_request :

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

RequestHeaders et Options sont des paramètres facultatifs de type dynamique. Pour fournir un argument pour le paramètre Options , vous devez également fournir un argument pour le paramètre RequestHeaders . L’exemple suivant montre comment fournir une valeur vide pour le premier paramètre facultatif, RequestHeaders, afin de pouvoir spécifier une valeur pour le deuxième paramètre facultatif, Options.

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

Contenu connexe