az iot hub module-twin

リファレンス

Note

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

IoT デバイスモジュールツイン構成を管理します。

コマンド

名前	説明	型	状態
az iot hub module-twin replace	モジュールツイン定義をターゲット json に置き換えます。	拡張子	GA
az iot hub module-twin show	モジュールツイン定義を表示します。	拡張子	GA
az iot hub module-twin update	モジュールツインの必要なプロパティとタグを更新します。	拡張子	GA

az iot hub module-twin replace

モジュールツイン定義をターゲット json に置き換えます。

JSON を直接入力するか、ファイルパスを使用します。

az iot hub module-twin replace --device-id
                               --json
                               --module-id
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

例

モジュールツインをファイルの内容に置き換えます。

az iot hub module-twin replace -d {device_id} -n {iothub_name} -m {module_name} -j ../mymodtwin.json

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

--json -j

既存のツインを置き換える Json。ファイルパスまたは生の json を指定します。

--module-id -m

ターゲットモジュール ID。

省略可能のパラメーター

--auth-type

操作でポリシーキーを自動的に派生させるか、現在の Azure AD セッションを使用するかを示します。認証の種類がログインで、リソースホスト名が指定されている場合、リソース参照は必要でない限りスキップされます。を使用して az configure --defaults iothub-data-auth-type=<auth-type-value>既定値を構成できます。

指定可能な値: key, login

規定値: key

--etag -e

リソースの最後の状態に対応する Etag またはエンティティタグ。 etag が指定されていない場合は、値 '*' が使用されます。

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

このコマンドは、アクションを実行する権限を持つエンティティ接続文字列をサポートします。 "az login" によるセッションログインを回避するために使用します。エンティティ接続文字列と名前の両方が指定されている場合、接続文字列が優先されます。 --hub-name が指定されていない場合は必須です。

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

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

--verbose

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

az iot hub module-twin show

モジュールツイン定義を表示します。

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

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

--module-id -m

ターゲットモジュール ID。

省略可能のパラメーター

--auth-type

指定可能な値: key, login

規定値: key

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

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

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

--verbose

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

az iot hub module-twin update

モジュールツインの必要なプロパティとタグを更新します。

PATCH 動作の --desired 引数または --tags 引数を指定します。どちらのパラメーターも、インライン json または json コンテンツへのファイルパスをサポートします。一般的な更新引数 (--set) の使用は PUT の動作を反映し、非推奨とされます。

az iot hub module-twin update --device-id
                              --module-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

例

パッチモジュールツインの必要なプロパティ。

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

モジュールツインタグにパッチを適用します。

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags '{"country": "USA"}'

json ファイルの内容を使用してモジュールツインタグにパッチを適用します。

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --tags /path/to/file

親 'temperature' からの 'critical' 必要なプロパティの修正プログラムの削除

az iot hub module-twin update -n {iothub_name} -d {device_id} -m {module_id} --desired '{"condition":{"temperature":{"critical": null}}}'

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

--module-id -m

ターゲットモジュール ID。

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

規定値: []

--auth-type

指定可能な値: key, login

規定値: key

--desired

ツインの必要なプロパティ。

--etag -e

リソースの最後の状態に対応する Etag またはエンティティタグ。 etag が指定されていない場合は、値 '*' が使用されます。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

規定値: False

--hub-name -n

IoT Hub の名前またはホスト名。 --login が指定されていない場合は必須。

--login -l

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove.

規定値: []

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

規定値: []

--tags

ツインタグ。

グローバルパラメーター

--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 hub module-twin

コマンド

az iot hub module-twin replace

例

必須のパラメーター

省略可能のパラメーター

az iot hub module-twin show

必須のパラメーター

省略可能のパラメーター

az iot hub module-twin update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース