az iot central device command

  • リファレンス

Note

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

デバイス コマンドを実行します。

コマンド

名前 説明 型 Status
az iot central device command history

デバイスに送信された最新のコマンド要求と応答の詳細を取得します。

 拡張子 GA
az iot central device command run

デバイスでコマンドを実行し、関連する応答を表示します。 コマンドが実行できるプロパティの更新を監視しません。

 拡張子 GA

az iot central device command history

デバイスに送信された最新のコマンド要求と応答の詳細を取得します。

IoT Central からデバイスに送信された最新のコマンド要求と応答を一覧表示します。 コマンドの実行の結果としてデバイスプロパティに対してデバイスが実行する更新は、応答に含まれません。

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

例

コマンド応答を表示する

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

コンポーネント コマンドの応答を表示する

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

モジュール コンポーネントのコマンド応答を表示する

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--cn --command-name

デバイス テンプレートで指定されているコマンド名。 コマンド名は、コマンドの表示名とは異なる場合があります。

--device-id -d

ターゲット デバイスのデバイス 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
--co --component-name

デバイス コンポーネントの名前。

--interface-id -i

デバイス テンプレートで指定されたインターフェイス/コンポーネントの名前。これを見つけるには、デバイス テンプレートに移動し、対応するデバイス機能の下でインターフェイス/コンポーネント ID を表示します。

--mn --module-name

デバイス モジュールの名前。

--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 device command run

デバイスでコマンドを実行し、関連する応答を表示します。 コマンドが実行できるプロパティの更新を監視しません。

--content には、インライン json またはファイル パスを指定できます。

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

例

インライン ペイロードを使用してコマンドを実行します。 ペイロードは json 文字列の "request" の下にある必要があります

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

json ペイロード パスを使用した短い実行コマンド。

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

コンポーネント コマンドを実行します。

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

モジュール コンポーネント コマンドを実行します。

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。

--cn --command-name

デバイス テンプレートで指定されているコマンド名。 コマンド名は、コマンドの表示名とは異なる場合があります。

--content -k

要求の構成。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 [ファイル パスの例: ./path/to/file.json][文字列化された JSON の例: {'a': 'b'}]。

--device-id -d

ターゲット デバイスのデバイス 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
--co --component-name

デバイス コンポーネントの名前。

--interface-id -i

デバイス テンプレートで指定されたインターフェイス/コンポーネントの名前。これを見つけるには、デバイス テンプレートに移動し、対応するデバイス機能の下でインターフェイス/コンポーネント ID を表示します。

--mn --module-name

デバイス モジュールの名前。

--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 を使います。