Criar e gerenciar chaves de API do Grafana no Espaço Gerenciado do Azure para Grafana (Preterido)

Importante

Este documento foi preterido porque 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.

Cuidado

Cada chave de API é tratada pelo Azure Managed Grafana como um único usuário ativo. Portanto, a geração de 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 começar a fazer chamadas à API para o servidor Grafana. As chaves de API do Grafana permitirão que você crie integrações entre o Espaço Gerenciado do Azure para Grafana e outros serviços.

Pré-requisitos

Habilitar chaves de API

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

Criar um workspace do Espaço Gerenciado do Azure para Grafana com a criação de chave de API habilitada

Durante a criação do workspace do Espaço Gerenciado do Azure para Grafana, habilite a criação de chaves de API na guia Avançado, definindo Habilitar a criação de chave de API como Habilitada. Para obter mais informações sobre como criar uma instância usando o portal do Azure, acesse Início Rápido: criar uma instância do Espaço Gerenciado do Azure para Grafana.

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

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

    Screenshot of the Azure platform. Enable API keys.

  2. Selecione Salvar para confirmar se deseja ativar a criação de chaves de API no Espaço Gerenciado do Azure para Grafana.

Gere uma chave de API

  1. Abra a instância do Espaço Gerenciado do Azure para Grafana e, no menu à esquerda, selecione Configuração > Chaves de API. 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 a nova chave de API do Grafana. api-key-1
    Função do Espaço Gerenciado para Grafana Escolha uma função do Espaço Gerenciado para Grafana: Visualizador, Editor ou Administrador. Editor
    Vida útil Insira um tempo para a expiração da chave de API. Use s para segundos, m para minutos, h para horas, d para dias, w para semanas, M para meses e y para anos. 7d

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

  4. Depois que a chave for gerada, uma mensagem aparecerá com a nova chave e um comando curl, incluindo a chave. Copie essas informações e salve-as em seus registros agora, pois elas ficarão ocultas quando você sair desta página. Se você fechar esta página sem salvar a nova chave de API, será necessário gerar outra.

    Screenshot of the Grafana dashboard. API key is displayed.

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

Testar a chave de API

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

Gerenciar chaves de API

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

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

Próximas etapas

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