Share via


az dt twin component

注意

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

顯示及更新 Digital Twins 實例的數位對應項元件。

命令

名稱 Description 類型 狀態
az dt twin component show

顯示數位對應項元件的詳細資料。

擴充 GA
az dt twin component update

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

擴充 GA

az dt twin component show

顯示數位對應項元件的詳細資料。

az dt twin component show --component
                          --dt-name
                          --twin-id
                          [--resource-group]

範例

顯示數位對應項元件的詳細資料

az dt twin component show -n {instance_or_hostname} --twin-id {twin_id} --component Thermostat

必要參數

--component

DTDL 元件的路徑。

--dt-name --dtn -n

Digital Twins 實例名稱或主機名稱。 如果提供實例名稱,則會先查詢使用者訂用帳戶,讓目標實例擷取主機名稱。 如果提供主機名稱,則會略過訂用帳戶查詢,並提供的值會用於後續的互動。

--twin-id -t

數位對應項識別碼。

選擇性參數

--resource-group -g

Digital Twins 實例資源群組。 您可以使用 來設定預設群組 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 dt twin component update

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

更新屬性值和$model元素可能會在相同的要求中發生。 作業僅限於新增、取代和移除。

az dt twin component update --component
                            --dt-name
                            --json-patch
                            --twin-id
                            [--etag]
                            [--resource-group]

範例

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

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

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

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

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

az dt twin component update -n {instance_or_hostname} --twin-id {twin_id} --component {component_path} --json-patch ./my/patch/document.json

必要參數

--component

DTDL 元件的路徑。

--dt-name --dtn -n

Digital Twins 實例名稱或主機名稱。 如果提供實例名稱,則會先查詢使用者訂用帳戶,讓目標實例擷取主機名稱。 如果提供主機名稱,則會略過訂用帳戶查詢,並提供的值會用於後續的互動。

--json-patch --patch

JSON 修補程式所描述的更新規格。 更新屬性值和$model元素可能會在相同的要求中發生。 作業僅限於新增、取代和移除。 提供檔案路徑或內嵌 JSON。

--twin-id -t

數位對應項識別碼。

選擇性參數

--etag -e

實體標籤值。 如果 etag 符合資源的目前 etag,命令將會成功。

--resource-group -g

Digital Twins 實例資源群組。 您可以使用 來設定預設群組 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 來取得完整偵錯記錄。