az dt

Note

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

管理 Azure Digital Twins 解決方案和基礎結構。

命令

名稱	Description	類型	狀態
az dt create	建立或更新 Digital Twins 實例。	Extension	GA
az dt data-history	管理和設定數據歷程記錄。	Extension	GA
az dt data-history connection	管理及設定數據歷程記錄連線。	Extension	GA
az dt data-history connection create	建立 Digital Twins 實例與支援資源之間的數據歷程記錄連線。	Extension	GA
az dt data-history connection create adx	建立 Digital Twins 實例與 Azure 數據總管資料庫之間的數據歷程記錄連線。 需要預先建立的 Azure 數據總管和事件中樞資源。	Extension	GA
az dt data-history connection delete	刪除 Digital Twins 實例上設定的數據歷程記錄連線。	Extension	GA
az dt data-history connection list	列出 Digital Twins 實例上設定的所有數據歷程記錄連線。	Extension	GA
az dt data-history connection show	顯示在 Digital Twins 實例上設定的數據歷程記錄連線詳細數據。	Extension	GA
az dt data-history connection wait	等到數據歷程記錄連線上的作業完成為止。	Extension	GA
az dt delete	刪除現有的 Digital Twins 實例。	Extension	GA
az dt endpoint	管理和設定 Digital Twins 實例端點。	Extension	GA
az dt endpoint create	將輸出端點新增至 Digital Twins 實例。	Extension	GA
az dt endpoint create eventgrid	將 EventGrid 主題端點新增至 Digital Twins 實例。 需要預先建立的資源。	Extension	GA
az dt endpoint create eventhub	將 EventHub 端點新增至 Digital Twins 實例。	Extension	GA
az dt endpoint create servicebus	將 ServiceBus 主題端點新增至 Digital Twins 實例。	Extension	GA
az dt endpoint delete	從 Digital Twins 實例移除端點。	Extension	GA
az dt endpoint list	列出 Digital Twins 實例上設定的所有輸出端點。	Extension	GA
az dt endpoint show	顯示 Digital Twins 實例上設定之端點的詳細數據。	Extension	GA
az dt endpoint wait	等候端點作業完成。	Extension	GA
az dt identity	管理 Digital Twins 實例的身分識別。	Extension	GA
az dt identity assign	將受控識別指派給 Digital Twins 實例。	Extension	GA
az dt identity remove	從 Digital Twins 實例中移除受控識別。	Extension	GA
az dt identity show	顯示 Digital Twins 實例的身分識別屬性。	Extension	GA
az dt job	管理及設定數字對應項實例的工作。	Extension	GA
az dt job deletion	管理和設定作業，以刪除數字對應項實例中的模型、對應項和關聯性數據。	Extension	GA
az dt job deletion create	在數字對應項實例上建立和執行刪除作業。	Extension	GA
az dt job deletion list	列出在數字對應項實例上執行的所有刪除作業。	Extension	GA
az dt job deletion show	顯示在數字對應項實例上執行的刪除作業詳細數據。	Extension	GA
az dt job import	管理和設定作業，以便將模型、對應項和關聯性數據匯入至數位對應項實例。	Extension	GA
az dt job import cancel	取消在數字對應項實例上執行的數據匯入作業。	Extension	GA
az dt job import create	在數字對應項實例上建立和執行數據匯入作業。	Extension	GA
az dt job import delete	刪除在數字對應項實例上執行的數據匯入作業。	Extension	GA
az dt job import list	列出在數字對應項實例上執行的所有數據匯入作業。	Extension	GA
az dt job import show	顯示在數字對應項實例上執行的數據匯入作業詳細數據。	Extension	GA
az dt list	依訂用帳戶或資源群組列出 Digital Twins 實例的集合。	Extension	GA
az dt model	管理 Digital Twins 實例上的 DTDL 模型和定義。	Extension	GA
az dt model create	上傳一或多個模型。	Extension	GA
az dt model delete	刪除模型。 只有在沒有其他模型參考模型時，才能刪除模型。	Extension	GA
az dt model delete-all	刪除 Digital Twins 實例內的所有模型。	Extension	GA
az dt model list	列出模型元數據、定義和相依性。	Extension	GA
az dt model show	擷取目標模型或模型定義。	Extension	GA
az dt model update	更新模型的元數據。 目前模型只能解除認可。	Extension	GA
az dt network	管理 Digital Twins 網路設定，包括私人連結和端點連線。	Extension	GA
az dt network private-endpoint	管理 Digital Twins 實例私人端點。	Extension	GA
az dt network private-endpoint connection	管理 Digital Twins 實例私人端點連線。	Extension	GA
az dt network private-endpoint connection delete	刪除與 Digital Twins 實例相關聯的私人端點連線。	Extension	GA
az dt network private-endpoint connection list	列出與 Digital Twins 實例相關聯的私人端點連線。	Extension	GA
az dt network private-endpoint connection set	設定與 Digital Twins 實例相關聯的私人端點聯機狀態。	Extension	GA
az dt network private-endpoint connection show	顯示與 Digital Twins 實例相關聯的私人端點連線。	Extension	GA
az dt network private-endpoint connection wait	等候私人端點連線上的作業完成。	Extension	GA
az dt network private-link	管理 Digital Twins 實例私人鏈接作業。	Extension	GA
az dt network private-link list	列出與 Digital Twins 實例相關聯的私人連結。	Extension	GA
az dt network private-link show	顯示與實例相關聯的私人連結。	Extension	GA
az dt role-assignment	管理 Digital Twins 實例的 RBAC 角色指派。	Extension	GA
az dt role-assignment create	將使用者、群組或服務主體指派給針對 Digital Twins 實例的角色。	Extension	GA
az dt role-assignment delete	從 Digital Twins 實例移除使用者、群組或服務主體角色指派。	Extension	GA
az dt role-assignment list	列出 Digital Twins 實例的現有角色指派。	Extension	GA
az dt route	管理和設定事件路由。	Extension	GA
az dt route create	將事件路由新增至 Digital Twins 實例。	Extension	GA
az dt route delete	從 Digital Twins 實例移除事件路由。	Extension	GA
az dt route list	列出 Digital Twins 實例的已設定事件路由。	Extension	GA
az dt route show	顯示 Digital Twins 實例上設定的事件路由詳細數據。	Extension	GA
az dt show	顯示現有的 Digital Twins 實例。	Extension	GA
az dt twin	管理及設定 Digital Twins 實例的數字對應項。	Extension	GA
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 wait	等到 Digital Twins 實例上的作業完成為止。	Extension	GA

az dt create

建立或更新 Digital Twins 實例。

az dt create --dt-name --dtn
             --resource-group
             [--assign-identity {false, true}]
             [--location]
             [--mi-system-assigned {false, true}]
             [--mi-user-assigned]
             [--no-wait]
             [--pna --public-network-access {Disabled, Enabled}]
             [--role]
             [--scopes]
             [--tags]

範例

使用資源群組位置在目標資源群組中建立實例。

az dt create -n {instance_name} -g {resouce_group}

在具有指定位置和標籤的目標資源群組中建立實例。

az dt create -n {instance_name} -g {resouce_group} -l westus --tags a=b c=d

使用系統受控識別在目標資源群組中建立實例。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned

使用使用者受控識別在目標資源群組中建立實例。

az dt create -n {instance_name} -g {resouce_group} --mi-user-assigned {resource_id}

使用系統受控識別和多個使用者受控識別，在目標資源群組中建立實例。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --mi-user-assigned {resource_id} {resource_id}

使用系統受控識別在目標資源群組中建立實例，然後將身分識別指派給具有參與者角色的一或多個範圍（空格分隔）。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic"

使用系統受控識別在目標資源群組中建立實例，然後將身分識別指派給具有自定義指定角色的一或多個範圍。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic" --role MyCustomRole

使用新的標籤值更新目標資源群組中的實例，並停用公用網路存取。

az dt create -n {instance_name} -g {resouce_group} --tags env=prod --public-network-access Disabled

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--assign-identity

已被取代

自變數 'assign_identity' 已被取代，並將在未來版本中移除。 請改用 『--mi-system-assigned』。

將系統產生的身分識別指派給 Digital Twins 實例。

屬性	值
參數群組:	Managed Service Identity Arguments
接受的值:	false, true

--location -l

Digital Twins 實例位置。 如果未提供任何位置，則會使用資源群組位置。您可以使用 az configure --defaults location={name}來設定預設位置。

--mi-system-assigned

將系統產生的身分識別指派給這個 Digital Twins 實例。

屬性	值
參數群組:	Managed Service Identity Arguments
接受的值:	false, true

--mi-user-assigned

要新增至 Digital Twins 實例的空間分隔使用者身分識別資源標識符。

屬性	值
參數群組:	Managed Service Identity Arguments

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--pna --public-network-access

判斷是否可以從公用網路存取 Digital Twins 實例。

屬性	值
參數群組:	Network Arguments
預設值:	Enabled
接受的值:	Disabled, Enabled

--role

系統指派身分識別的角色名稱或標識碼。

屬性	值
參數群組:	Managed Service Identity Arguments
預設值:	Contributor

--scopes

系統指派的身分識別可以存取的空間分隔範圍。 無法搭配 --no-wait 使用。

屬性	值
參數群組:	Managed Service Identity Arguments

--tags

Digital Twins 實例卷標。 索引鍵/值組中的屬性包，格式如下：a=b c=d。

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

刪除現有的 Digital Twins 實例。

az dt delete --dt-name --dtn
             [--no-wait]
             [--resource-group]
             [--yes]

範例

使用確認提示，以封鎖方式刪除任意實例。

az dt delete -n {instance_name}

刪除沒有封鎖或提示的任意實例。

az dt delete -n {instance_name} -y --no-wait

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--no-wait

請勿等候長時間執行的作業完成。

屬性	值
預設值:	False

--resource-group -g

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

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	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 list

依訂用帳戶或資源群組列出 Digital Twins 實例的集合。

az dt list [--resource-group]

範例

列出目前訂用帳戶中的所有實例。

az dt list

列出目標資源群組中的所有實例，並以數據表格式輸出。

az dt list -g {resource_group} --output table

列出訂用帳戶中符合條件的所有實例。

az dt list --query "[?contains(name, 'Production')]"

計算符合條件的實例。

az dt list --query "length([?contains(name, 'Production')])"

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

顯示現有的 Digital Twins 實例。

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

範例

顯示 實例。

az dt show -n {instance_name}

顯示實例和專案特定屬性。

az dt show -n {instance_name} --query "{Endpoint:hostName, Location:location}"

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--resource-group -g

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

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	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 wait

等到 Digital Twins 實例上的作業完成為止。

az dt wait --dt-name --dtn
           [--created]
           [--custom]
           [--deleted]
           [--exists]
           [--interval]
           [--resource-group]
           [--timeout]

範例

等到建立任意實例為止。

az dt wait -n {instance_name} --created

等到刪除現有的實例為止。

az dt wait -n {instance_name} --deleted

等候現有實例的 publicNetworkAccess 屬性設定為 Enabled

az dt wait -n {instance_name} --custom "publicNetworkAccess=='Enabled'"

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性	值
參數群組:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	False

--interval

輪詢間隔以秒為單位。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	30

--resource-group -g

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

--timeout

以秒為單位的等候上限。

屬性	值
參數群組:	Wait Condition Arguments
預設值:	3600

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

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

--query

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

--subscription

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

--verbose

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

屬性	值
預設值:	False