Criar e gerenciar chaves de API do Grafana no Azure Managed Grafana (Preterido)

Importante

Este documento foi preterido, pois o recurso de chaves de API foi substituído por contas de serviço no Grafana 9.1. Para alternar para o uso de contas de serviço, em instâncias do Grafana criadas antes do lançamento do Grafana 9.1, vá para Chaves da API de configuração > e selecione Migrar para contas de serviço agora. Selecione Sim, migrar agora. Cada chave de API existente será migrada automaticamente para uma conta de serviço com um token. A conta de serviço será criada com a mesma permissão que a chave de API e as chaves de API atuais continuarão a funcionar como antes.

Atenção

Cada chave de API é tratada pelo Azure Managed Grafana como um único usuário ativo. Portanto, gerar novas chaves de API aumentará sua fatura mensal do Azure. Os preços por usuário ativo podem ser encontrados em Detalhes de preços.

Neste guia, saiba como gerar e gerenciar chaves de API e comece a fazer chamadas de API para o servidor Grafana. As chaves de API do Grafana permitirão que você crie integrações entre o Azure Managed Grafana e outros serviços.

Pré-requisitos

Ativar chaves de API

As chaves de API são desabilitadas por padrão no Azure Managed Grafana. Você pode habilitar esse recurso durante a criação da instância no portal do Azure ou pode ativá-lo em uma instância existente, usando o portal do Azure ou a CLI.

Criar um espaço de trabalho do Azure Managed Grafana com a criação de chaves de API habilitada

Durante a criação do espaço de trabalho do Azure Managed Grafana, habilite a criação de chaves de API na guia Avançado , definindo Habilitar criação de chave de API como Habilitado. Para obter mais informações sobre como criar uma nova instância usando o portal do Azure, vá para Guia de início rápido: criar uma instância do Azure Managed Grafana.

Habilitar a criação de chave de API em uma instância existente do Azure Managed Grafana

  1. No portal do Azure, em Configurações, selecione Configuração e, em chaves de API, selecione Habilitar.

    Screenshot of the Azure platform. Enable API keys.

  2. Selecione Salvar para confirmar que deseja ativar a criação de chaves de API no Azure Managed Grafana.

Gerar uma chave de API

  1. Abra sua instância do Azure Managed Grafana e, no menu à esquerda, selecione Chaves da API de configuração>. Screenshot of the Grafana dashboard. Access API keys page.

  2. Selecione Nova chave de API.

  3. Preencha o formulário e selecione Adicionar para gerar a nova chave de API.

    Parâmetro Descrição Exemplo
    Nome da chave Insira um nome para sua nova chave de API do Grafana. Chave API-1
    Função gerenciada do Grafana Escolha uma função do Grafana gerenciado: Visualizador, Editor ou Administrador. Direção
    Tempo de viver Insira um tempo antes que sua chave de API expire. Use s por segundos, m por minutos, h por horas, d por dias, w por semanas, M por meses, y por anos. 7 d

    Screenshot of the Grafana dashboard. API creation form is filled out.

  4. Uma vez que a chave tenha sido gerada, uma mensagem aparece com a nova chave e um comando curl incluindo sua chave. Copie esta informação e guarde-a nos seus registos agora, pois ficará oculta assim que sair desta página. Se você fechar esta página sem salvar a nova chave de API, precisará gerar uma nova.

    Screenshot of the Grafana dashboard. API key is displayed.

Agora você pode usar essa chave de API do Grafana para chamar o servidor do Grafana.

Testar a chave da API

Execute o comando az grafana dashboard list abaixo para verificar se sua chave de API está funcionando. Substitua os espaços reservados <azure-managed-grafana-name> pelo <api-key> nome da sua instância do Azure Managed Grafana e sua chave de API.

az grafana dashboard list --name <azure-managed-grafana-name> --api-key <api-key>

A saída do terminal lista todos os painéis que sua chave de API pode acessar na instância especificada do Azure Managed Grafana.

Gerir chaves de API

As chaves de API existentes estão listadas em Chaves de API de configuração>. Por padrão, apenas as chaves de API ativas são exibidas. Selecione Incluir chaves expiradas para exibir todas as chaves criadas e selecione X (Excluir) para excluir a chave da API.

Screenshot of the Grafana dashboard. API keys are listed under Configuration > API keys.

Próximos passos

Neste guia de instruções, você aprendeu como criar uma chave de API para o Azure Managed Grafana. Quando estiver pronto, comece a usar contas de serviço como a nova maneira de autenticar aplicativos que interagem com o Grafana: