az dt endpoint

Note

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

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

命令

名稱	Description	類型	狀態
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 endpoint delete

從 Digital Twins 實例移除端點。

az dt endpoint delete --dt-name --dtn
                      --en --endpoint-name
                      [--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

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

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

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

az dt endpoint list --dt-name --dtn
                    [--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

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

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

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

az dt endpoint show --dt-name --dtn
                    --en --endpoint-name
                    [--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

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

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

等候端點作業完成。

az dt endpoint wait --dt-name --dtn
                    --en --endpoint-name
                    [--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

等到現有端點的 primaryConnectionString 為 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' 建立。

屬性	值
參數群組:	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

意見反應

此頁面對您有幫助嗎？

共用方式為

az dt endpoint

命令

az dt endpoint delete

範例

必要參數

選擇性參數

az dt endpoint list

範例

必要參數

選擇性參數

az dt endpoint show

範例

必要參數

選擇性參數

az dt endpoint wait

範例

必要參數

選擇性參數

意見反應