Share via


Creare e gestire chiavi API Grafana in Grafana gestito di Azure (deprecato)

Importante

Questo documento è deprecato perché la funzionalità delle chiavi API è stata sostituita dagli account del servizio in Grafana 9.1. Per passare all'uso degli account del servizio, nelle istanze di Grafana create prima del rilascio di Grafana 9.1 passare a Chiavi API di configurazione > e selezionare Esegui la migrazione agli account del servizio. Selezionare Sì, eseguire la migrazione ora. Ogni chiave API esistente verrà automaticamente migrata in un account del servizio con un token. L'account del servizio verrà creato con la stessa autorizzazione della chiave API e delle chiavi API correnti continuerà a funzionare come in precedenza.

Attenzione

Ogni chiave API viene gestita da Azure Managed Grafana come singolo utente attivo. La generazione di nuove chiavi API aumenterà quindi la fattura mensile di Azure. I prezzi per utente attivo sono disponibili in Dettagli prezzi.

Questa guida illustra come generare e gestire le chiavi API e iniziare a effettuare chiamate API al server Grafana. Le chiavi API Grafana consentono di creare integrazioni tra Azure Managed Grafana e altri servizi.

Prerequisiti

Abilitare le chiavi API

Le chiavi API sono disabilitate per impostazione predefinita in Grafana gestito di Azure. È possibile abilitare questa funzionalità durante la creazione dell'istanza nel portale di Azure oppure attivarla in un'istanza esistente usando il portale di Azure o l'interfaccia della riga di comando.

Creare un'area di lavoro Grafana gestita di Azure con la creazione della chiave API abilitata

Durante la creazione dell'area di lavoro Grafana gestita di Azure, abilitare la creazione di chiavi API nella scheda Avanzate impostando Abilita creazione della chiave API su Abilitato. Per altre informazioni sulla creazione di una nuova istanza usando il portale di Azure, vedere Avvio rapido: Creare un'istanza di Grafana gestita di Azure.

Abilitare la creazione della chiave API in un'istanza di Grafana gestita di Azure esistente

  1. Nella portale di Azure, in Impostazioni selezionare Configurazione e quindi in Chiavi API selezionare Abilita.

    Screenshot of the Azure platform. Enable API keys.

  2. Selezionare Salva per confermare che si vuole attivare la creazione di chiavi API in Grafana gestito di Azure.

Generare una chiave API

  1. Aprire l'istanza di Grafana gestita di Azure e scegliere Chiavi API di configurazione > dal menu a sinistra. Screenshot of the Grafana dashboard. Access API keys page.

  2. Selezionare Nuova chiave API.

  3. Compilare il modulo e selezionare Aggiungi per generare la nuova chiave API.

    Parametro Descrizione Esempio
    Nome chiave Immettere un nome per la nuova chiave API Grafana. api-key-1
    Ruolo Grafana gestito Scegliere un ruolo Grafana gestito: Visualizzatore, Editor o Amministrazione. Editor
    Durata (TTL) Immettere un'ora prima della scadenza della chiave API. Utilizzare s per secondi, m per minuti, h per ore, d per giorni, w per settimane, M per mesi, y per anni. 7 g

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

  4. Dopo aver generato la chiave, viene visualizzato un messaggio con la nuova chiave e un comando curl che include la chiave. Copiare queste informazioni e salvarle nei record ora, perché verranno nascoste dopo aver lasciato questa pagina. Se si chiude questa pagina senza salvare la nuova chiave API, sarà necessario generarne una nuova.

    Screenshot of the Grafana dashboard. API key is displayed.

È ora possibile usare questa chiave API Grafana per chiamare il server Grafana.

Testare la chiave API

Eseguire il comando az grafana dashboard list seguente per verificare se la chiave API funziona. Sostituire i segnaposto <azure-managed-grafana-name> e <api-key> con il nome dell'istanza di Grafana gestita di Azure e della chiave API.

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

L'output del terminale elenca tutti i dashboard a cui la chiave API può accedere nell'istanza di Grafana gestita di Azure specificata.

Gestire le chiavi API

Le chiavi API esistenti sono elencate in Chiavi API di configurazione>. Per impostazione predefinita, vengono visualizzate solo le chiavi API attive. Selezionare Includi chiavi scadute per visualizzare tutte le chiavi create e selezionare X (Elimina) per eliminare la chiave API.

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

Passaggi successivi

In questa guida pratica si è appreso come creare una chiave API per Grafana gestita di Azure. Quando si è pronti, iniziare a usare gli account del servizio come nuovo modo per autenticare le applicazioni che interagiscono con Grafana: