az dt twin relationship

  • 參考

注意

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

管理及設定 Digital Twins 實例的數位對應項關聯性。

命令

名稱 Description 類型 狀態
az dt twin relationship create

建立來源與目標數位對應項之間的關聯性。

 擴充 GA
az dt twin relationship delete

刪除 Digital Twins 實例上的數位對應項關聯性。

 擴充 GA
az dt twin relationship delete-all

刪除 Digital Twins 實例內的所有數位對應項關聯性，包括傳入關聯性。

 擴充 GA
az dt twin relationship list

列出數位對應項的關聯性。

 擴充 GA
az dt twin relationship show

顯示數位對應項關聯性的詳細資料。

 擴充 GA
az dt twin relationship update

更新兩個數字對應項之間的關聯性屬性，透過 JSON 修補規格。

 擴充 GA

az dt twin relationship create

建立來源與目標數位對應項之間的關聯性。

--properties 可以是內嵌 JSON 或檔案路徑。

az dt twin relationship create --dt-name
                               --kind
                               --relationship-id
                               --source
                               --target
                               [--if-none-match]
                               [--properties]
                               [--resource-group]

範例

建立兩個數字對應項之間的關聯性。

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id}

使用 if-none-match 標記建立兩個數字對應項之間的關聯性

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --if-none-match

建立兩個數字對應項之間已初始化屬性的關聯性。

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --properties '{"ownershipUser": "me", "ownershipDepartment": "Computer Science"}'

必要參數

--dt-name --dtn -n

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

--kind --relationship

關聯性名稱或種類。 例如：'contains'。

--relationship-id -r

關聯性識別碼。

--source --twin-id -t

關聯性的來源對應項識別碼。

--target --target-twin-id

關聯性的目標對應項識別碼。

選擇性參數

--if-none-match

指出如果現有的對應項具有相同識別碼存在，則建立作業應該會失敗。

預設值: False
--properties -p

具現化數位對應項關聯性的初始屬性值。 提供檔案路徑或內嵌 JSON。

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

刪除 Digital Twins 實例上的數位對應項關聯性。

az dt twin relationship delete --dt-name
                               --relationship-id
                               --source
                               [--etag]
                               [--resource-group]

範例

刪除數位對應項關聯性。

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id}

使用 etag 刪除數位對應項關聯性。

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --etag {etag}

必要參數

--dt-name --dtn -n

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

--relationship-id -r

關聯性識別碼。

--source --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 來取得完整偵錯記錄。

az dt twin relationship delete-all

刪除 Digital Twins 實例內的所有數位對應項關聯性，包括傳入關聯性。

az dt twin relationship delete-all --dt-name
                                   [--resource-group]
                                   [--source]
                                   [--yes]

範例

刪除與對應項相關聯的所有數位對應項關聯性。

az dt twin relationship delete-all -n {instance_or_hostname} --twin-id {twin_id}

刪除 Digital Twins 內的所有數位對應項關聯性。

az dt twin relationship delete-all -n {instance_or_hostname}

必要參數

--dt-name --dtn -n

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

選擇性參數

--resource-group -g

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

--source --twin-id -t

關聯性的來源對應項識別碼。

--yes -y

不提示確認。

預設值: False
全域參數
--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 relationship list

列出數位對應項的關聯性。

az dt twin relationship list --dt-name
                             --source
                             [--incoming {false, true}]
                             [--kind]
                             [--resource-group]

範例

列出數位對應項的傳出關聯性。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id}

列出數位對應項的傳出關聯性，並篩選關聯性 'contains'

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains

列出數位對應項的傳入關聯性。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --incoming

列出數位對應項的傳入關聯性，並篩選關聯性 'contains'。

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains --incoming

必要參數

--dt-name --dtn -n

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

--source --twin-id -t

關聯性的來源對應項識別碼。

選擇性參數

--incoming

擷取數位對應項的所有傳入關聯性。

接受的值: false, true
預設值: False
--kind --relationship

依關聯性類型篩選結果。

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

顯示數位對應項關聯性的詳細資料。

az dt twin relationship show --dt-name
                             --relationship-id
                             --source
                             [--resource-group]

範例

顯示數位對應項關聯性的詳細資料。

az dt twin relationship show -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id}

必要參數

--dt-name --dtn -n

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

--relationship-id -r

關聯性識別碼。

--source --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 relationship update

更新兩個數字對應項之間的關聯性屬性，透過 JSON 修補規格。

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

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

範例

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

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

透過 JSON 修補程式規格和使用 etag 來更新數位對應項關聯性。

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

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

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

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

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --json-patch ./my/patch/document.json

必要參數

--dt-name --dtn -n

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

--json-patch --patch

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

--relationship-id -r

關聯性識別碼。

--source --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 來取得完整偵錯記錄。