az iot central device twin
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot central device twin コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
IoT Central デバイス ツインを管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az iot central device twin replace |
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントの書き込み可能なプロパティ値を置き換えます。 |
拡張子 | GA |
az iot central device twin show |
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントのすべてのプロパティ値を取得します。 |
拡張子 | GA |
az iot central device twin update |
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントの書き込み可能なプロパティ値を更新します。 |
拡張子 | GA |
az iot central device twin replace
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントの書き込み可能なプロパティ値を置き換えます。
--component-name、--module-name、またはその両方を指定して、デバイス コンポーネントのプロパティ、デバイス モジュールのプロパティ、またはデバイス モジュール コンポーネントのプロパティを置き換えます。
az iot central device twin replace --app-id
--content
--device-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--co]
[--mn]
[--token]
例
デバイスのプロパティを置き換える
az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}
デバイス コンポーネントのプロパティを置き換える
az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}
デバイス モジュール コンポーネントのプロパティを置き換える
az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
要求の構成。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 [ファイル パスの例: ./path/to/file.json][文字列化された JSON の例: {'a': 'b'}]。
ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
デバイス コンポーネントの名前。
デバイス モジュールの名前。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central device twin show
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントのすべてのプロパティ値を取得します。
--component-name、--module-name、またはその両方を指定して、デバイス コンポーネントのプロパティ、デバイス モジュールのプロパティ、またはデバイス モジュール コンポーネントのプロパティを取得します。
az iot central device twin show --app-id
--device-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--co]
[--mn]
[--token]
例
デバイス プロパティを取得する
az iot central device twin show --app-id {appid} --device-id {deviceid}
デバイス コンポーネントのプロパティを取得する
az iot central device twin show --app-id {appid} --device-id {deviceid} --co {componentname}
デバイス モジュール コンポーネントのプロパティを取得する
az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
デバイス コンポーネントの名前。
デバイス モジュールの名前。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central device twin update
デバイス、デバイス コンポーネント、デバイス モジュール、またはデバイス モジュール コンポーネントの書き込み可能なプロパティ値を更新します。
--component-name、--module-name、またはその両方を指定して、デバイス コンポーネントのプロパティ、デバイス モジュールのプロパティ、またはデバイス モジュール コンポーネントのプロパティを更新します。
az iot central device twin update --app-id
--content
--device-id
[--api-version {2022-06-30-preview, 2022-07-31}]
[--central-api-uri]
[--co]
[--mn]
[--token]
例
デバイス プロパティの更新
az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}
デバイス コンポーネントのプロパティを更新する
az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}
デバイス モジュール コンポーネントのプロパティを更新する
az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
要求の構成。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 [ファイル パスの例: ./path/to/file.json][文字列化された JSON の例: {'a': 'b'}]。
ターゲット デバイスのデバイス ID。デバイス ID を確認するには、[デバイスの詳細] ページの [接続] ボタンをクリックします。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
このコマンド パラメーターは非推奨となり、無視されます。今後のリリースでは、最新の GA バージョンの IoT Central API のみをサポートします。API がまだ GA でない場合は、最新のプレビュー バージョンを呼び出します。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
デバイス コンポーネントの名前。
デバイス モジュールの名前。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI