az iot hub distributed-tracing

注意

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

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理每個裝置的分散式設定。

命令

名稱	Description	類型	狀態
az iot hub distributed-tracing show	取得裝置的分散式追蹤設定。	擴充	預覽版
az iot hub distributed-tracing update	更新裝置的分散式追蹤選項。	擴充	預覽版

az iot hub distributed-tracing show

預覽

命令群組 'iot 中樞分散式追蹤' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得裝置的分散式追蹤設定。

az iot hub distributed-tracing show --device-id
                                    --hub-name
                                    [--auth-type {key, login}]
                                    [--resource-group]

範例

取得裝置的分散式追蹤設定

az iot hub distributed-tracing show -d {device_id} -n {iothub_name}

必要參數

--device-id -d

目標裝置識別碼。

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--resource-group -g

資源組名。 您可以使用 來設定預設群組 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 iot hub distributed-tracing update

預覽

命令群組 'iot 中樞分散式追蹤' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新裝置的分散式追蹤選項。

az iot hub distributed-tracing update --device-id
                                      --hub-name
                                      --sampling-mode {off, on}
                                      --sampling-rate
                                      [--auth-type {key, login}]
                                      [--resource-group]

範例

更新裝置的分散式追蹤選項

az iot hub distributed-tracing update -d {device_id} --sm on --sr 50 -n {iothub_name}

必要參數

--device-id -d

目標裝置識別碼。

--hub-name -n

IoT 中樞名稱或主機名稱。 如果未提供 --login，則為必要項。

--sampling-mode --sm

開啟和關閉分散式追蹤的取樣。 1 為 [開啟]，2 為 [關閉]。

接受的值: off, on

--sampling-rate --sr

控制取樣以新增追蹤內容的訊息數量。 這個值是百分比。 只允許從 0 到 100 的值（含） 。

選擇性參數

--auth-type

指出作業是否應該自動衍生原則金鑰，或使用目前的 Azure AD 會話。 如果驗證類型是登入，而且會提供資源主機名稱，除非需要，否則將會略過資源查閱。您可以使用 來設定預設值 az configure --defaults iothub-data-auth-type=<auth-type-value> 。

接受的值: key, login

預設值: key

--resource-group -g

資源組名。 您可以使用 來設定預設群組 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 來取得完整偵錯記錄。