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

az iot ops dataflowgraph

注释

此参考是Azure CLI的 azure-iot-ops 扩展的一部分（版本 2.70.0 或更高版本）。 该扩展将在首次运行 az iot ops dataflowgraph 命令时自动安装。 了解更多关于扩展程序的信息。

DataflowGraph 管理。

命令

名称 说明 类型 Status
az iot ops dataflowgraph apply

创建或替换与数据流配置文件关联的 DataflowGraph。

 扩展 GA
az iot ops dataflowgraph delete

删除与数据流配置文件关联的 DataflowGraph。

 扩展 GA
az iot ops dataflowgraph list

列出与数据流配置文件关联的数据流图。

 扩展 GA
az iot ops dataflowgraph show

显示与数据流配置文件关联的数据流图的详细信息。

 扩展 GA

az iot ops dataflowgraph apply

创建或替换与数据流配置文件关联的 DataflowGraph。

配置文件格式的示例如下所示：

{
  "mode": "Enabled",
  "nodes": [
    {
      "name": "source-mqtt",
      "nodeType": "Source",
      "sourceSettings": {
        "endpointRef": "default-broker",
        "dataSources": ["sensors/temperature/#"]
      }
    },
    {
      "name": "dest-broker",
      "nodeType": "Destination",
      "destinationSettings": {
        "endpointRef": "my-kafka-endpoint",
        "dataDestination": "telemetry/temperature"
      }
    },
    {
      "name": "dest-otel",
      "nodeType": "Destination",
      "destinationSettings": {
        "endpointRef": "my-otel-endpoint",
        "dataDestination": "telemetry/all"
      }
    },
    {
      "name": "graph-processor",
      "nodeType": "Graph",
      "graphSettings": {
        "registryEndpointRef": "my-registry-endpoint",
        "artifact": "my-processing-module:1.0.0",
        "configuration": [
          { "key": "paramName", "value": "paramValue" },
          { "key": "anotherParam", "value": "anotherValue" }
        ]
      }
    }
  ],
  "nodeConnections": [
    { "from": { "name": "source-mqtt" }, "to": { "name": "graph-processor" } },
    { "from": { "name": "graph-processor" }, "to": { "name": "dest-broker" } },
    { "from": { "name": "graph-processor" }, "to": { "name": "dest-otel" } }
  ]
}

上面的示例定义了一个图形，其中 MQTT 源流经一个图形处理节点，该节点流向 Kafka 目标和 OpenTelemetry 目标。 图形节点从注册表终结点引用项目（格式： <name>:<version>） 。 上面的示例仅包括 graphSettings.configuration，以说明项目需要配置参数时的格式;在这种情况下，请将它们作为 {“key”， “value”} 字符串对的列表提供。 完全省略 graphSettings.configuration（无需配置）。 支持的 nodeType 包括：源、目标和图形。 数据流图仅支持 MQTT、Kafka 和 OpenTelemetry 终结点。 该文件也可以是完整的 ARM 资源包装器（属性是自动提取的）。 extendedLocation 始终从 --instance 和 -g 自动填充，并且不得包含在文件中。

与应用上述内容一起使用时，将创建或替换目标 DataflowGraph 资源。

az iot ops dataflowgraph apply --config-file
                               --instance
                               --name
                               --resource-group
                               [--acquire-policy-token]
                               [--change-reference]
                               [--profile]

示例

使用配置文件创建或替换与配置文件“myprofile”关联的数据流图“mygraph”。

az iot ops dataflowgraph apply -n mygraph -p myprofile -i myinstance -g myresourcegroup --config-file /path/to/graph/config.json

必需参数

--config-file

包含数据流属性的 JSON 文件的路径。

属性 值
参数组: Config Arguments
--instance -i

IoT 操作实例名称。

--name -n

DataflowGraph 名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--profile -p

数据流配置文件名称。 默认值：“default”。

属性 值
默认值: default
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az iot ops dataflowgraph delete

删除与数据流配置文件关联的 DataflowGraph。

az iot ops dataflowgraph delete --instance
                                --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--profile]
                                [--yes {false, true}]

示例

删除与配置文件“myprofile”关联的数据流图“mygraph”。

az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup

在不出现确认提示的情况下删除数据流图“mygraph”。

az iot ops dataflowgraph delete -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup -y

必需参数

--instance -i

IoT 操作实例名称。

--name -n

DataflowGraph 名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--acquire-policy-token

为此资源操作自动获取Azure Policy令牌。

属性 值
参数组: Global Policy Arguments
--change-reference

此资源操作的相关更改引用 ID。

属性 值
参数组: Global Policy Arguments
--profile -p

数据流配置文件名称。 默认值：“default”。

属性 值
默认值: default
--yes -y

在没有提示的情况下确认 [y]es。 适用于 CI 和自动化方案。

属性 值
接受的值: false, true
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az iot ops dataflowgraph list

列出与数据流配置文件关联的数据流图。

az iot ops dataflowgraph list --instance
                              --resource-group
                              [--profile]

示例

枚举与配置文件“myprofile”关联的数据流图。

az iot ops dataflowgraph list -p myprofile -i mycluster-ops-instance -g myresourcegroup

必需参数

--instance -i

IoT 操作实例名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--profile -p

数据流配置文件名称。 默认值：“default”。

属性 值
默认值: default
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False

az iot ops dataflowgraph show

显示与数据流配置文件关联的数据流图的详细信息。

az iot ops dataflowgraph show --instance
                              --name
                              --resource-group
                              [--profile]

示例

显示与配置文件“myprofile”关联的数据流图“mygraph”的详细信息。

az iot ops dataflowgraph show -n mygraph -p myprofile -i mycluster-ops-instance -g myresourcegroup

必需参数

--instance -i

IoT 操作实例名称。

--name -n

DataflowGraph 名称。

--resource-group -g

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

可选参数

以下参数是可选的，但根据上下文，命令可能需要一个或多个参数才能成功执行。

--profile -p

数据流配置文件名称。 默认值：“default”。

属性 值
默认值: default
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

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

属性 值
默认值: False
--output -o

输出格式。

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

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

--subscription

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

--verbose

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

属性 值
默认值: False