Compartilhar via

az grafana dashboard

Note

This reference is part of the amg extension for the Azure CLI (version 2.61.0 or higher). A extensão instalará automaticamente na primeira vez que você executar um comando az grafana dashboard. Learn more about extensions.

Comandos para gerenciar painéis de uma instância.

Comandos

Nome Description Tipo Status
az grafana dashboard create

Crie um novo painel.

 Extension GA
az grafana dashboard delete

Excluir um painel.

 Extension GA
az grafana dashboard import

Importe um painel.

 Extension GA
az grafana dashboard list

Listar todos os painéis de uma instância.

 Extension GA
az grafana dashboard show

Obtenha os detalhes de um painel.

 Extension GA
az grafana dashboard sync

Sincronize os painéis do Azure Managed Grafana de uma instância para outra. Os painéis da biblioteca nos painéis serão incluídos automaticamente na sincronização. Observe que os painéis com o estado "Provisionado" serão ignorados por serem somente leitura.

 Extension Preview
az grafana dashboard update

Atualize um painel.

 Extension GA

az grafana dashboard create

Crie um novo painel.

az grafana dashboard create --definition
                            --name
                            [--api-key --token]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]
                            [--title]

Exemplos

Crie um dashboard com definição em um arquivo json. Para início rápido, clone da saída de "az grafana dashboard show", remova "id" e "uid" e aplique as alterações.

az grafana dashboard create -g MyResourceGroup -n MyGrafana --title "My dashboard" --folder folder1 --definition '{
  "dashboard": {
    "annotations": {
        ...
    },
    "panels": {
        ...
    }
  },
  "message": "Create a new test dashboard"
}'

Parâmetros Exigidos

--definition

O modelo de painel completo na cadeia de caracteres json, um caminho ou url para um arquivo com esse conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--folder

Uid ou título que pode identificar uma pasta. A CLI pesquisará com uid primeiro, depois o título, até encontrar uma correspondência.

--overwrite

Substitua um dashboard com a mesma uid.

Propriedade Valor
Valores aceitos: false, true
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--title

Título de um dashboard.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard delete

Excluir um painel.

az grafana dashboard delete --dashboard
                            --name
                            [--api-key --token]
                            [--resource-group]

Exemplos

Excluir um painel especificado por um identificador exclusivo (use o comando "az grafana dashboard list" para recuperar o uid)

az grafana dashboard delete -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parâmetros Exigidos

--dashboard

Dashboard uid.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard import

Importe um painel.

O comando CLI preencherá os parâmetros necessários para fontes de dados, se configurado.

az grafana dashboard import --definition
                            --name
                            [--api-key --token]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Exemplos

importe o painel de "Insights de Contêiner do AKS" da galeria grafana.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition 12180

importar um dashboard de um arquivo.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parâmetros Exigidos

--definition

O modelo de painel completo na cadeia de caracteres json, id da galeria do Grafana, um caminho ou url para um arquivo com esse conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--folder

Uid ou título que pode identificar uma pasta. A CLI pesquisará com uid primeiro, depois o título, até encontrar uma correspondência.

--overwrite

Substitua um dashboard com a mesma uid.

Propriedade Valor
Valores aceitos: false, true
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard list

Listar todos os painéis de uma instância.

az grafana dashboard list --name
                          [--api-key --token]
                          [--resource-group]

Exemplos

Localize o painel do Servidor de API K8s e recupere o identificador exclusivo(para invocar o comando "az grafana dashboard show")

az grafana dashboard list -g MyResourceGroup -n MyGrafana --query "[?contains(@.title, 'API server')].uid"

Parâmetros Exigidos

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard show

Obtenha os detalhes de um painel.

az grafana dashboard show --dashboard
                          --name
                          [--api-key --token]
                          [--resource-group]

Exemplos

Obter detalhes de um painel especificado por um identificador exclusivo (use o comando "az grafana dashboard list" para recuperar o uid)

az grafana dashboard show -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parâmetros Exigidos

--dashboard

Dashboard uid.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard sync

Versão Prévia

Esse comando está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Sincronize os painéis do Azure Managed Grafana de uma instância para outra. Os painéis da biblioteca nos painéis serão incluídos automaticamente na sincronização. Observe que os painéis com o estado "Provisionado" serão ignorados por serem somente leitura.

az grafana dashboard sync --destination
                          --source
                          [--dashboards-to-exclude]
                          [--dashboards-to-include]
                          [--dry-run {false, true}]
                          [--folders-to-exclude]
                          [--folders-to-include]

Exemplos

Sincronizar somente dashboards em algumas pastas

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "Azure Monitor Container Insights" "Azure Monitor"

Sincronizar um único painel

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "MyFolder" --dashboards-to-include "My Service Health"

Visualizar a sincronização

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --dry-run

Parâmetros Exigidos

--destination -d

ID do recurso do workspace de destino.

--source -s

ID do recurso do workspace de origem.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--dashboards-to-exclude

Espaço separado de títulos de dashboards a serem excluídos na sincronização. Emparelhe com --folders-to-exclude para pastas específicas.

--dashboards-to-include

Espaço separado de títulos de dashboards a serem incluídos na sincronização. Emparelhe com --folders-to-include para pastas específicas.

--dry-run

Visualizar alterações em confirmação em w/o.

Propriedade Valor
Valores aceitos: false, true
--folders-to-exclude -e

Pastas a serem excluídas no backup ou sincronização.

--folders-to-include -i

Pastas a serem incluídas no backup ou sincronização.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False

az grafana dashboard update

Atualize um painel.

az grafana dashboard update --definition
                            --name
                            [--api-key --token]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Exemplos

Atualize um dashboard com definição em um arquivo json. Para início rápido, obtenha a configuração existente de "az grafana dashboard show" e aplique alterações. O campo "versão" precisa ser atualizado e o campo "substituir" deve ser verdadeiro.

az grafana dashboard update -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parâmetros Exigidos

--definition

O modelo de painel completo na cadeia de caracteres json, um caminho ou url para um arquivo com esse conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Chave de API ou token de conta de serviço, uma cadeia de caracteres gerada aleatoriamente usada para interagir com o ponto de extremidade do Grafana; se estiver ausente, a CLI usará as credenciais atuais do usuário conectado.

--folder

Uid ou título que pode identificar uma pasta. A CLI pesquisará com uid primeiro, depois o título, até encontrar uma correspondência.

--overwrite

Substitua um dashboard com a mesma uid.

Propriedade Valor
Valores aceitos: false, true
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Output format.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade Valor
Valor padrão: False