你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az grafana api-key

  • 参考

注意

此参考是 Azure CLI（版本 2.38.0 或更高版本）的 amg 扩展的一部分。 该扩展将在首次运行 az grafana api-key 命令时自动安装。 详细了解扩展。

用于管理 API 密钥的命令。

命令

名称 说明 类型 状态
az grafana api-key create

创建新的 API 密钥。

 扩展 GA
az grafana api-key delete

删除 API 密钥。

 扩展 GA
az grafana api-key list

列出现有 API 密钥。

 扩展 GA

az grafana api-key create

创建新的 API 密钥。

az grafana api-key create --key
                          --name
                          [--resource-group]
                          [--role {Admin, Editor, Viewer}]
                          [--time-to-live]

必需参数

--key

Api 密钥名称。

--name -n

Azure 托管 Grafana 的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--role -r

Grafana 角色名称。

接受的值: Admin, Editor, Viewer
默认值: Viewer
--time-to-live

API 密钥生存期。 例如，如果密钥将持续一天，则为 1d。 支持的单位为：s、m、h、d、w、M、y。

默认值: 1d
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana api-key delete

删除 API 密钥。

az grafana api-key delete --key
                          --name
                          [--resource-group]

必需参数

--key

标识要删除的 API 密钥的 ID 或名称。

--name -n

Azure 托管 Grafana 的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana api-key list

列出现有 API 密钥。

az grafana api-key list --name
                        [--resource-group]

必需参数

--name -n

Azure 托管 Grafana 的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。