az grafana

Nota

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

Comandos para gerenciar instâncias do Azure Grafana.

Para uma experiência otimizada, nem todas as APIs de plano de dados, documentadas em https://grafana.com/docs/grafana/latest/http_api/, são expostas. Sobre a lacuna de cobertura, entre em contato com ad4g@microsoft.com.

Comandos

Name Description Tipo Estado
az grafana api-key

Comandos para gerenciar chaves api.

Extensão GA
az grafana api-key create

Crie uma nova chave de API.

Extensão GA
az grafana api-key delete

Exclua uma chave de API.

Extensão GA
az grafana api-key list

Liste as chaves de API existentes.

Extensão GA
az grafana backup

Faça backup do conteúdo de uma instância do Azure Managed Grafana em um arquivo.

Extensão Pré-visualizar
az grafana create

Crie uma instância do Azure Managed Grafana.

Extensão GA
az grafana dashboard

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

Extensão GA
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. Observe que os painéis com estado "provisionado" serão ignorados por serem somente leitura.

Extensão Pré-visualizar
az grafana dashboard update

Atualize um painel.

Extensão GA
az grafana data-source

Comandos para gerenciar fontes de dados de uma instância.

Extensão GA
az grafana data-source create

Crie uma fonte de dados.

Extensão GA
az grafana data-source delete

Excluir uma fonte de dados.

Extensão GA
az grafana data-source list

Liste todas as fontes de dados de uma instância.

Extensão GA
az grafana data-source query

Consultar uma fonte de dados com implementação de back-end.

Extensão GA
az grafana data-source show

Obtenha os detalhes de uma fonte de dados.

Extensão GA
az grafana data-source update

Atualizar uma fonte de dados.

Extensão GA
az grafana delete

Exclua uma instância do Azure Managed Grafana.

Extensão GA
az grafana folder

Comandos para gerenciar pastas de uma instância.

Extensão GA
az grafana folder create

Criar uma nova pasta.

Extensão GA
az grafana folder delete

Exclua uma pasta.

Extensão GA
az grafana folder list

Liste todas as pastas de uma instância.

Extensão GA
az grafana folder show

Obtenha os detalhes de uma pasta.

Extensão GA
az grafana folder update

Atualize uma pasta.

Extensão GA
az grafana list

Liste instâncias do Azure Managed Grafana.

Extensão GA
az grafana notification-channel

Comandos para gerenciar canais de notificação de uma instância.

Extensão GA
az grafana notification-channel create

Crie um canal de notificação.

Extensão GA
az grafana notification-channel delete

Exclua um canal de notificação.

Extensão GA
az grafana notification-channel list

Liste todos os canais de notificação de uma instância.

Extensão GA
az grafana notification-channel show

Obtenha os detalhes de um canal de notificação.

Extensão GA
az grafana notification-channel test

Teste um canal de notificação.

Extensão GA
az grafana notification-channel update

Atualize um canal de notificação.

Extensão GA
az grafana restore

Restaure uma instância do Azure Managed Grafana a partir de um arquivo.

Extensão Pré-visualizar
az grafana service-account

Comandos para gerenciar contas de serviço.

Extensão GA
az grafana service-account create

Crie uma nova conta de serviço.

Extensão GA
az grafana service-account delete

Exclua uma conta de serviço.

Extensão GA
az grafana service-account list

Listar contas de serviço existentes.

Extensão GA
az grafana service-account show

Obtenha os detalhes de uma conta de serviço.

Extensão GA
az grafana service-account token

Comandos para gerenciar tokens de conta de serviço.

Extensão GA
az grafana service-account token create

Crie um novo token de conta de serviço.

Extensão GA
az grafana service-account token delete

Exclua um token de conta de serviço.

Extensão GA
az grafana service-account token list

Listar tokens de conta de serviço existentes.

Extensão GA
az grafana service-account update

Atualizar uma conta de serviço.

Extensão GA
az grafana show

Mostrar detalhes de uma instância do Azure Managed Grafana.

Extensão GA
az grafana update

Atualize uma instância do Azure Managed Grafana.

Extensão GA
az grafana user

Comandos para gerenciar usuários de uma instância.

Extensão GA
az grafana user actual-user

Obtenha os detalhes do usuário atual.

Extensão GA
az grafana user list

Listar usuários.

Extensão GA
az grafana user show

Obtenha os detalhes de um usuário.

Extensão GA

az grafana backup

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

Faça backup do conteúdo de uma instância do Azure Managed Grafana em um arquivo.

az grafana backup --name
                  [--components {annotations, dashboards, datasources, folders, snapshots}]
                  [--directory]
                  [--folders-to-exclude]
                  [--folders-to-include]
                  [--resource-group]

Exemplos

Painéis de backup em 2 pastas (as fontes de dados são incluídas para habilitar o remapeamento de nomes ao restaurar painéis para outro espaço de trabalho)

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp --folders-to-include "Prod" "Compute Gateway" --components datasources dashboards folders

Faça backup de painéis e ignore algumas pastas

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp  --folders-to-exclude General "Azure Monitor" --components datasources dashboards folders

Parâmetros Obrigatórios

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--components -c

Tipos de artefato Grafana para backup.

