你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
在 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 和其他服务之间创建集成。
先决条件
- 具有活动订阅的 Azure 帐户。 免费创建帐户。
- Azure 托管 Grafana 实例。 如果还没有，请创建一个 Azure 托管 Grafana 实例。
启用 API 密钥
默认在 Azure Managed Grafana 中禁用 API 密钥。 可以在通过 Azure 门户创建实例期间启用此功能，也可以通过 Azure 门户或 CLI 在现有实例上激活此功能。
创建一个启用了 API 密钥创建功能的 Azure 托管 Grafana 工作区
在创建 Azure 托管 Grafana 工作区期间，通过将“启用 API 密钥创建功能”设置为“启用”，在“高级”选项卡中启用 API 密钥创建功能。 若要详细了解如何使用 Azure 门户创建新实例，请转到快速入门：创建 Azure 托管 Grafana 实例。
在现有 Azure 托管 Grafana 实例上启用 API 密钥创建功能
在 Azure 门户中的“设置”下选择“配置”，然后在“API 密钥”下选择“启用”。
选择“保存”以确认你要激活在 Azure 托管 Grafana 中创建 API 密钥的功能。
生成 API 密钥
打开 Azure 托管 Grafana 实例，然后从左侧菜单中选择“配置”>“API 密钥”。
选择“新建 API 密钥”。
填写表单，然后选择“添加”以生成新的 API 密钥。
参数 说明 示例 密钥名称 输入新 Grafana API 密钥的名称。 api-key-1 Microsoft 托管 Grafana 选择托管 Grafana 角色：查看者、编辑者或管理员。 编辑器 生存时间 输入 API 密钥过期之前的时间。 使用 s 表示秒，m 表示分钟，h 表示小时，d 表示天，w 表示周，M 表示月，y 表示年。 7d 
生成密钥后，会弹出一条消息，其中包含新密钥和 curl 命令（包含你的密钥）。 现在复制此信息并将其保存到记录中，因为离开此页面后将隐藏此信息。 如果在未保存新 API 密钥的情况下关闭此页面，则需要生成一个新密钥。
现在可以使用此 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 密钥。
后续步骤
本操作指南介绍了如何为 Azure 托管 Grafana 创建 API 密钥。 准备就绪后，开始使用服务帐户作为新方法对与 Grafana 交互的应用程序进行身份验证：