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

az monitor data-collection rule

注意

此参考是 Azure CLI(版本 2.57.0 或更高版本)的 monitor-control-service 扩展的一部分。 该扩展将在首次运行 az monitor 数据收集规则 命令时自动安装。 详细了解扩展。

管理监视控制服务的数据收集规则。

命令

名称 说明 类型 状态
az monitor data-collection rule association

管理监视控制服务的数据收集规则关联。

扩展 GA
az monitor data-collection rule association create

创建关联。

扩展 GA
az monitor data-collection rule association delete

删除关联。

扩展 GA
az monitor data-collection rule association list

列出指定数据收集规则的关联。 并列出指定数据收集终结点的关联。 并列出指定资源的关联。

扩展 GA
az monitor data-collection rule association list-by-resource

列出指定资源的关联。

扩展 GA
az monitor data-collection rule association show

获取指定的关联。

扩展 GA
az monitor data-collection rule association update

更新关联。

扩展 GA
az monitor data-collection rule create

创建数据收集规则。

扩展 GA
az monitor data-collection rule data-flow

管理数据流。

扩展 GA
az monitor data-collection rule data-flow add

添加数据流。

扩展 GA
az monitor data-collection rule data-flow list

列出数据流。

扩展 GA
az monitor data-collection rule delete

删除数据收集规则。

扩展 GA
az monitor data-collection rule list

列出指定资源组中的所有数据收集规则。 并列出指定订阅中的所有数据收集规则。

扩展 GA
az monitor data-collection rule log-analytics

管理 Log Analytics 目标。

扩展 GA
az monitor data-collection rule log-analytics add

添加数据收集规则的 Log Analytics 目标。

扩展 GA
az monitor data-collection rule log-analytics delete

删除数据收集规则的 Log Analytics 目标。

扩展 GA
az monitor data-collection rule log-analytics list

列出数据收集规则的 Log Analytics 目标。

扩展 GA
az monitor data-collection rule log-analytics show

显示数据收集规则的 Log Analytics 目标。

扩展 GA
az monitor data-collection rule log-analytics update

更新数据收集规则的 Log Analytics 目标。

扩展 GA
az monitor data-collection rule performance-counter

管理日志性能计数器数据源。

扩展 GA
az monitor data-collection rule performance-counter add

添加日志性能计数器数据源。

扩展 GA
az monitor data-collection rule performance-counter delete

删除日志性能计数器数据源。

扩展 GA
az monitor data-collection rule performance-counter list

列出日志性能计数器数据源。

扩展 GA
az monitor data-collection rule performance-counter show

显示日志性能计数器数据源。

扩展 GA
az monitor data-collection rule performance-counter update

更新日志性能计数器数据源。

扩展 GA
az monitor data-collection rule show

返回指定的数据收集规则。

扩展 GA
az monitor data-collection rule syslog

管理 Syslog 数据源。

扩展 GA
az monitor data-collection rule syslog add

添加 Syslog 数据源。

扩展 GA
az monitor data-collection rule syslog delete

删除 Syslog 数据源。

扩展 GA
az monitor data-collection rule syslog list

列出 Syslog 数据源。

扩展 GA
az monitor data-collection rule syslog show

显示 Syslog 数据源。

扩展 GA
az monitor data-collection rule syslog update

更新 Syslog 数据源。

扩展 GA
az monitor data-collection rule update

更新数据收集规则。

扩展 GA
az monitor data-collection rule windows-event-log

管理 Windows 事件日志数据源。

扩展 GA
az monitor data-collection rule windows-event-log add

添加 Windows 事件日志数据源。

扩展 GA
az monitor data-collection rule windows-event-log delete

删除 Windows 事件日志数据源。

扩展 GA
az monitor data-collection rule windows-event-log list

列出 Windows 事件日志数据源。

扩展 GA
az monitor data-collection rule windows-event-log show

显示 Windows 事件日志数据源。

扩展 GA
az monitor data-collection rule windows-event-log update

更新 Windows 事件日志数据源。

扩展 GA

az monitor data-collection rule create

创建数据收集规则。

