Parâmetros da Pasta de Trabalho

Usando parâmetros, você pode coletar entradas de consumidores e referenciá-las em outras partes de uma pasta de trabalho. Geralmente é usado para definir o escopo do conjunto de resultados ou definir o visual correto. Você pode criar relatórios e experiências interativas usando esse recurso principal.

Ao usar pastas de trabalho, você pode controlar como seus controles de parâmetro são apresentados aos consumidores. Eles podem ser caixa de texto versus lista suspensa, seleção única versus seleção múltipla e valores de texto, JSON, KQL ou Azure Resource Graph.

Os tipos de parâmetros suportados incluem:

  • Tempo: Permite selecionar intervalos de tempo pré-preenchidos ou selecionar um intervalo personalizado
  • Lista suspensa: Permite selecionar a partir de um valor ou conjunto de valores
  • Grupo de opções: permite selecionar um valor a partir de um conjunto conhecido
  • Texto: permite inserir texto arbitrário
  • Critérios: Permite definir um conjunto de critérios com base em parâmetros previamente especificados, que serão avaliados para fornecer um valor dinâmico
  • Recurso: permite selecionar um ou mais recursos do Azure
  • Assinatura: permite selecionar um ou mais recursos de assinatura do Azure
  • Vários valores: permite que você defina um ou mais valores arbitrários de texto
  • Tipo de recurso: permite selecionar um ou mais valores de tipo de recurso do Azure
  • Local: permite que você selecione um ou mais valores de local do Azure

Referenciar um parâmetro

Você pode fazer referência a valores de parâmetro de outras partes de pastas de trabalho usando associações ou expansões de valor.

Referenciar um parâmetro com vinculações

Este exemplo mostra como referenciar um parâmetro de intervalo de tempo com associações:

  1. Selecione Adicionar consulta para adicionar um controle de consulta e depois selecione um recurso do Application Insights.

  2. Abra a lista suspensa Intervalo de tempo e selecione a opção Intervalo de tempo na seção Parâmetros na parte inferior:

    • Esta opção vincula o parâmetro de intervalo de tempo ao intervalo de tempo do gráfico.
    • O escopo de tempo da consulta de amostra agora é Últimas 24 horas.
  3. Execute a consulta para ver os resultados.

    Captura de tela que mostra um parâmetro de intervalo de tempo referenciado por meio de associações.

Referenciar um parâmetro com o KQL

Este exemplo mostra como referenciar um parâmetro de intervalo de tempo com KQL:

  1. Selecione Adicionar consulta para adicionar um controle de consulta e depois selecione um recurso do Application Insights.

  2. No KQL, insira um filtro de escopo de tempo usando o parâmetro: | where timestamp {TimeRange}

    • Este parâmetro expande o tempo de avaliação da consulta para | where timestamp > ago(1d).
    • Essa opção é o valor do intervalo de tempo do parâmetro.
  3. Execute a consulta para ver os resultados.

    Captura de tela que mostra um intervalo de tempo referenciado na consulta KQL.

Referência a um parâmetro com texto

Este exemplo mostra como referenciar um parâmetro de intervalo de tempo com texto:

  1. Adicione um controle de texto à pasta de trabalho.
  2. Em Markdown, insira The chosen time range is {TimeRange:label}.
  3. Selecione Done Editing.
  4. O controle de texto mostrará o texto: o intervalo de tempo escolhido é das últimas 24 horas.

Opções de formatação de parâmetro

Cada tipo de parâmetro tem suas próprias opções de formatação. Use a seção Visualizações do painel Editar parâmetro para ver as opções de expansão de formatação para seu parâmetro.

Captura de tela que mostra as opções de parâmetros de intervalo de tempo.

Você pode usar essas opções para formatar todos os tipos de parâmetros, exceto o Seletor de intervalo de tempo. Para obter exemplos de tempos de formatação, consulte Opções de parâmetros de tempo.

Outros tipos de parâmetros incluem:

  • Seletor de recursos: as IDs de recursos são formatadas.
  • Seletor de assinatura: os valores de assinatura são formatados.

Converter toml em json

Sintaxe: {param:tomltojson}

Valor original:

