Convenciones de sintaxis para la documentación de referencia

  • Artículo

En este artículo se describen las convenciones de sintaxis seguidas en la documentación de referencia de comandos de administracióny Lenguaje de consulta Kusto (KQL).

Convenciones de sintaxis

Convención Descripción
Block Literales de cadena que se van a escribir exactamente como se muestra.
Cursiva Parámetros que se van a proporcionar un valor tras el uso de la función o el comando.
[ ] Indica que el elemento incluido es opcional.
( ) Indica que se requiere al menos uno de los elementos incluidos.
| (canalización) Se usa entre corchetes o redondeos para indicar que puede especificar uno de los elementos separados por el carácter de canalización. En este formato, la canalización es equivalente al operador OR lógico. Cuando se encuentra en un bloque (|), la canalización forma parte de la sintaxis de consulta KQL.
[, ...] Indica que el parámetro anterior se puede repetir varias veces, separados por comas.
; Terminador de instrucciones de consulta.

Ejemplos

Función escalar

En este ejemplo se muestra la sintaxis y un uso de ejemplo de la función hash, seguida de una explicación de cómo se traduce cada componente de sintaxis en el uso de ejemplo.

Syntax

hash(source [,mod])

Ejemplo de uso

hash("World")
  • El nombre de la función , hashy el paréntesis de apertura se escriben exactamente como se muestra.
  • "World" se pasa como argumento para el parámetro de origen necesario.
  • No se pasa ningún argumento para el parámetro mod , que es opcional, como se indica en los corchetes.
  • El paréntesis de cierre se escribe exactamente como se muestra.

Operador tabular

En este ejemplo se muestra la sintaxis y un uso de ejemplo del operador sort, seguido de una explicación de cómo se traduce cada componente de sintaxis en el uso del ejemplo.

Syntax

T| sort bycolumn [] [ascdescnulls first | | nulls last] [, ...]

Ejemplo de uso

StormEvents
| sort by State asc, StartTime desc
  • La tabla StormEvents se pasa como argumento para el parámetro T necesario.
  • | sort by se especifica exactamente como se muestra. En este caso, el carácter de canalización forma parte de la sintaxis de la instrucción de expresión tabular , tal como se representa mediante el texto de bloque. Para más información, consulte ¿Qué es una instrucción de consulta?
  • La columna Estado se pasa como argumento para el parámetro de columna requerido con la marca opcional asc .
  • Después de una coma, se pasa otro conjunto de argumentos: la columna StartTime con la marca opcional desc . La sintaxis [, ...] indica que se pueden pasar más conjuntos de argumentos, pero no son necesarios.

Trabajar con parámetros opcionales

Para proporcionar un argumento para un parámetro opcional que viene después de otro parámetro opcional, debe proporcionar un argumento para el parámetro anterior. Este requisito se debe a que los argumentos deben seguir el orden especificado en la sintaxis. Si no tiene un valor específico para pasar para el parámetro, use un valor vacío del mismo tipo.

Ejemplo de parámetros opcionales secuenciales

Tenga en cuenta la sintaxis del complemento http_request:

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

RequestHeaders y Options son parámetros opcionales de tipo dinámico. Para proporcionar un argumento para el parámetro Options , también debe proporcionar un argumento para el parámetro RequestHeaders . En el ejemplo siguiente se muestra cómo proporcionar un valor vacío para el primer parámetro opcional, RequestHeaders, para poder especificar un valor para el segundo parámetro opcional, Options.

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

Contenido relacionado