如何在 Azure 受控 Grafana 中使用服務帳戶
在本指南中,瞭解如何使用服務帳戶。 服務帳戶可用來執行自動化作業,並使用 Grafana API 在 Grafana 中驗證應用程式。
常見的使用案例包括:
- 布建或設定儀錶板
- 排程報表
- 定義警示
- 設定外部SAML驗證提供者
- 與 Grafana 互動而不以使用者身分登入
必要條件
- 具有有效訂用帳戶的 Azure 帳戶。 免費建立帳戶。
- Azure 受控 Grafana 實例。 如果您還沒有 Azure 受控 Grafana 實例,請建立。
啟用服務帳戶
如果您現有的 Grafana 工作區未啟用服務帳戶,您可以藉由更新 Grafana 實例的喜好設定加以啟用。
在 Azure 入口網站 的 [設定] 下,選取 [組態],然後在 [API 密鑰和服務帳戶] 底下,選取 [啟用]。
選取 [ 儲存 ] 以確認您想要在 Azure Managed Grafana 中啟用 API 金鑰和服務帳戶。
- 需要 Azure 受控 Grafana CLI 延伸模組 0.3.0 或更新版本。 若要更新延伸模組,請執行
az extension update --name amg
。
- 執行 az grafana update 命令,以在現有的 Azure 受控 Grafana 實例中建立 API 金鑰和服務帳戶。 在下列命令中,將 取代
<azure-managed-grafana-name>
為要更新的 Azure 受控 Grafana 實例名稱。
az grafana update --name <azure-managed-grafana-name> ---service-account Enabled
建立服務帳戶
請遵循下列步驟來建立新的 Grafana 服務帳戶,並列出現有的服務帳戶:
移至您的 Grafana 實例端點,然後在 [設定] 底下,選取 [服務帳戶]。
選取 [新增服務帳戶],然後輸入新 Grafana 服務帳戶的 [顯示名稱] 和 [角色:查看器]、[編輯器] 或 [管理員],然後選取 [建立]。
此頁面會顯示已成功建立的通知服務帳戶,以及新服務帳戶的一些資訊。
選取上一個箭頭符號,以檢視 Grafana 實例的所有服務帳戶清單。
az grafana service-account create
執行 命令以建立服務帳戶。 將佔位元 <azure-managed-grafana-name>
取代 <service-account-name>
<role>
為 您自己的資訊。
可用的角色: Admin
、 Editor
、 Viewer
。
az grafana service-account create --name <azure-managed-grafana-name> --service-account <service-account-name> --role <role>
列出服務帳戶
az grafana service-account list
執行 命令以取得屬於指定 Azure 受控 Grafana 實例的所有服務帳戶清單。 將 取代 <azure-managed-grafana-name>
為您的 Azure 受控 Grafana 工作區名稱。
az grafana service-account list --name <azure-managed-grafana-name> --output table
輸出範例:
AvatarUrl IsDisabled Login Name OrgId Role Tokens
-------------------- ------------ ----------- ---------- ------- ------ --------
/avatar/abc12345678 False sa-account1 account1 1 Viewer 0
顯示服務帳戶詳細數據
az grafana service-account show
執行 命令以取得服務帳戶的詳細數據。 將 <azure-managed-grafana-name>
和 <service-account-name>
取代為您的個人資訊。
az grafana service-account show --name <azure-managed-grafana-name> --service-account <service-account-name>
新增服務帳戶令牌並檢閱令牌
建立服務帳戶之後,請新增一或多個存取令牌。 存取令牌是用來向 Grafana API 進行驗證的字串。
若要建立服務帳戶令牌,請選取 [新增令牌]。
使用自動產生的 [顯示名稱 ] 或輸入您選擇的名稱,並選擇性地選取 [到期日 ] 或保留預設選項來設定沒有到期日。
選取 [ 產生令牌],並記下產生的令牌。 此令牌只會顯示一次,因此請務必儲存它,因為不需要建立新的令牌。
選取服務帳戶以存取服務帳戶的相關信息,包括所有相關聯的令牌清單。
建立新的令牌
使用 az grafana service-account token create
建立 Grafana 服務帳戶令牌。 將佔位元 <azure-managed-grafana-name>
取代 <service-account-name>
<token-name>
為 您自己的資訊。
選擇性地設定到期時間:
參數 |
描述 |
範例 |
--time-to-live |
根據預設,令牌具有無限制的到期日。 設定到期時間,以在指定時間之後停用令牌。 使用 s 秒、 m 分鐘 h 、小時、 d 天、 w 周、 M 月或 y 年。 |
15d |
az grafana service-account token create --name <azure-managed-grafana-name> --service-account <service-account-name> --token <token-name> --time-to-live 15d
記下產生的令牌。 此令牌只會顯示一次,因此請務必儲存它,因為不需要建立新的令牌。
列出服務帳戶令牌
az grafana service-account token list
執行 命令以取得屬於指定服務帳戶的所有令牌清單。 將佔位元 <azure-managed-grafana-name>
取代為 <service-account-name>
您自己的資訊。
az grafana service-account token list --name <azure-managed-grafana-name> --service-account <service-account-name> --output table
輸出範例:
Created Expiration HasExpired Name SecondsUntilExpiration
-------------------- -------------------- ------------ ------ ------------------------
2022-12-07T11:40:45Z 2022-12-08T11:40:45Z False token1 85890.870731556
2022-12-07T11:42:35Z 2022-12-22T11:42:35Z False token2 0
編輯服務帳戶
在本節中,瞭解如何以下列方式更新 Grafana 服務帳戶:
- 編輯服務帳戶的名稱
- 編輯服務帳戶的角色
- 停用服務帳戶
- 啟用服務帳戶
動作:
- 若要編輯名稱,請選取服務帳戶,然後在 [資訊] 底下選取 [編輯]。
- 若要編輯角色,請選取服務帳戶,然後在 [資訊] 底下選取角色,然後選擇另一個角色名稱。
- 若要停用服務帳戶,請選取服務帳戶,然後在頁面頂端選取 [停用服務帳戶],然後選取 [停用服務帳戶] 以確認。 您可以選取 [啟用服務帳戶] 來重新啟用停用的服務帳戶。
通知服務帳戶會立即顯示。
使用 az grafana service-account update
編輯服務帳戶。 將佔位元 <azure-managed-grafana-name>
取代為 您自己的資訊, <service-account-name>
並使用下列其中一或多個參數:
參數 |
描述 |
--is-disabled |
輸入 --is-disabled true 停用服務帳戶,或 --is-disabled false 啟用服務帳戶。 |
--name |
輸入服務帳戶的另一個名稱。 |
--role |
輸入服務帳戶的另一個角色。 可用的角色: Admin 、 Editor 、 Viewer 。 |
az grafana service-account update --name <azure-managed-grafana-name> --service-account <service-account-name> --role <role> --enabled false
若要停用服務帳戶,請 az grafana update
執行 命令,並使用 選項 --is-disabled true
。 若要啟用服務帳戶,請使用 --is-disabled false
。
az grafana update --service-account Disabled --name <service-account-name>
刪除服務帳戶
若要刪除 Grafana 服務帳戶,請選取服務帳戶,然後在頁面頂端選取 [刪除服務帳戶],然後選取 [刪除服務帳戶] 以確認。 刪除服務帳戶是最終的,一旦刪除之後,就無法復原服務帳戶。
若要刪除服務帳戶,請執行 az grafana service-account delete
命令。 將佔位元 <azure-managed-grafana-name>
取代為 <service-account-name>
您自己的資訊。
az grafana service-account delete --name <azure-managed-grafana-name> --service-account <service-account-name>
刪除服務帳戶令牌
若要刪除服務帳戶令牌,請選取服務帳戶,然後在 [令牌] 底下選取 [刪除](x)。 請選取刪除,確認刪除。
若要刪除服務帳戶,請執行 az grafana service-account token delete
命令。 將佔位元 <azure-managed-grafana-name>
取代 <service-account-name>
<token-name>
為 您自己的資訊。
az grafana service-account token delete --name <azure-managed-grafana-name> --service-account <service-account-name> --toke <token-name>
下一步
在本操作指南中,您已瞭解如何建立和管理服務帳戶和令牌,以在 Azure Managed Grafana 中執行自動化作業。 當您準備好時,請探索更多文章: