az dt endpoint

注意

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

管理和設定 Digital Twins 實例端點。

命令

名稱	Description	類型	狀態
az dt endpoint create	將輸出端點新增至 Digital Twins 實例。	擴充	GA
az dt endpoint create eventgrid	將 EventGrid 主題端點新增至 Digital Twins 實例。 需要預先建立的資源。	擴充	GA
az dt endpoint create eventhub	將 EventHub 端點新增至 Digital Twins 實例。	擴充	GA
az dt endpoint create servicebus	將 ServiceBus 主題端點新增至 Digital Twins 實例。	擴充	GA
az dt endpoint delete	從 Digital Twins 實例移除端點。	擴充	GA
az dt endpoint list	列出 Digital Twins 實例上設定的所有輸出端點。	擴充	GA
az dt endpoint show	顯示 Digital Twins 實例上設定之端點的詳細資料。	擴充	GA
az dt endpoint wait	等候端點作業完成。	擴充	GA

az dt endpoint delete

從 Digital Twins 實例移除端點。

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

範例

從實例移除端點，並封鎖直到作業完成為止。

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name}

從實例移除端點，而不需確認或封鎖。

az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name} -y --no-wait

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

--en --endpoint-name

端點名稱。

選擇性參數

--no-wait

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

預設值: False

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

列出 Digital Twins 實例上設定的所有輸出端點。

az dt endpoint list --dt-name
                    [--resource-group]

範例

列出實例上設定的所有輸出端點。

az dt endpoint list -n {instance_name}

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

選擇性參數

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

顯示 Digital Twins 實例上設定之端點的詳細資料。

az dt endpoint show --dt-name
                    --en
                    [--resource-group]

範例

依實例的名稱顯示所需的端點。

az dt endpoint show -n {instance_name} --endpoint-name {endpoint_name}

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

--en --endpoint-name

端點名稱。

選擇性參數

--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 endpoint wait

等候端點作業完成。

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

範例

等候實例的端點建立。

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --created

等候現有端點從 實例中刪除。

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --deleted

等候現有端點的主要連線ionString 為 null。

az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --custom "properties.primaryConnectionString==null"

必要參數

--dt-name --dtn -n

Digital Twins 實例名稱。

--en --endpoint-name

端點名稱。

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--resource-group -g

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

--timeout

以秒為單位的等候上限。

預設值: 3600

全域參數

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