az iot ops dataflowgraph

Note

此參考文獻是該Azure CLIazure-iot-ops擴充套件（版本 2.70.0 或更高版本）的一部分。 這個擴充功能會在你第一次執行 az iot ops dataflowgraph 指令時自動安裝。 深入了解擴充功能。

DataflowGraph 管理。

命令

名稱	Description	類型	狀態
az iot ops dataflowgraph apply	建立或替換與資料流配置檔相關的 DataflowGraph。	Extension	GA
az iot ops dataflowgraph delete	刪除與資料流設定檔相關的 DataflowGraph。	Extension	GA
az iot ops dataflowgraph list	列出與資料流剖面相關的資料流圖。	Extension	GA
az iot ops dataflowgraph show	顯示與資料流剖面相關的資料流圖細節。	Extension	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。 支援的 nodeTypes 有：來源、目的地和圖。 資料流程圖僅支援 MQTT、Kafka 和 OpenTelemetry 端點。 該檔案也可以是完整的 ARM 資源包裝器（屬性會自動解壓）。 extendedLocation 總是自動從 --instance 和 -g 填充，且檔案中不得包含。

當與 apply 一起使用時，上述內容將建立或替換一個目標 DataflowGraph 資源。

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

範例

使用設定檔建立或替換一個 DataflowGraph 的 mygraph，並將其與設定檔 'myprofile' 關聯。

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 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

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

刪除與資料流設定檔相關的 DataflowGraph。

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

範例

刪除與設定檔 'myprofile' 相關的 DataflowGraph 'mygraph'。

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

刪除 DataflowGraph 的「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 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

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

列出與資料流剖面相關的資料流圖。

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

範例

列舉與設定檔「myprofile」相關的 DataflowGraphs。

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

全域參數

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

顯示與資料流剖面相關的資料流圖細節。

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

範例

顯示與設定檔「myprofile」相關的DataflowGraph「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

全域參數

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