az iot central diagnostics

Note

このリファレンスは、Azure CLI (バージョン 2.37.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot central 診断 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

アプリケーション レベルとデバイス レベルの診断を実行します。

コマンド

名前	説明	型	Status
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 Hub に送信されたメッセージを検証します。	拡張	プレビュー
az iot central diagnostics validate-properties	IoT Central アプリケーションに送信された報告されたプロパティを検証します。	拡張	プレビュー

az iot central diagnostics monitor-events

プレビュー

コマンド グループ "iot central 診断" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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}

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}

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 アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

省略可能のパラメーター

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

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--cg --consumer-group -c

イベント ハブ エンドポイントに接続するときに使用するコンシューマー グループを指定します。

既定値: $Default

--device-id -d

ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。

--enqueued-time --et -e

パーティションからメッセージを読み取る開始点として使用する必要がある時間を示します。 単位は unix エポック以降のミリ秒です。 時刻が "now" と示されていない場合は使用されます。

--module-id -m

デバイスの種類が IoT Edge の場合の IoT Edge モジュール ID。

--properties --props -p

出力するキー メッセージのプロパティを指定します。 sys = システム プロパティ、app = アプリケーション プロパティ、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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central diagnostics monitor-properties

プレビュー

コマンド グループ "iot central 診断" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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 アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--device-id -d

ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。

省略可能のパラメーター

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central diagnostics registration-summary

プレビュー

コマンド グループ "iot central 診断" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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 アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。

承認された値: 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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central diagnostics validate-messages

プレビュー

コマンド グループ "iot central 診断" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

IoT Central アプリ用に IoT Hub に送信されたメッセージを検証します。

テレメトリ メッセージに対して検証を実行し、デバイス テンプレートでモデル化されていないデータ、またはデータ型がデバイス テンプレートで定義されているものと一致しないデータを報告します。

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}

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}

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 アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

省略可能のパラメーター

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

アプリケーションに関連付けられている IoT Central DNS サフィックス。

既定値: azureiotcentral.com

--cg --consumer-group -c

イベント ハブ エンドポイントに接続するときに使用するコンシューマー グループを指定します。

既定値: $Default

--device-id -d

ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。

--dr --duration

接続を終了する前にターゲット デバイスからメッセージを受信する最大期間。無限大には 0 を使用します。

既定値: 300

--enqueued-time --et -e

パーティションからメッセージを読み取る開始点として使用する必要がある時間を示します。 単位は unix エポック以降のミリ秒です。 時刻が "now" と示されていない場合は使用されます。

--max-messages --mm

接続を終了する前にターゲット デバイスから受信するメッセージの最大数。無限大には 0 を使用します。

既定値: 10

--minimum-severity

レポートに必要な問題の最小重大度。

承認された値: error, info, warning

既定値: warning

--module-id -m

デバイスの種類が IoT Edge の場合の IoT Edge モジュール ID。

--properties --props -p

出力するキー メッセージのプロパティを指定します。 sys = システム プロパティ、app = アプリケーション プロパティ、anno = 注釈。

承認された値: all, anno, app, sys

--repair -r

拡張機能のバージョンと互換性のある uamqp 依存関係を再インストールします。 既定値は false です。

承認された値: false, true

既定値: False

--style

出力 stylescroll = 到着時にエラーを配信し、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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az iot central diagnostics validate-properties

プレビュー

コマンド グループ "iot central 診断" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: 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 アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--device-id -d

ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。

省略可能のパラメーター

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

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。