Share via


在 Azure 受控 Grafana 中建立和管理 Grafana API 金鑰 (已淘汰)

重要

本文件已淘汰,因為 API 金鑰功能已由 Grafana 9.1 中的服務帳戶所取代。 若要切換為使用服務帳戶,請在 Grafana 9.1 發行之前建立的 Grafana 執行個體中,移至 [組態] > [API 金鑰],然後選取 [立即移轉至服務帳戶]。 選取 [是,立即移轉]。 每個現有的 API 金鑰都會與權杖一起自動移轉至服務帳戶。 系統會使用與 API 金鑰相同的權限來建立服務帳戶,而目前的 API 金鑰將繼續如往常般運作。

警告

Azure 受控 Grafana 會將每個 API 金鑰視為單一作用中使用者。 因此,產生新的 API 金鑰將會增加每月的 Azure 發票。 您可以在定價詳細資料中找到每個作用中使用者的定價。

在本指南中,了解如何產生和管理 API 金鑰,並開始對 Grafana 伺服器進行 API 呼叫。 Grafana API 金鑰可讓您建立 Azure 受控 Grafana 與其他服務之間的整合。

必要條件

啟用 API 金鑰

Azure 受控 Grafana 中預設會停用 API 金鑰。 您可以在 Azure 入口網站上建立執行個體期間啟用這項功能,或使用 Azure 入口網站或 CLI 在現有執行個體上加以啟用。

建立已啟用 API 金鑰建立的 Azure 受控 Grafana 工作區

在建立 Azure 受控 Grafana 工作區期間,藉由將 [啟用 API 金鑰建立] 設定為 [已啟用],在 [進階] 索引標籤中啟用 API 金鑰建立。 如需使用 Azure 入口網站建立新執行個體的詳細資訊,請移至快速入門:建立 Azure 受控 Grafana 執行個體

在現有的 Azure 受控 Grafana 執行個體上啟用 API 金鑰建立

  1. 在 Azure 入口網站的 [設定] 下,選取 [組態],然後在 [API 金鑰] 下選取 [啟用]

    Screenshot of the Azure platform. Enable API keys.

  2. 選取 [儲存] 以確認您想要在 Azure 受控 Grafana 中啟用 API 金鑰的建立。

產生 API 金鑰

  1. 開啟 Azure 受控 Grafana 執行個體,然後從左側功能表中選取 [設定] > [API 金鑰]Screenshot of the Grafana dashboard. Access API keys page.

  2. 選取 [新增 API 金鑰]

  3. 填寫表單,然後選取 [新增] 以產生新的 API 金鑰。

    參數 描述 範例
    金鑰名稱 輸入新 Grafana API 金鑰的名稱。 api-key-1
    受控 Grafana 角色 選擇受控 Grafana 角色:檢視器、編輯器或管理員。 編輯器
    存留時間 輸入 API 金鑰到期前的時間。 使用 s 代表秒、m 代表分鐘、h 代表小時、d 代表天、w 代表周、M 代表月、y 代表年。 7d

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

  4. 產生金鑰之後,會出現一則訊息,該訊息顯示新的金鑰和 curl 命令,包括您的金鑰。 複製此資訊並立即儲存在您的記錄中,因為當您離開此頁面後,系統將會隱藏此資訊。 如果您關閉此頁面而未儲存新的 API 金鑰,則將會需要產生新的金鑰。

    Screenshot of the Grafana dashboard. API key is displayed.

您現在可以使用此 Grafana API 金鑰來呼叫 Grafana 伺服器。

測試 API 金鑰

執行下面的 az grafana dashboard list 命令,以檢查您的 API 金鑰是否正常運作。 將預留位置 <azure-managed-grafana-name><api-key> 取代為 Azure 受控 Grafana 執行個體的名稱和 API 金鑰。

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

終端機輸出會列出 API 金鑰可在指定 Azure 受控 Grafana 執行個體中存取的所有儀表板。

管理 API 金鑰

現有的 API 金鑰會列在 [設定] > [API 金鑰] 中。 根據預設,只會顯示作用中的 API 金鑰。 選取 [包含過期的金鑰] 以檢視所有已建立的金鑰,然後選取 [X (刪除)] 以刪除 API 金鑰。

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

下一步

在本操作指南中,您已了解如何建立 Azure 受控 Grafana 的 API 金鑰。 準備就緒後,請開始使用服務帳戶作為與 Grafana 互動之應用程式的新驗證方式: