az dt model

注意

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

管理 Digital Twins 實例上的 DTDL 模型和定義。

命令

名稱	Description	類型	狀態
az dt model create	上傳一或多個模型。	副檔名	GA
az dt model delete	刪除模型。 只有在沒有其他模型參考模型時，才能刪除模型。	副檔名	GA
az dt model delete-all	刪除 Digital Twins 實例內的所有模型。	副檔名	GA
az dt model list	列出模型元數據、定義和相依性。	副檔名	GA
az dt model show	擷取目標模型或模型定義。	副檔名	GA
az dt model update	更新 模型的元數據。 目前模型只能解除認可。	副檔名	GA

az dt model create

上傳一或多個模型。

--models 可以是內嵌 json 或檔案路徑。 輸入模型集的大小（ontology）受限於 DT 實例可以儲存的模型數目上限（預設值為 10000 個模型）。

az dt model create --dt-name
                   [--failure-policy {None, Rollback}]
                   [--fd]
                   [--max-models-per-batch]
                   [--models]
                   [--resource-group]

範例

從目標目錄大量上傳所有 .json 或 .dtdl 模型檔案。 模型處理是遞歸的。

az dt model create -n {instance_or_hostname} --from-directory {directory_path}

上傳模型 json 內嵌或從檔案路徑。

az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}

必要參數

--dt-name --dtn -n

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

選擇性參數

--failure-policy --fp

指出處理模型批次時發生錯誤時的失敗原則。 在「復原」模式中，先前批次中建立的所有模型都會一次刪除一個。 選取為 [無] 時，不會從 DT 實例中刪除在先前批次中建立的模型。

接受的值: None, Rollback

預設值: Rollback

--fd --from-directory

目錄 JSON 模型檔案將會從 中剖析。 請注意：當目錄包含 250 個或更小的模型時，模型會以不可部分完成的方式建立，因此如果發生錯誤，則不會建立任何模型。當目錄有超過 250 個模型（API 限制）時，輸入模型集會以區塊化和批次建立。 如果處理批次時發生錯誤，行為是由 --failure-policy 參數所決定。

--max-models-per-batch --mmpb

實驗

建立超過 250 個模型時，每個批次的模型大小上限。請減少此數目以防止 DTDLParser 錯誤。

預設值: 30

--models

內嵌模型 JSON 或模型 JSON 的檔案路徑。 請注意：當模型 JSON 包含 250 個或更少模型時，模型會以不可部分完成的方式建立，因此如果發生錯誤，則不會建立任何模型。當模型 JSON 有超過 250 個模型（API 限制）時，輸入模型集會分塊建立並批次建立。 如果處理批次時發生錯誤，行為是由 --failure-policy 參數所決定。

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

刪除模型。 只有在沒有其他模型參考模型時，才能刪除模型。

az dt model delete --dt-name
                   --dtmi
                   [--resource-group]

範例

刪除目標模型。

az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

必要參數

--dt-name --dtn -n

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

--dtmi --model-id -m

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

選擇性參數

--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 model delete-all

刪除 Digital Twins 實例內的所有模型。

對應項組態不會受到影響，但可能會在沒有模型定義的情況下中斷。

az dt model delete-all --dt-name
                       [--resource-group]
                       [--yes]

範例

刪除所有模型。

az dt model delete-all -n {instance_or_hostname}

必要參數

--dt-name --dtn -n

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

選擇性參數

--resource-group -g

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

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

列出模型元數據、定義和相依性。

az dt model list --dt-name
                 [--def {false, true}]
                 [--dependencies-for]
                 [--resource-group]

範例

列出模型元數據

az dt model list -n {instance_or_hostname}

列出模型定義

az dt model list -n {instance_or_hostname} --definition

列出特定預先存在的模型相依性。 空格分隔 dtmi 值。

az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}

必要參數

--dt-name --dtn -n

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

選擇性參數

--def --definition

作業會擷取模型定義。

接受的值: false, true

預設值: False

--dependencies-for

會擷取其相依性的模型集合。 如果省略，則會擷取所有模型。 Format 是空格符分隔清單。

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

擷取目標模型或模型定義。

az dt model show --dt-name
                 --dtmi
                 [--def {false, true}]
                 [--resource-group]

範例

顯示模型元數據

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

顯示模型元數據和定義

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition

必要參數

--dt-name --dtn -n

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

--dtmi --model-id -m

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

選擇性參數

--def --definition

作業會擷取模型定義。

接受的值: false, true

預設值: False

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

更新 模型的元數據。 目前模型只能解除認可。

az dt model update --dt-name
                   --dtmi
                   [--decommission {false, true}]
                   [--resource-group]

範例

解除認可目標模型

az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission

必要參數

--dt-name --dtn -n

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

--dtmi --model-id -m

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

選擇性參數

--decommission

表示將目標模型解除委任的意圖。

接受的值: false, true

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