Convenções de sintaxe para documentação de referência

  • Artigo

Este artigo descreve as convenções de sintaxe seguidas na documentação de referência de comandos de gerenciamentoe Linguagem de Consulta Kusto (KQL).

Convenções de sintaxe

Convenção Descrição
Block Literais de cadeia de caracteres a serem inseridos exatamente como mostrado.
Itálico Parâmetros a serem fornecidos um valor após o uso da função ou comando.
[ ] Indica que o item incluído é opcional.
( ) Indica que pelo menos um dos itens incluídos é necessário.
| (pipe) Usado em colchetes ou colchetes redondos para indicar que você pode especificar um dos itens separados pelo caractere de pipe. Nesse formulário, o pipe é equivalente ao operador OR lógico. Quando em um bloco (|), o pipe faz parte da sintaxe de consulta KQL.
[, ...] Indica que o parâmetro anterior pode ser repetido várias vezes, separado por vírgulas.
; Terminador de instrução de consulta.

Exemplos

Função de valor escalar

Este exemplo mostra a sintaxe e um exemplo de uso da função de hash, seguido de uma explicação de como cada componente de sintaxe se traduz no uso de exemplo.

Syntax

hash(source [,mod])

Exemplo de uso

hash("World")
  • O nome da função , hashe os parênteses de abertura são inseridos exatamente como mostrado.
  • "World" é passado como um argumento para o parâmetro de origem necessário.
  • Nenhum argumento é passado para o parâmetro mod , que é opcional conforme indicado pelos colchetes.
  • O parêntese de fechamento é inserido exatamente como mostrado.

Operador tabular

Este exemplo mostra a sintaxe e um exemplo de uso do operador de classificação, seguido de uma explicação de como cada componente de sintaxe se traduz no uso de exemplo.

Syntax

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

Exemplo de uso

StormEvents
| sort by State asc, StartTime desc
  • A tabela StormEvents é passada como um argumento para o parâmetro T necessário.
  • | sort by é inserido exatamente como mostrado. Nesse caso, o caractere pipe faz parte da sintaxe da instrução de expressão tabular , conforme representado pelo texto do bloco. Para saber mais, confira O que é uma instrução de consulta.
  • A coluna Estado é passada como um argumento para o parâmetro de coluna necessário com o sinalizador opcional asc .
  • Após uma vírgula, outro conjunto de argumentos é passado: a coluna StartTime com o sinalizador opcional desc . A sintaxe [, ...] indica que mais conjuntos de argumentos podem ser passados, mas não são necessários.

Trabalhando com parâmetros opcionais

Para fornecer um argumento para um parâmetro opcional que vem após outro parâmetro opcional, você deve fornecer um argumento para o parâmetro anterior. Esse requisito ocorre porque os argumentos devem seguir a ordem especificada na sintaxe. Se você não tiver um valor específico para passar para o parâmetro, use um valor vazio do mesmo tipo.

Exemplo de parâmetros opcionais sequenciais

Considere a sintaxe do plug-in http_request:

evaluatehttp_request(Uri [,RequestHeaders [,Opções]] )

RequestHeaders e Options são parâmetros opcionais do tipo dinâmico. Para fornecer um argumento para o parâmetro Options , você também deve fornecer um argumento para o parâmetro RequestHeaders . O exemplo a seguir mostra como fornecer um valor vazio para o primeiro parâmetro opcional, RequestHeaders, para poder especificar um valor para o segundo parâmetro opcional, Options.

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

Conteúdo relacionado