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

az iot ops dataflow

Note

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

数据流管理。

命令

名称	说明	类型	Status
az iot ops dataflow apply	创建或替换与数据流配置文件关联的数据流。	Extension	GA
az iot ops dataflow delete	删除与数据流配置文件关联的数据流。	Extension	GA
az iot ops dataflow endpoint	数据流终结点管理。	Extension	GA
az iot ops dataflow endpoint apply	创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create	创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create adls	为 Azure Data Lake Storage Gen2 创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create adx	为 Azure 数据资源管理器创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create custom-kafka	为自定义 kafka 中转站创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create custom-mqtt	为自定义 MQTT 代理创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create eventgrid	为 Azure 事件网格创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create eventhub	为已启用 kafka 的 Azure 事件中心命名空间创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create fabric-onelake	为 Microsoft Fabric OneLake 创建或替换数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint create fabric-realtime	创建或替换 Microsoft Fabric Real-Time Intelligence 数据流终结点。	Extension	GA
az iot ops dataflow endpoint create local-mqtt	创建或替换 Azure IoT作本地 MQTT 数据流终结点。	Extension	GA
az iot ops dataflow endpoint create local-storage	创建或替换本地存储数据流终结点。	Extension	GA
az iot ops dataflow endpoint delete	删除数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint list	列出与实例关联的数据流终结点资源。	Extension	GA
az iot ops dataflow endpoint show	显示数据流终结点资源的详细信息。	Extension	GA
az iot ops dataflow endpoint update	更新现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update adls	更新 Azure Data Lake Storage Gen2 的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update adx	更新 Azure 数据资源管理器的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update custom-kafka	更新自定义 kafka 中转站的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update custom-mqtt	更新自定义 MQTT 代理的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update eventgrid	更新 Azure 事件网格的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update eventhub	更新已启用 kafka 的 Azure 事件中心命名空间的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update fabric-onelake	更新 Microsoft Fabric OneLake 的现有数据流终结点资源的属性。	Extension	GA
az iot ops dataflow endpoint update fabric-realtime	更新现有 Microsoft Fabric Real-Time Intelligence 数据流终结点的属性。	Extension	GA
az iot ops dataflow endpoint update local-mqtt	更新现有 Azure IoT作本地 MQTT 数据流终结点的属性。	Extension	GA
az iot ops dataflow endpoint update local-storage	更新现有本地存储数据流终结点的属性。	Extension	GA
az iot ops dataflow list	列出与数据流配置文件关联的数据流。	Extension	GA
az iot ops dataflow profile	数据流配置文件管理。	Extension	GA
az iot ops dataflow profile create	创建或替换数据流配置文件。	Extension	GA
az iot ops dataflow profile delete	删除数据流配置文件。	Extension	GA
az iot ops dataflow profile list	列出与实例关联的数据流配置文件。	Extension	GA
az iot ops dataflow profile show	显示数据流配置文件的详细信息。	Extension	GA
az iot ops dataflow profile update	更新数据流配置文件。	Extension	GA
az iot ops dataflow show	显示与数据流配置文件关联的数据流的详细信息。	Extension	GA

az iot ops dataflow apply

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

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

{
  "mode": "Enabled",
  "operations": [
    {
      "operationType": "Source",
      "sourceSettings": {
        "endpointRef": "myenpoint1",
        "assetRef": "",
        "serializationFormat": "Json",
        "schemaRef": "myschema1",
        "dataSources": [
          "testfrom"
        ]
      }
    },
    {
      "operationType": "BuiltInTransformation",
      "builtInTransformationSettings": {
        "serializationFormat": "Json",
        "datasets": [],
        "filter": [
          {
            "type": "Filter",
            "description": "",
            "inputs": [
              "$metadata.user_property.value"
            ],
            "expression": "$1 > 100"
          }
        ],
        "map": [
          {
            "type": "PassThrough",
            "inputs": [
              "*"
            ],
            "output": "*"
          }
        ]
      }
    },
    {
      "operationType": "Destination",
      "destinationSettings": {
        "endpointRef": "myenpoint2",
        "dataDestination": "test"
      }
    }
  ]
}

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

az iot ops dataflow apply --config-file
                          --instance
                          --name
                          --resource-group
                          [--profile]

示例

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

az iot ops dataflow apply -n mydataflow -p myprofile --in myinstance -g myresourcegroup --config-file /path/to/dataflow/config.json

必需参数

--config-file

包含 json 格式的资源属性的配置文件的路径。配置文件应包含与资源的 ARM 表示形式兼容的属性的对象。该对象直接与 ARM 资源的“properties：{}”相关联。

属性	值
Parameter group:	Config Arguments

--instance -i

IoT 操作实例名称。

--name -n

数据流名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--profile -p

数据流配置文件名称。

属性	值
默认值:	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 dataflow delete

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

az iot ops dataflow delete --instance
                           --name
                           --resource-group
                           [--profile]
                           [--yes {false, true}]

示例

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

az iot ops dataflow delete -n mydataflow -p myprofile --in mycluster-ops-instance -g myresourcegroup

必需参数

--instance -i

IoT 操作实例名称。

--name -n

数据流名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--profile -p

数据流配置文件名称。

属性	值
默认值:	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 dataflow list

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

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

示例

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

az iot ops dataflow list -p myprofile --in mycluster-ops-instance -g myresourcegroup

必需参数

--instance -i

IoT 操作实例名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--profile -p

数据流配置文件名称。

属性	值
默认值:	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 dataflow show

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

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

示例

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

az iot ops dataflow show -n mydataflow -p myprofile --in mycluster-ops-instance -g myresourcegroup

必需参数

--instance -i

IoT 操作实例名称。

--name -n

数据流名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--profile -p

数据流配置文件名称。

属性	值
默认值:	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 dataflow

命令

az iot ops dataflow apply

示例

必需参数

可选参数

az iot ops dataflow delete

示例

必需参数

可选参数

az iot ops dataflow list

示例

必需参数

可选参数

az iot ops dataflow show

示例

必需参数

可选参数

反馈