az iot central diagnostics

  • 預覽
  • 參考

注意

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

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

執行應用程式和裝置層級診斷。

命令

名稱 Description 類型 狀態
az iot central diagnostics monitor-events

檢視傳送至 IoT Central 應用程式的裝置遙測訊息。

 擴充 預覽版
az iot central diagnostics monitor-properties

檢視傳送至 IoT Central 應用程式的所需和回報屬性。

 擴充 預覽版
az iot central diagnostics registration-summary

檢視應用程式中所有裝置的註冊摘要。

 擴充 預覽版
az iot central diagnostics validate-messages

驗證傳送至 IoT Central 應用程式的IoT 中樞訊息。

 擴充 預覽版
az iot central diagnostics validate-properties

驗證傳送至 IoT Central 應用程式的回報屬性。

 擴充 預覽版

az iot central diagnostics monitor-events

預覽

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

檢視傳送至 IoT Central 應用程式的裝置遙測訊息。

顯示傳送至 IoT Central 應用程式的遙測資料。 根據預設，它會顯示所有裝置傳送的所有資料。 使用 --device-id 參數來篩選至特定裝置。

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri]
                                          [--cg]
                                          [--device-id]
                                          [--enqueued-time]
                                          [--module-id]
                                          [--properties {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout]
                                          [--token]
                                          [--yes {false, true}]

範例

基本使用方式

az iot central diagnostics monitor-events --app-id {app_id}

篩選目標裝置時的基本使用方式

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

篩選識別碼中具有萬用字元的目標裝置時的基本用法

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

篩選模組時的基本用法。

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

在識別碼中使用萬用字元篩選目的模組時的基本用法

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

篩選裝置，並指定要系結的事件中樞取用者群組。

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

接收訊息批註 （訊息標頭）

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

接收訊息批註 + 系統屬性。 永不逾時。

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

從所有裝置訊息接收所有訊息屬性

az iot central diagnostics monitor-events --app-id {app_id} --props all

接收所有訊息，並將訊息承載剖析為 JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--cg --consumer-group -c

指定連接到事件中樞端點時要使用的取用者群組。

預設值: $Default
--device-id -d

目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置識別碼。

--enqueued-time --et -e

指出應該作為從分割區讀取訊息的起點的時間。 單位是 unix epoch 之後的毫秒數。 如果未使用任何時間，表示「現在」。

--module-id -m

如果裝置類型為 IoT Edge，則為 IoT Edge 模組識別碼。

--properties --props -p

指出要輸出的關鍵訊息屬性。 sys = 系統屬性，應用程式 = 應用程式屬性，anno = 注釋。

接受的值: all, anno, app, sys
--repair -r

重新安裝與擴充功能版本相容的 uamqp 相依性。 預設：false。

接受的值: false, true
預設值: False
--timeout --to -t

維護連線而不接收訊息的秒數上限。 使用 0 表示無限大。

預設值: 300
--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

--yes -y

略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。

接受的值: false, true
預設值: 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 iot central diagnostics monitor-properties

預覽

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

檢視傳送至 IoT Central 應用程式的所需和回報屬性。

從中央輪詢裝置對應項，並將它與最後一個裝置對應項剖析裝置對應項的屬性剖析出來，並偵測是否已進行變更列印輪詢間隔內變更的屬性子集。

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri]
                                              [--token]

範例

基本使用方式

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--device-id -d

目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置識別碼。

選擇性參數

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數
--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 central diagnostics registration-summary

預覽

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

檢視應用程式中所有裝置的註冊摘要。

注意：如果您的應用程式包含大量裝置，此命令可能需要大量時間才能傳回。

az iot central diagnostics registration-summary --app-id
                                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri]
                                                [--token]

範例

註冊摘要

az iot central diagnostics registration-summary --app-id {appid}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--api-version --av
已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作，我們將呼叫最新的預覽版本。

接受的值: 2022-06-30-preview, 2022-07-31
預設值: 2022-07-31
--central-api-uri --central-dns-suffix

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數
--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 central diagnostics validate-messages

預覽

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

驗證傳送至 IoT Central 應用程式的IoT 中樞訊息。

對遙測訊息執行驗證，並回報未在裝置範本中建立模型的資料，或資料類型不符合裝置範本中所定義資料的資料。

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri]
                                             [--cg]
                                             [--device-id]
                                             [--dr]
                                             [--enqueued-time]
                                             [--max-messages]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout]
                                             [--token]
                                             [--yes {false, true}]

範例

基本使用方式

az iot central diagnostics validate-messages --app-id {app_id}

偵測到錯誤時輸出錯誤

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

篩選目標裝置時的基本使用方式

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

篩選識別碼中具有萬用字元的目標裝置時的基本用法

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

篩選模組時的基本用法。

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

在識別碼中使用萬用字元篩選目的模組時的基本用法

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

篩選裝置，並指定要系結的事件中樞取用者群組。

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--cg --consumer-group -c

指定連接到事件中樞端點時要使用的取用者群組。

預設值: $Default
--device-id -d

目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置識別碼。

--dr --duration

終止連線之前從目標裝置接收訊息的最大持續時間。使用 0 表示無限大。

預設值: 300
--enqueued-time --et -e

指出應該作為從分割區讀取訊息的起點的時間。 單位是 unix epoch 之後的毫秒數。 如果未使用任何時間，表示「現在」。

--max-messages --mm

終止連線之前，要從目標裝置接收的訊息數目上限。使用 0 表示無限大。

預設值: 10
--minimum-severity

報告所需的問題最小嚴重性。

接受的值: error, info, warning
預設值: warning
--module-id -m

如果裝置類型為 IoT Edge，則為 IoT Edge 模組識別碼。

--properties --props -p

指出要輸出的關鍵訊息屬性。 sys = 系統屬性，應用程式 = 應用程式屬性，anno = 注釋。

接受的值: all, anno, app, sys
--repair -r

重新安裝與擴充功能版本相容的 uamqp 相依性。 預設：false。

接受的值: false, true
預設值: False
--style

指出輸出樣式croll = 在錯誤送達時傳遞錯誤，json = 摘要結果為 json，csv = 摘要結果為 csv。

接受的值: csv, json, scroll
預設值: scroll
--timeout --to -t

維護連線而不接收訊息的秒數上限。 使用 0 表示無限大。

預設值: 300
--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

--yes -y

略過使用者提示。 表示接受動作。 主要用於自動化案例。 預設：false。

接受的值: false, true
預設值: 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 iot central diagnostics validate-properties

預覽

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

驗證傳送至 IoT Central 應用程式的回報屬性。

在報告的屬性更新上執行驗證：

  1. 警告 - 裝置所傳送的屬性未在中央建立模型。
  2. 警告 - 在多個介面中宣告相同名稱的屬性應該包含介面名稱做為屬性更新的一部分。
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

範例

基本使用方式

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--device-id -d

目標裝置的裝置識別碼。按一下 [裝置詳細資料] 頁面上的 [連線] 按鈕，即可找到裝置識別碼。

選擇性參數

--central-api-uri --central-dns-suffix

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--minimum-severity

報告所需的問題最小嚴重性。

接受的值: error, info, warning
預設值: warning
--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

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