az monitor pipeline-group

参考

注释

此参考是 Azure CLI 的 monitor-pipeline-group 扩展（版本 2.61.0 或更高版本）的一部分。该扩展会在首次运行 az monitor pipeline-group 命令时自动安装。了解更多关于扩展的相关信息。

管理管道组。

命令

名称	说明	类型	Status
az monitor pipeline-group create	创建管道组实例。	扩展	GA
az monitor pipeline-group delete	删除管道组实例。	扩展	GA
az monitor pipeline-group list	列出指定订阅中的所有工作区。	扩展	GA
az monitor pipeline-group show	获取特定的管道组实例。	扩展	GA
az monitor pipeline-group update	更新管道组实例。	扩展	GA
az monitor pipeline-group wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az monitor pipeline-group create

创建管道组实例。

az monitor pipeline-group create --name --pipeline-group-name
                                 --resource-group
                                 [--exporters]
                                 [--extended-___location]
                                 [--___location]
                                 [--network-config]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--processors]
                                 [--receivers]
                                 [--replicas]
                                 [--service]
                                 [--tags]

示例

使用 UDP 接收器创建 PipelineGroup 实例

az monitor pipeline-group create --resource-group myResourceGroup --pipeline-group-name plGroup1 --___location eastus2 --extended-___location "{name:/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/microsoft.extendedlocation/customlocations/myTestCustomLocation,type:CustomLocation}" --tags "{tag1:A,tag2:B}" --receivers "[{type:UDP,name:udp-receiver1,udp:{endpoint:'0.0.0.0:518',encoding:utf-8}}]" --processors "[]" --exporters "[{type:AzureMonitorWorkspaceLogs,name:my-workspace-logs-exporter1,azure-monitor-workspace-logs:{api:{data-collection-endpoint-url:'https://logs-myingestion-eb0s.eastus-1.ingest.monitor.azure.com',stream:Custom-MyTableRawData_CL,data-collection-rule:dcr-00000000000000000000000000000000,schema:{record-map:[{from:body,to:Body},{from:severity_text,to:SeverityText},{from:time_unix_nano,to:TimeGenerated}]}},concurrency:{worker-count:4,batch-queue-size:100}}}]" --service "{pipelines:[{name:MyPipelineForLogs1,type:logs,receivers:[udp-receiver1],processors:[],exporters:[my-workspace-logs-exporter1]}]}"

必需参数

--name --pipeline-group-name -n

管道组的名称。名称不区分大小写。

--resource-group -g

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

可选参数

--exporters

为管道组实例指定的导出程序。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--extended-___location

给定管道组的扩展位置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--___location -l

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

--network-config

管道组实例的网络配置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

不等待长时间运行的操作完成。

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

--processors

为管道组实例指定的处理器。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--receivers

为管道组实例指定的接收方。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--replicas

定义管道组实例的副本量。

--service

给定管道组实例的服务节。支持速记语法、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 pipeline-group delete

删除管道组实例。

az monitor pipeline-group delete [--ids]
                                 [--name --pipeline-group-name]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

可选参数

--ids

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

--name --pipeline-group-name -n

管道组的名称。名称不区分大小写。

--no-wait

不等待长时间运行的操作完成。

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

--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 pipeline-group list

列出指定订阅中的所有工作区。

az monitor pipeline-group list [--max-items]
                               [--next-token]
                               [--resource-group]

可选参数

--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 pipeline-group show

获取特定的管道组实例。

az monitor pipeline-group show [--ids]
                               [--name --pipeline-group-name]
                               [--resource-group]
                               [--subscription]

可选参数

--ids

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

--name --pipeline-group-name -n

管道组的名称。名称不区分大小写。

--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 pipeline-group update

更新管道组实例。

az monitor pipeline-group update [--add]
                                 [--exporters]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--ids]
                                 [--name --pipeline-group-name]
                                 [--network-config]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--processors]
                                 [--receivers]
                                 [--remove]
                                 [--replicas]
                                 [--resource-group]
                                 [--service]
                                 [--set]
                                 [--subscription]
                                 [--tags]

示例

更新管道组实例

az monitor pipeline-group update --resource-group myResourceGroup --pipeline-group-name plGroup1 --receivers "[{type:UDP,name:udp-receiver1,udp:{endpoint:'0.0.0.0:518',encoding:utf-8}}]" --processors "[]" --exporters "[{type:AzureMonitorWorkspaceLogs,name:my-workspace-logs-exporter1,azure-monitor-workspace-logs:{api:{data-collection-endpoint-url:'https://logs-myingestion-eb0s.eastus-1.ingest.monitor.azure.com',stream:Custom-MyTableRawData_CL,data-collection-rule:dcr-00000000000000000000000000000000,schema:{record-map:[{from:body,to:Body},{from:severity_text,to:SeverityText},{from:time_unix_nano,to:TimeGenerated}]}},concurrency:{worker-count:4,batch-queue-size:100}}}]" --service "{pipelines:[{name:MyPipelineForLogs1,type:logs,receivers:[udp-receiver1],processors:[],exporters:[my-workspace-logs-exporter1]}]}"

可选参数

--add

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

--exporters

为管道组实例指定的导出程序。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--force-string

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

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

--ids

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

--name --pipeline-group-name -n

管道组的名称。名称不区分大小写。

--network-config

管道组实例的网络配置。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--no-wait

不等待长时间运行的操作完成。

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

--processors

为管道组实例指定的处理器。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--receivers

为管道组实例指定的接收方。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--remove

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

--replicas

定义管道组实例的副本量。

--resource-group -g

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

--service

给定管道组实例的服务节。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--set

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

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_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 pipeline-group wait

将 CLI 置于等待状态，直到满足条件。

az monitor pipeline-group wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name --pipeline-group-name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name --pipeline-group-name -n

管道组的名称。名称不区分大小写。

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: 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 获取完整的调试日志。