az iot ops dataflow

注

このリファレンスは、Azure CLI (バージョン 2.62.0 以降) の azure-iot-ops 拡張機能の一部です。拡張機能は、az iot ops dataflow コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細については、を参照してください。

データフロー管理。

コマンド

名前	説明	型	状態
az iot ops dataflow apply	データフロープロファイルに関連付けられているデータフローを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow delete	データフロープロファイルに関連付けられているデータフローを削除します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint	データフローエンドポイントの管理。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint apply	データフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create	データフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create adls	Azure Data Lake Storage Gen2 のデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create adx	Azure Data Explorer のデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create custom-kafka	カスタム kafka ブローカーのデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create custom-mqtt	カスタム MQTT ブローカーのデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create eventgrid	Azure Event Grid のデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create eventhub	kafka 対応の Azure Event Hubs 名前空間のデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create fabric-onelake	Microsoft Fabric OneLake のデータフローエンドポイントリソースを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create fabric-realtime	Microsoft Fabric Real-Time Intelligence データフローエンドポイントを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create local-mqtt	Azure IoT Operations ローカル MQTT データフローエンドポイントを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint create local-storage	ローカルストレージデータフローエンドポイントを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint delete	データフローエンドポイントリソースを削除します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint list	インスタンスに関連付けられているデータフローエンドポイントリソースを一覧表示します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint show	データフローエンドポイントリソースの詳細を表示します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update	既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update adls	Azure Data Lake Storage Gen2 の既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update adx	Azure Data Explorer の既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update custom-kafka	カスタム kafka ブローカーの既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update custom-mqtt	カスタム MQTT ブローカーの既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update eventgrid	Azure Event Grid の既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update eventhub	kafka 対応の Azure Event Hubs 名前空間の既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update fabric-onelake	Microsoft Fabric OneLake の既存のデータフローエンドポイントリソースのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update fabric-realtime	既存の Microsoft Fabric Real-Time Intelligence データフローエンドポイントのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update local-mqtt	既存の Azure IoT Operations ローカル MQTT データフローエンドポイントのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow endpoint update local-storage	既存のローカルストレージデータフローエンドポイントのプロパティを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow list	データフロープロファイルに関連付けられているデータフローを一覧表示します。	拡張	ジョージア州 (GA)
az iot ops dataflow profile	データフロープロファイルの管理。	拡張	ジョージア州 (GA)
az iot ops dataflow profile create	データフロープロファイルを作成または置換します。	拡張	ジョージア州 (GA)
az iot ops dataflow profile delete	データフロープロファイルを削除します。	拡張	ジョージア州 (GA)
az iot ops dataflow profile list	インスタンスに関連付けられているデータフロープロファイルを一覧表示します。	拡張	ジョージア州 (GA)
az iot ops dataflow profile show	データフロープロファイルの詳細を表示します。	拡張	ジョージア州 (GA)
az iot ops dataflow profile update	データフロープロファイルを更新します。	拡張	ジョージア州 (GA)
az iot ops dataflow show	データフロープロファイルに関連付けられているデータフローの詳細を表示します。	拡張	ジョージア州 (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:{}' と直接関連付けられます。

--instance -i

IoT Operations インスタンス名。

--name -n

データフロー名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

--profile -p

データフロープロファイル名。

規定値: default

グローバルパラメーター

--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 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 Operations インスタンス名。

--name -n

データフロー名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

--profile -p

データフロープロファイル名。

規定値: default

--yes -y

プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。

指定可能な値: false, true

グローバルパラメーター

--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 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 Operations インスタンス名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

--profile -p

データフロープロファイル名。

規定値: default

グローバルパラメーター

--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 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 Operations インスタンス名。

--name -n

データフロー名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

--profile -p

データフロープロファイル名。

規定値: default

グローバルパラメーター

--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 iot ops dataflow

コマンド

az iot ops dataflow apply

例

必須のパラメーター

省略可能のパラメーター

az iot ops dataflow delete

例

必須のパラメーター

省略可能のパラメーター

az iot ops dataflow list

例

必須のパラメーター

省略可能のパラメーター

az iot ops dataflow show

例

必須のパラメーター

省略可能のパラメーター