az iot hub digital-twin

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot hub digital-twin 命令時自動安裝。 深入了解擴充功能。

操作與IoT 中樞裝置的數位對應項互動。

命令

名稱	Description	類型	狀態
az iot hub digital-twin invoke-command	叫用數位對應項裝置的根或元件層級命令。	擴充	GA
az iot hub digital-twin show	顯示IoT 中樞裝置的數位對應項。	擴充	GA
az iot hub digital-twin update	透過 JSON 修補程式規格更新數位對應項裝置的讀寫屬性。	擴充	GA

az iot hub digital-twin invoke-command

叫用數位對應項裝置的根或元件層級命令。

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

範例

一般而言，叫用命令，其會使用內嵌 JSON 接受包含特定屬性的承載。

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

叫用根層級命令 「重新開機」，其接受符合 DTDL 模型的承載「延遲」 https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

在不需要輸入的元件 「thermostat1」 上叫用命令 「getMaxMinReport」。

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

必要參數

--cn --command-name

數位對應項命令名稱。

--device-id -d

目標裝置識別碼。

選擇性參數

--component-path

數位對應項元件路徑。 例如：控溫器1。

--connect-timeout --cto

IoT 中樞嘗試連線到裝置的最大時間間隔，以秒為單位。

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--payload

命令的 JSON 承載輸入。 提供檔案路徑或內嵌 JSON。

預設值: {}

--resource-group -g

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

--response-timeout --rto

數位對應項命令會等候結果的最大時間間隔，以秒為單位。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot hub digital-twin show

顯示IoT 中樞裝置的數位對應項。

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

範例

顯示目標裝置數位對應項。

az iot hub digital-twin show -n {iothub_name} -d {device_id}

必要參數

--device-id -d

目標裝置識別碼。

選擇性參數

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot hub digital-twin update

透過 JSON 修補程式規格更新數位對應項裝置的讀寫屬性。

目前作業僅限於新增、取代和移除。

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

範例

透過 JSON 修補程式規格更新數位對應項。

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

透過 JSON 修補程式規格更新數位對應項。

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

透過檔案中定義的 JSON 修補程式規格來更新數位對應項屬性。

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

必要參數

--device-id -d

目標裝置識別碼。

--json-patch --patch

JSON 修補程式所描述的更新規格。 作業僅限於新增、取代和移除。 提供檔案路徑或內嵌 JSON。

選擇性參數

--etag -e

對應至資源最後狀態的 Etag 或實體標記。 如果未提供任何 etag，則會使用 '*' 值。

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--login -l

此命令支援具有執行動作許可權的實體連接字串。 使用 來避免透過 「az login」 的會話登入。 如果提供實體連接字串和名稱，則連接字串優先。 如果未提供 --hub-name，則為必要專案。

--resource-group -g

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

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

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

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。