name = "Sam Green"

[address]
state = "New York"
country = "USA"

Valor formatado:

{
  "name": "Sam Green",
  "address": {
    "state": "New York",
    "country": "USA"
  }
}

JSON de escape

Sintaxe: {param:escapejson}

Valor original:

{
	"name": "Sam Green",
	"address": {
		"state": "New York",
		"country": "USA"
  }
}

Valor formatado:

{\r\n\t\"name\": \"Sam Green\",\r\n\t\"address\": {\r\n\t\t\"state\": \"New York\",\r\n\t\t\"country\": \"USA\"\r\n  }\r\n}

Codificar texto para base64

Sintaxe: {param:base64}

Valor original:

Sample text to test base64 encoding

Valor formatado:

U2FtcGxlIHRleHQgdG8gdGVzdCBiYXNlNjQgZW5jb2Rpbmc=

Formatar parâmetros usando JSONPath

Para parâmetros de cadeia de caracteres que são conteúdo JSON, você pode usar JSONPath na cadeia de caracteres de formato de parâmetro.

Por exemplo, você pode ter um parâmetro de string denominado selection resultado de uma consulta ou seleção em uma visualização que tenha o seguinte valor:

{ "series":"Failures", "x": 5, "y": 10 }

Usando JSONPath, você pode obter valores individuais desse objeto:

Format Result
{selection:$.series} Failures
{selection:$.x} 5
{selection:$.y} 10

Observação

Se o valor do parâmetro não for um JSON válido, o resultado do formato será um valor vazio.

Estilo do parâmetro

Os estilos a seguir estão disponíveis para os parâmetros.

Itens

O estilo de pílulas é o estilo padrão. Os parâmetros parecem texto e exigem que o usuário os selecione uma vez para entrar no modo de edição.

Captura de tela que mostra o modo de leitura em estilo de pílulas de pastas de trabalho do Azure.

Captura de tela que mostra o modo de edição em estilo de pílulas de pastas de trabalho do Azure.

Standard

No estilo padrão, os controles estão sempre visíveis, com um rótulo acima do controle.

Captura de tela que mostra o estilo padrão de pastas de trabalho do Azure.

Forma horizontal

No estilo horizontal de formulário, os controles estão sempre visíveis, com o rótulo no lado esquerdo do controle.

Captura de tela que mostra o estilo horizontal do formulário de pastas de trabalho do Azure.

Forma vertical

No estilo vertical de formulário, os controles estão sempre visíveis, com o rótulo acima do controle. Ao contrário do estilo padrão, há apenas um rótulo ou controle em uma linha.

Captura de tela que mostra o estilo vertical do formulário de pastas de trabalho do Azure.

Observação

Nos layouts padrão, horizontal e vertical, não há o conceito de edição em linha. Os controles estão sempre no modo de edição.

Parâmetros globais

Agora que você aprendeu como os parâmetros funcionam e as limitações de apenas poder usar um parâmetro "a jusante" de onde ele está definido, é hora de aprender sobre os parâmetros globais, que alteram essas regras.

Com um parâmetro global, o parâmetro ainda deve ser declarado antes de poder ser usado. Mas qualquer etapa que defina um valor para esse parâmetro afetará todas as instâncias desse parâmetro na pasta de trabalho.

Observação

Como a alteração de um parâmetro global tem esse comportamento de "atualizar tudo", a configuração global só deve ser ativada para parâmetros que exigem esse comportamento. Uma combinação de parâmetros globais que dependem uns dos outros pode criar um ciclo ou oscilação em que os globais concorrentes mudam uns aos outros repetidamente. Para evitar ciclos, você não pode "redeclarar" um parâmetro que foi declarado como global. Quaisquer declarações subsequentes de um parâmetro com o mesmo nome criarão um parâmetro somente leitura que não pode ser editado nesse local.

Usos comuns de parâmetros globais:

  1. Sincronize intervalos de tempo entre muitos gráficos:

    • Sem um parâmetro global, qualquer pincel de intervalo de tempo em um gráfico só será exportado após esse gráfico. Portanto, selecionar um intervalo de tempo no terceiro gráfico atualizará apenas o quarto gráfico.
    • Com um parâmetro global, você pode criar um parâmetro global timeRange, dar a ele um valor padrão e fazer com que todos os outros gráficos usem isso como seu intervalo de tempo vinculado e saída de pincel de tempo. Além disso, defina a configuração Exportar apenas o parâmetro quando um intervalo for escovado. Qualquer alteração de intervalo de tempo em qualquer gráfico atualiza o parâmetro global timeRange na parte superior da pasta de trabalho. Essa funcionalidade pode ser usada para fazer uma pasta de trabalho funcionar como um painel.
  2. Permitir alterar a guia selecionada em uma etapa de links por meio de links ou botões:

    • Sem um parâmetro global, a etapa de links gera apenas um parâmetro para a guia selecionada.
    • Com um parâmetro global, você pode criar um parâmetro global selectedTab. Em seguida, você pode usar esse nome de parâmetro nas seleções de guia na etapa de links. Você pode passar esse valor de parâmetro para a pasta de trabalho a partir de um link ou usando outro botão ou link para alterar a guia selecionada. Usar botões de uma etapa de links dessa maneira pode criar uma experiência semelhante a um assistente, em que os botões na parte inferior de uma etapa podem afetar as seções visíveis acima dela.

Criar um parâmetro global

Ao criar o parâmetro em uma etapa de parâmetros, use a opção Tratar este parâmetro como global em Configurações avançadas. A única maneira de fazer um parâmetro global é declará-lo com uma etapa de parâmetros. Os outros métodos de criação de parâmetros, por meio de seleções, brushing, links, botões e tabs, só podem atualizar um parâmetro global. Eles não podem declarar um.

Captura de tela que mostra a configuração de parâmetros globais em uma pasta de trabalho.

O parâmetro estará disponível e funcionará como os parâmetros normais funcionam.

Atualizar o valor de um parâmetro global existente

Para o exemplo do gráfico, a maneira mais comum de atualizar um parâmetro global é usando escovação de tempo.

Neste exemplo, o parâmetro timerange é declarado como global. Em uma etapa de consulta abaixo dele, crie e execute uma consulta que usa esse parâmetro timerange na consulta e retorna um resultado de gráfico de tempo. Em Configurações avançadas para a etapa de consulta, habilite a configuração de escovação de intervalo de tempo. Use o mesmo nome de parâmetro que a saída para o parâmetro de pincel de tempo. Além disso, selecione a opção Exportar apenas o parâmetro quando um intervalo for escovado.

Captura de tela que mostra a configuração do pincel de tempo global em uma pasta de trabalho.

Sempre que um intervalo de tempo é escovado neste gráfico, ele também atualiza o parâmetro timerange acima dessa consulta e a própria etapa da consulta, pois também depende do intervalo de tempo.

  1. Antes da pincelagem:

    • O intervalo de tempo é mostrado como Última hora.
    • O gráfico mostra a última hora de dados.

    Captura de tela que mostra a configuração de parâmetros globais antes de escovar.

  2. Durante a pincelagem:

    • O intervalo de tempo ainda é a última hora e os contornos de pincel são desenhados.
    • Nenhum parâmetro foi alterado. Depois que você soltar o pincel, o intervalo de tempo será atualizado.

    Captura de tela que mostra a configuração de parâmetros globais durante a escovação.

  3. Após a pincelagem:

    • O intervalo de tempo especificado pelo pincel de tempo é definido por esta etapa. Ele substitui o valor global. A lista suspensa de timerange agora exibe esse intervalo de tempo personalizado.
    • Como o valor global na parte superior foi alterado e como esse gráfico depende do intervalo de tempo como entrada, o intervalo de tempo da consulta usada no gráfico também é atualizado. Como resultado, a consulta e o gráfico serão atualizados.
    • Todas as outras etapas na pasta de trabalho que dependem de timerange também serão atualizadas.

    Captura de tela que mostra a configuração de parâmetros globais após a escovação.

    Observação

    Se você não usar um parâmetro global, o valor do parâmetro timerange só mudará abaixo desta etapa de consulta. As coisas acima desta etapa ou este item em si não serão atualizados.