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

az monitor app-insights workbook

参考

注意

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

管理 app-insights 工作簿。

命令

名称	说明	类型	状态
az monitor app-insights workbook create	创建工作簿。	扩展	GA
az monitor app-insights workbook delete	删除工作簿。	扩展	GA
az monitor app-insights workbook identity	管理工作簿 idneity。	扩展	GA
az monitor app-insights workbook identity assign	分配标识。	扩展	GA
az monitor app-insights workbook identity remove	删除标识。	扩展	GA
az monitor app-insights workbook list	列出在指定资源组和类别中定义的所有工作簿。	扩展	GA
az monitor app-insights workbook revision	管理工作簿修订。	扩展	GA
az monitor app-insights workbook revision list	列出工作簿的修订。	扩展	GA
az monitor app-insights workbook revision show	显示工作簿修订。	扩展	GA
az monitor app-insights workbook show	按其资源名称显示单个工作簿。	扩展	GA
az monitor app-insights workbook update	更新工作簿。	扩展	GA

az monitor app-insights workbook create

创建工作簿。

az monitor app-insights workbook create --name
                                        --resource-group
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--kind {shared}]
                                        [--location]
                                        [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--mi-user-assigned]
                                        [--serialized-data]
                                        [--source-id]
                                        [--storage-uri]
                                        [--tags]
                                        [--version]

示例

创建工作簿

az monitor app-insights workbook create -n 00000000-0000-0000-0000-000000000000 -g rg --serialized-data mydata --kind shared --category workbook  --display-name workbookname

必需参数

--name --resource-name -n

工作簿资源的名称。该值必须是 UUID。

--resource-group -g

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

可选参数

--category

工作簿类别，在创建时由用户定义。

--description

工作簿的说明。

--display-name

工作簿的用户定义名称（显示名称）。

--kind

工作簿的类型。仅共享有效值。

接受的值: shared

--location -l

未指定资源所在的地理位置，将使用资源组的位置。

--mi-system-assigned

启用系统分配的标识。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--mi-user-assigned

用空格分隔的资源 ID 添加用户分配的标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--serialized-data

此特定工作簿的配置。配置数据是包含有效 JSON 的字符串。

--source-id

将提取所有链接工作簿的 Azure 资源 ID。

--storage-uri

使用自带存储时，存储帐户的 resourceId。

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--version

工作簿架构版本格式，如“Notebook/1.0”，它应与 serializedData 中的工作簿匹配。

全局参数

--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 workbook delete

删除工作簿。

az monitor app-insights workbook delete [--ids]
                                        [--name]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]

示例

删除工作簿

az monitor app-insights workbook delete -n 00000000-0000-0000-0000-000000000000 -g wktest

可选参数

--ids

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

--name --resource-name -n

工作簿资源的名称。该值必须是 UUID。

--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 workbook list

列出在指定资源组和类别中定义的所有工作簿。

az monitor app-insights workbook list --category {TSG, performance, retention, workbook}
                                      [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--max-items]
                                      [--next-token]
                                      [--resource-group]
                                      [--source-id]
                                      [--tags]

示例

列出工作簿

az monitor app-insights workbook list -g rg --category workbook

必需参数

--category

要返回的工作簿类别。

接受的值: TSG, performance, retention, workbook

可选参数

--can-fetch-content

指示是否返回每个适用工作簿的完整内容的标志。如果为 false，则仅返回工作簿的摘要内容。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

--resource-group -g

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

--source-id

将提取所有链接工作簿的 Azure 资源 ID。

--tags

标记显示在返回的每个工作簿上。支持速记语法、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 workbook show

按其资源名称显示单个工作簿。

az monitor app-insights workbook show [--can-fetch-content {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

示例

显示工作簿

az monitor app-insights workbook show -n 00000000-0000-0000-0000-000000000000 -g wktest

可选参数

--can-fetch-content

指示是否返回每个适用工作簿的完整内容的标志。如果为 false，则仅返回工作簿的摘要内容。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--name --resource-name -n

工作簿资源的名称。该值必须是 UUID。

--resource-group -g

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

--subscription

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

全局参数

--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 workbook update

更新工作簿。

az monitor app-insights workbook update [--add]
                                        [--category]
                                        [--description]
                                        [--display-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--kind {shared}]
                                        [--name]
                                        [--remove]
                                        [--resource-group]
                                        [--serialized-data]
                                        [--set]
                                        [--source-id]
                                        [--storage-uri]
                                        [--subscription]
                                        [--tags]
                                        [--version]

示例

更新工作簿

az monitor app-insights workbook update -n 00000000-0000-0000-0000-000000000000 -g rg --tags tag=test

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--category

工作簿类别，在创建时由用户定义。

--description

工作簿的说明。

--display-name

工作簿的用户定义名称（显示名称）。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--kind

工作簿的类型。仅共享有效值。

接受的值: shared

--name --resource-name -n

工作簿资源的名称。该值必须是 UUID。

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--serialized-data

此特定工作簿的配置。配置数据是包含有效 JSON 的字符串。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--source-id

将提取所有链接工作簿的 Azure 资源 ID。

--storage-uri

使用自带存储时，存储帐户的 resourceId。

--subscription

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

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--version

工作簿架构版本格式，如“Notebook/1.0”，它应与 serializedData 中的工作簿匹配。

全局参数

--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 workbook

命令

az monitor app-insights workbook create

示例

必需参数

可选参数

az monitor app-insights workbook delete

示例

可选参数

az monitor app-insights workbook list

示例

必需参数

可选参数

az monitor app-insights workbook show

示例

可选参数

az monitor app-insights workbook update

示例

可选参数

其他资源