az grafana dashboard

Referência

Nota

Essa referência faz parte da extensão amg para a CLI do Azure (versão 2.61.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az grafana dashboard . Saiba mais sobre extensões.

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

Comandos

Name	Description	Tipo	Status
az grafana dashboard create	Crie um novo painel.	Extensão	GA
az grafana dashboard delete	Exclua um painel.	Extensão	GA
az grafana dashboard import	Importe um painel.	Extensão	GA
az grafana dashboard list	Liste todos os painéis de uma instância.	Extensão	GA
az grafana dashboard show	Obtenha os detalhes de um painel.	Extensão	GA
az grafana dashboard sync	Sincronize painéis do Azure Managed Grafana de uma instância para outra. Os painéis da biblioteca dentro dos painéis serão automaticamente incluídos na sincronização. Observe que os painéis com o estado "Provisionado" serão ignorados devido a serem somente leitura.	Extensão	Pré-visualizar
az grafana dashboard update	Atualize um painel.	Extensão	GA

az grafana dashboard create

Crie um novo painel.

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

Exemplos

Crie um painel com definição em um arquivo json. Para um início rápido, clone a partir da saída de "az grafana dashboard show", remova "id" e "uid" e aplique 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 Obrigatórios

--definition

O modelo de painel completo em json string, um caminho ou url para um arquivo com tal conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, 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 título, até encontrar uma correspondência.

--overwrite

Substitua um painel com o mesmo uid.

Valores aceites: false, true

--resource-group -g

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

--title

Título de um painel.

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az grafana dashboard delete

Exclua um painel.

az grafana dashboard delete --dashboard
                            --name
                            [--api-key]
                            [--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 Obrigatórios

--dashboard

Dashboard uid.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

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]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Exemplos

importe o painel do "AKS Container Insights" da galeria Grafana.

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

Importe um painel de um arquivo.

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

Parâmetros Obrigatórios

--definition

O modelo de painel completo em json string, Grafana gallery id, um caminho ou url para um arquivo com tal conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, 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 título, até encontrar uma correspondência.

--overwrite

Substitua um painel com o mesmo uid.

Valores aceites: false, true

--resource-group -g

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az grafana dashboard list

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

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

Exemplos

Encontre o painel para o K8s API Server 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 Obrigatórios

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az grafana dashboard show

Obtenha os detalhes de um painel.

az grafana dashboard show --dashboard
                          --name
                          [--api-key]
                          [--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 Obrigatórios

--dashboard

Dashboard uid.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, a CLI usará as credenciais atuais do usuário conectado.

--resource-group -g

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az grafana dashboard sync

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Sincronize painéis do Azure Managed Grafana de uma instância para outra. Os painéis da biblioteca dentro dos painéis serão automaticamente incluídos na sincronização. Observe que os painéis com o estado "Provisionado" serão ignorados devido a 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

Sincronize apenas painéis 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 Obrigatórios

--destination -d

ID do recurso do espaço de trabalho de destino.

--source -s

ID do recurso do espaço de trabalho de origem.

Parâmetros Opcionais

--dashboards-to-exclude

Títulos separados por espaço de painéis para excluir em sincronia. Emparelhar com --folders-to-exclude para pastas específicas.

--dashboards-to-include

Títulos separados por espaço de painéis para incluir em sincronia. Emparelhar com --folders-to-include para pastas específicas.

--dry-run

Visualizar alterações sem confirmação.

Valores aceites: 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 de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

az grafana dashboard update

Atualize um painel.

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

Exemplos

Atualize um painel com definição em um arquivo json. Para um início rápido, obtenha a configuração existente em "az grafana dashboard show" e aplique as 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 Obrigatórios

--definition

O modelo de painel completo em json string, um caminho ou url para um arquivo com tal conteúdo.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --token -t

Chave de api ou token de conta de serviço, uma string gerada aleatoriamente usada para interagir com o endpoint Grafana; se faltar, 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 título, até encontrar uma correspondência.

--overwrite

Substitua um painel com o mesmo uid.

Valores aceites: false, true

--resource-group -g

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

Parâmetros de Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

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

Partilhar via

az grafana dashboard

Comandos

az grafana dashboard create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard delete

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard import

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard show

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard sync

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az grafana dashboard update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Recursos adicionais