valores aceites: annotations, dashboards, datasources, folders, snapshots
--directory -d

Diretório para backup de artefatos Grafana.

--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.

--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
valor predefinido: 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 create

Crie uma instância do Azure Managed Grafana.

az grafana create --name
                  --resource-group
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--location]
                  [--principal-ids]
                  [--principal-types {Group, ServicePrincipal, User}]
                  [--skip-role-assignments {false, true}]
                  [--skip-system-assigned-identity {false, true}]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

Parâmetros Obrigatórios

--name -n

Nome do Azure Managed Grafana.

--resource-group -g

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

Parâmetros Opcionais

--deterministic-outbound-ip -i

Se ativado, o espaço de trabalho do Grafana terá IPs de saída fixos que você pode usá-los no firewall de fontes de dados. Predefinição: Desativado.

valores aceites: Disabled, Enabled
--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--principal-ids

IDs de objeto do Azure AD separadas por espaço para usuários, grupos, etc. a serem feitas como administradores do Grafana. Uma vez fornecida, a CLI não tornará o usuário conectado atual como administrador do Grafana.

--principal-types

Tipos principais do Azure AD separados por espaço para emparelhar com --principal-ids.

valores aceites: Group, ServicePrincipal, User
--skip-role-assignments

Não crie atribuições de função para a identidade gerenciada e o usuário de login atual.

valores aceites: false, true
valor predefinido: False
--skip-system-assigned-identity -s

Não habilite a identidade atribuída ao sistema.

valores aceites: false, true
valor predefinido: False
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--zone-redundancy

Indica se a redundância de zona deve ou não ser habilitada. Predefinição: Desativado.

valores aceites: Disabled, Enabled
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
valor predefinido: 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 delete

Exclua uma instância do Azure Managed Grafana.

az grafana delete --name
                  [--resource-group]
                  [--yes]

Parâmetros Obrigatórios

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--resource-group -g

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

--yes -y

Não solicite confirmação.

valor predefinido: False
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
valor predefinido: 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 list

Liste instâncias do Azure Managed Grafana.

az grafana list [--resource-group]

Parâmetros Opcionais

--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
valor predefinido: 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 restore

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

Restaure uma instância do Azure Managed Grafana a partir de um arquivo.

az grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

Exemplos

Restaure painéis. Se estiverem em pastas, inclua "pastas" na lista de componentes; use "--remap-data-sources" para que a CLI atualize os painéis para apontar para as mesmas fontes de dados no espaço de trabalho de destino

az grafana restore -g MyResourceGroup -n MyGrafana --archive-file backup\dashboards\ServiceHealth-202307051036.tar.gz --components dashboards folders --remap-data-sources

Parâmetros Obrigatórios

--archive-file -a

Arquivo para restaurar artefatos de Grafana.

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--components -c

Tipos de artefato Grafana para backup.

valores aceites: annotations, dashboards, datasources, folders, snapshots
--remap-data-sources -r

Durante a restauração, atualize os painéis para fazer referência a fontes de dados definidas no espaço de trabalho de destino por meio da correspondência de nomes.

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
valor predefinido: 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 show

Mostrar detalhes de uma instância do Azure Managed Grafana.

az grafana show --name
                [--resource-group]

Parâmetros Obrigatórios

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--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
valor predefinido: 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 update

Atualize uma instância do Azure Managed Grafana.

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--host]
                  [--major-version]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {false, true}]
                  [--smtp {Disabled, Enabled}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--tags]
                  [--user]

Exemplos

Desativar o acesso à rede pública

az grafana update -g MyResourceGroup -n MyGrafana --public-network-access disabled

habilitar notificação de e-mail através de retransmissão SMTP sevice de mailgun

az grafana update -g MyResourceGroup -n MyGrafana --smtp enabled --from-address johndoe@outlook.com --from-name john --host "smtp.mailgun.org:587" --user "postmaster@sandbox12345.mailgun.org" --password "password" --start-tls-policy OpportunisticStartTLS --skip-verify true

Parâmetros Obrigatórios

--name -n

Nome do Azure Managed Grafana.

Parâmetros Opcionais

--api-key --service-account

Se ativado, você poderá configurar chaves de API Grafana e contas de serviço.

valores aceites: Disabled, Enabled
--deterministic-outbound-ip -i

Se ativado, o espaço de trabalho do Grafana terá IPs de saída fixos que você pode usá-los no firewall de fontes de dados.

valores aceites: Disabled, Enabled
--from-address

Endereço usado ao enviar e-mails.

--from-name

Nome a ser usado ao enviar e-mails.

--host

URL do servidor SMTP (porta incluída).

--major-version

Número da versão principal do Grafana.

--password

Senha de usuário do servidor SMTP.

--public-network-access -p

Permitir acesso à rede pública.

valores aceites: Disabled, Enabled
--resource-group -g

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

--skip-verify

Ignore a verificação do SSL para o servidor SMTP.

valores aceites: false, true
--smtp

Permita que o Grafana envie e-mails.

valores aceites: Disabled, Enabled
--start-tls-policy

Política TLS.

valores aceites: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--user

Nome de usuário do servidor SMTP.

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
valor predefinido: 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.