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

az monitor app-insights api-key

  • 参考

注意

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

对与 Application Insights 组件关联的 API 密钥的操作。

命令

名称 说明 类型 状态
az monitor app-insights api-key create

创建 Application Insights 组件的 API 密钥。

 扩展 GA
az monitor app-insights api-key delete

从 Application Insights 资源中删除 API 密钥。

 扩展 GA
az monitor app-insights api-key show

获取与 Application Insights 资源关联的所有密钥或特定 API 密钥。

 扩展 GA

az monitor app-insights api-key create

创建 Application Insights 组件的 API 密钥。

az monitor app-insights api-key create --api-key
                                       --app
                                       --resource-group
                                       [--read-properties]
                                       [--write-properties]

示例

创建具有类型 Web 和位置的组件。

az monitor app-insights api-key create --api-key cli-demo --read-properties ReadTelemetry --write-properties WriteAnnotations -g demoRg --app testApp

在没有任何权限的情况下创建具有类型 Web 和位置的组件

az monitor app-insights api-key create --api-key cli-demo --read-properties '""' --write-properties '""' -g demoRg --app testApp

必需参数

--api-key

要创建的 API 密钥的名称。

--app -a

Application Insights 组件的 GUID、应用名称或完全限定的 Azure 资源名称。 可以从Azure 门户中任何 Application Insights 资源上的 API 访问菜单项获取应用程序 GUID。 如果使用应用程序名称，请指定资源组。

--resource-group -g

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

可选参数

--read-properties

要继承的此 API 密钥的读取角色名称的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--write-properties

要继承的此 API 密钥的写入角色名称的空格分隔列表。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

全局参数
--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 monitor app-insights api-key delete

从 Application Insights 资源中删除 API 密钥。

az monitor app-insights api-key delete [--api-key]
                                       [--app]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

示例

删除 API 密钥。

az monitor app-insights api-key delete --app demoApp -g demoRg --api-key demo-key

可选参数

--api-key

要删除的 API 密钥的名称。 可以使用 api-key show.

--app -a

Application Insights 组件的 GUID、应用名称或完全限定的 Azure 资源名称。 可以从Azure 门户中任何 Application Insights 资源上的 API 访问菜单项获取应用程序 GUID。 如果使用应用程序名称，请指定资源组。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False
全局参数
--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 monitor app-insights api-key show

获取与 Application Insights 资源关联的所有密钥或特定 API 密钥。

az monitor app-insights api-key show --app
                                     --resource-group
                                     [--api-key]

示例

提取 API 密钥。

az monitor app-insights api-key show --app demoApp -g demoRg --api-key demo-key

提取 API 密钥。

az monitor app-insights api-key show --app demoApp -g demoRg

必需参数

--app -a

Application Insights 组件资源的名称。

--resource-group -g

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

可选参数

--api-key

要提取的 API 密钥的名称。 可以使用 api-key show.

全局参数
--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 获取完整的调试日志。