az monitor data-collection rule create --data-collection-rule-name
                                       --resource-group
                                       [--data-collection-endpoint-id]
                                       [--data-flows]
                                       [--data-sources]
                                       [--description]
                                       [--destinations]
                                       [--identity]
                                       [--kind]
                                       [--location]
                                       [--rule-file]
                                       [--stream-declarations]
                                       [--tags]

示例

创建数据收集规则

az monitor data-collection rule create --resource-group "myResourceGroup" --location "eastus" --name "myCollectionRule" --rule-file "C:\samples\dcrEx1.json"

必需参数

--data-collection-rule-name --name --rule-name -n

数据收集规则的名称。 此名称不区分大小写。

--resource-group -g

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

可选参数

--data-collection-endpoint-id --endpoint-id

要关联的数据收集终结点的资源 ID。

--data-flows

数据流的规范。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--data-sources

数据源的规范。 此属性是可选的,如果规则旨在通过对预配的终结点的直接调用使用,则可以省略此属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--description

关联的说明。

--destinations

目标的规范。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--identity

资源的托管服务标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--kind

资源的种类。 例如LinuxWindows

--location -l

资源所在的地理位置。

--rule-file

规则参数的 json 文件。 如果提供,则规则文件使用情况中的值将覆盖相应的参数:--rule-file sample.json规则 json 文件应是按 json 格式组织的规则参数, 例如: { “properties”: { “destinations”: { “azureMonitorMetrics”: { “name”: “azureMonitorMetrics-default” } }, “dataFlows”: [ { “streams”: [ “Microsoft-InsightsMetrics” ], “destinations”: [ “azureMonitorMetrics-default” ] } } } } 。

--stream-declarations

此规则中使用的自定义流的声明。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--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 data-collection rule delete

删除数据收集规则。

az monitor data-collection rule delete [--data-collection-rule-name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--yes]

示例

删除数据收集规则

az monitor data-collection rule delete --name "myCollectionRule" --resource-group "myResourceGroup"

可选参数

--data-collection-rule-name --name --rule-name -n

数据收集规则的名称。 此名称不区分大小写。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource 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 data-collection rule list

列出指定资源组中的所有数据收集规则。 并列出指定订阅中的所有数据收集规则。

az monitor data-collection rule list [--max-items]
                                     [--next-token]
                                     [--resource-group]

示例

按资源组列出数据收集规则

az monitor data-collection rule list --resource-group "myResourceGroup"

按订阅列出数据收集规则

az monitor data-collection rule list

可选参数

--max-items

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

--next-token

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

--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 monitor data-collection rule show

返回指定的数据收集规则。

az monitor data-collection rule show [--data-collection-rule-name]
                                     [--ids]
                                     [--resource-group]
                                     [--subscription]

示例

获取数据收集规则

az monitor data-collection rule show --name "myCollectionRule" --resource-group "myResourceGroup"

可选参数

--data-collection-rule-name --name --rule-name -n

数据收集规则的名称。 此名称不区分大小写。

--ids

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

--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 data-collection rule update

更新数据收集规则。

az monitor data-collection rule update [--add]
                                       [--data-collection-endpoint-id]
                                       [--data-collection-rule-name]
                                       [--data-flows]
                                       [--data-flows-raw]
                                       [--data-sources]
                                       [--description]
                                       [--destinations]
                                       [--extensions]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--identity]
                                       [--ids]
                                       [--kind]
                                       [--log-analytics]
                                       [--monitor-metrics]
                                       [--performance-counters]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--stream-declarations]
                                       [--subscription]
                                       [--syslog]
                                       [--tags]
                                       [--windows-event-logs]

示例

更新数据收集规则

az monitor data-collection rule update --resource-group "myResourceGroup" --name "myCollectionRule" --data-flows destinations="centralWorkspace" streams="Microsoft-Perf" streams="Microsoft-Syslog" streams="Microsoft-WindowsEvent" --log-analytics name="centralWorkspace" resource-id="/subscriptions/703362b3-f278-4e4b-9179- c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspac es/centralTeamWorkspace" --performance-counters name="appTeamExtraCounters" counter- specifiers="\Process(_Total)\Thread Count" sampling-frequency=30 streams="Microsoft-Perf" --syslog name="cronSyslog" facility-names="cron" log-levels="Debug" log-levels="Critical" log-levels="Emergency" streams="Microsoft-Syslog" --windows-event-logs name="cloudSecurityTeamEvents" streams="Microsoft-WindowsEvent" x-path-queries="Security!"

