az dt twin

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 擴充功能會在您第一次執行 az dt twin 命令時自動安裝。 Learn more about extensions.

管理及設定 Digital Twins 實例的數字對應項。

命令

名稱	Description	類型	狀態
az dt twin component	顯示及更新 Digital Twins 實例的數位對應項元件。	Extension	GA
az dt twin component show	顯示數字對應項元件的詳細數據。	Extension	GA
az dt twin component update	透過 JSON 修補程式規格更新數位對應項元件。	Extension	GA
az dt twin create	在實例上建立數字對應項。	Extension	GA
az dt twin delete	拿掉數字對應項。 參考此對應項的所有關聯性都必須已經刪除。	Extension	GA
az dt twin delete-all	刪除 Digital Twins 實例中的所有數位對應項，包括這些對應項的所有關聯性。	Extension	GA
az dt twin query	查詢實例的數字對應項。 允許依屬性值周遊關聯性及篩選。	Extension	GA
az dt twin relationship	管理及設定 Digital Twins 實例的數位對應項關聯性。	Extension	GA
az dt twin relationship create	建立來源與目標數字對應項之間的關聯性。	Extension	GA
az dt twin relationship delete	刪除 Digital Twins 實例上的數位對應項關聯性。	Extension	GA
az dt twin relationship delete-all	刪除 Digital Twins 實例內的所有數位對應項關聯性，包括傳入關聯性。	Extension	GA
az dt twin relationship list	列出數字對應項的關聯性。	Extension	GA
az dt twin relationship show	顯示數字對應項關聯性的詳細數據。	Extension	GA
az dt twin relationship update	透過 JSON 修補規格更新兩個數位對應項之間的關聯性屬性。	Extension	GA
az dt twin show	顯示數字對應項的詳細數據。	Extension	GA
az dt twin telemetry	測試及驗證 Digital Twins 實例的事件路由和端點。	Extension	GA
az dt twin telemetry send	代表數字對應項傳送遙測。 如果提供元件路徑，則發出的遙測代表元件。	Extension	GA
az dt twin update	透過 JSON 修補程式規格更新實例數字對應項。	Extension	GA

az dt twin create

在實例上建立數字對應項。

--properties 可以是內嵌 JSON 或檔案路徑。 注意：包含元件的對應項需要 --properties。

az dt twin create --dt-name --dtn
                  --dtmi --model-id
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

範例

從現有 (先前已建立) 模型建立數位對應項。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

使用 if-none-match 標記，從現有的（先前建立）模型建立數字對應項。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

從現有 (先前已建立) 模型建立數位對應項。 使用屬性值具現化。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

使用現有（先前建立的）模型元件建立數字對應項。 具現化具有最小屬性的元件。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

使用現有（先前建立的）模型元件建立數字對應項。 使用屬性值具現化。

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Temperature": 10.2,
    "Thermostat": {
        "$metadata": {},
        "setPointTemp": 23.12
    }
}'

必要參數

--dt-name --dtn -n

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

--dtmi --model-id -m

Digital Twins 模型標識符。範例：dtmi：com：example：Room;2。

--twin-id -t

數字對應項識別碼。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-none-match

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

屬性	值
預設值:	False

--properties -p

具現化數字對應項或相關元件的初始屬性值。 提供檔案路徑或內嵌 JSON。 包含元件的對應項需要屬性，您至少必須為每個元件提供空$metadata物件。

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 dt twin delete

拿掉數字對應項。 參考此對應項的所有關聯性都必須已經刪除。

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

範例

依標識碼移除數字對應項。

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

使用 etag 移除數字對應項。

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

必要參數

--dt-name --dtn -n

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

--twin-id -t

數字對應項識別碼。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--etag -e

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

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 dt twin delete-all

刪除 Digital Twins 實例中的所有數位對應項，包括這些對應項的所有關聯性。

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

範例

刪除所有數字對應項。 參考對應項的任何關聯性也會被刪除。

az dt twin delete-all -n {instance_or_hostname}

必要參數

--dt-name --dtn -n

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

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 dt twin query

查詢實例的數字對應項。 允許依屬性值周遊關聯性及篩選。

在許多對應項查詢中，$ 字元是用來參考對應項的 $dtId 屬性。 在類似bash的殼層或powershell中，$ 字元具有功能意義，而且必須逸出作為查詢輸入的一部分。 如需詳細資訊，請檢閱 digital Twins CLI 概念檔 https://learn.microsoft.com/en-us/azure/digital-twins/concepts-cli。

az dt twin query --dt-name --dtn
                 --query-command
                 [--cost --show-cost {false, true}]
                 [--resource-group]

範例

查詢目標執行個體中的所有數位對應項，並投影所有屬性。 此外亦會以查詢單位顯示成本。

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

依模型進行查詢並投影所有屬性。

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

利用bash相容語法的 『$dtId』 查詢

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

利用 『$dtId』 與 powershell 相容語法的查詢

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

必要參數

--dt-name --dtn -n

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

--query-command -q

要執行的用戶查詢。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cost --show-cost

計算並顯示查詢費用。

屬性	值
預設值:	False
接受的值:	false, true

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 dt twin show

顯示數字對應項的詳細數據。

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

範例

顯示數字對應項的詳細數據。

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

必要參數

--dt-name --dtn -n

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

--twin-id -t

數字對應項識別碼。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	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 dt twin update

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

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

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

範例

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

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

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

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

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

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

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

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

必要參數

--dt-name --dtn -n

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

--json-patch --patch

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

--twin-id -t

數字對應項識別碼。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--etag -e

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

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

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

屬性	值
預設值:	False