az dt route

Note

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

管理和設定事件路由。

請注意，必須先設定端點，才能新增事件路由。

命令

名稱	Description	類型	狀態
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 route create

將事件路由新增至 Digital Twins 實例。

az dt route create --dt-name --dtn
                   --en --endpoint-name
                   --rn --route-name
                   [--filter]
                   [--resource-group]

範例

針對目標實例上現有端點新增事件路由，且默認篩選條件為 「true」。。

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name}

使用自定義篩選，在目標實例上新增現有端點的事件路由。

az dt route create -n {instance_or_hostname} --endpoint-name {endpoint_name} --route-name {route_name} --filter "type = 'Microsoft.DigitalTwins.Twin.Create'"

必要參數

--dt-name --dtn -n

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

--en --endpoint-name

端點名稱。

--rn --route-name

事件路由名稱。

選擇性參數

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

--filter

事件路由篩選。

屬性	值
預設值:	true

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

從 Digital Twins 實例移除事件路由。

az dt route delete --dt-name --dtn
                   --rn --route-name
                   [--resource-group]

範例

從目標實例移除事件路由。

az dt route delete -n {instance_or_hostname} --route-name {route_name}

必要參數

--dt-name --dtn -n

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

--rn --route-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 route list

列出 Digital Twins 實例的已設定事件路由。

az dt route list --dt-name --dtn
                 [--resource-group]

範例

列出目標實例的已設定事件路由。

az dt route list -n {instance_or_hostname}

必要參數

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

顯示 Digital Twins 實例上設定的事件路由詳細數據。

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

範例

在目標實例上顯示事件路由。

az dt route show -n {instance_or_hostname} --route-name {route_name}

必要參數

--dt-name --dtn -n

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

--rn --route-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