共用方式為


az iot ops dataflow

Note

此參考是 Azure CLI 的 azure-iot-ops 延伸模組的一部分(2.67.0 版或更高版本)。 擴充功能會在您第一次執行 az iot ops 數據流 命令時自動安裝。 深入了解擴充功能。

數據流管理。

命令

名稱 Description 類型 狀態
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 create otel

建立或取代 OpenTelemetry 資料流程端點。

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 endpoint update otel

更新現有 OpenTelemetry 資料流程端點的屬性。

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:{}' 相互關聯。

屬性
參數群組: Config Arguments
--instance -i

IoT 作業實例名稱。

--name -n

數據流名稱。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--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

訂用帳戶的名稱或標識碼。 您可以使用 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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--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

訂用帳戶的名稱或標識碼。 您可以使用 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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--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

訂用帳戶的名稱或標識碼。 您可以使用 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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--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

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性
預設值: False