可选参数

--add

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

--data-collection-endpoint-id --endpoint-id

要关联的数据收集终结点的资源 ID。

--data-collection-rule-name --name --rule-name -n

数据收集规则的名称。 此名称不区分大小写。

--data-flows --data-flows-remain

数据流的规范。 用法:--data-flow streams=XX1 streams=XX2 destinations=XX1 destinations=XX2 streams:必需。 此数据流的流列表。 目标:必需。 此数据流的目标列表。 可以使用多个 --data-flow 参数指定多个操作。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--data-flows-raw

数据流的规范。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--data-sources

数据源的规范。 此属性是可选的,如果规则旨在通过对预配的终结点的直接调用使用,则可以省略此属性。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--description

关联的说明。

--destinations

目标的规范。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--extensions

Azure VM 扩展数据源配置的列表。 预期值:json-string/@json-file。

--force-string

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

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

资源的托管服务标识。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--ids

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

--kind

资源的种类。 例如LinuxWindows

--log-analytics

Log Analytics 目标列表。 用法:--log-analytics resource-id=XX name=XX resource-id:必需。 Log Analytics 工作区的资源 ID。 名称:必需。 目标的友好名称。 此名称应在数据收集规则中的所有目标(无论类型是什么)中是唯一的。 可以使用多个 --log-analytics 参数指定多个操作。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--monitor-metrics

Azure Monitor 指标目标。 用法:--monitor-metrics name=XX name:必需。 目标的友好名称。 此名称应在数据收集规则中的所有目标(无论类型是什么)中是唯一的。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--performance-counters

性能计数器数据源配置的列表。 用法:--performance-counters streams=XX1 streams=XX2 sampling-frequency=XX counter-specifiers=XX1 counter-specifiers=XX2 name=XX streams: Required. 此数据源将发送到的流列表。 流指示将用于此数据的架构,以及 Log Analytics 中要发送到的数据的表。采样频率:必需。 连续计数器度量(样本)之间的秒数。 counter-specifiers:必需。 要收集的性能计数器说明符名称的列表。 使用 wild卡 \ 为所有实例收集计数器。 若要获取 Windows 上的性能计数器列表,请运行命令“typeperf”。 名称:必需。 数据源的友好名称。 此名称应在数据收集规则中的所有数据源(无论类型)中是唯一的。 可以使用多个 --performance-counters 参数指定多个操作。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--remove

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

--resource-group -g

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

--set

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

--stream-declarations

此规则中使用的自定义流的声明。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--subscription

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

--syslog

Syslog 数据源配置的列表。 用法:--syslog streams=XX1 streams=XX2 facility-names=XX1 facility-names=XX2 log-levels=XX1 log-levels=XX2 name=XX streams: Required. 此数据源将发送到的流列表。 流指示将用于此数据的架构,以及 Log Analytics 中要发送到的数据的表。设施名称:必需。 设施名称的列表。 日志级别:要收集的日志级别。 名称:必需。 数据源的友好名称。 此名称应在数据收集规则中的所有数据源(无论类型)中是唯一的。 可以使用多个 --syslog 参数指定多个操作。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--tags

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

--windows-event-logs

Windows 事件日志数据源配置的列表。 用法:--windows-event-logs streams=XX1 streams=XX2 x-path-queries=XX1 x-path-queries=XX2 name=XX streams: 必需。 此数据源将发送到的流列表。 流指示将用于此数据的架构,以及 Log Analytics 中要发送到的数据的表。x-path-queries:必需。 XPATH 格式的 Windows 事件日志查询列表。 名称:必需。 数据源的友好名称。 此名称应在数据收集规则中的所有数据源(无论类型)中是唯一的。 可以使用多个 --windows-event-logs 参数指定多个操作。 支持速记语法、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 获取完整的调试日志。