az iot edge

リファレンス

Note

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

Edge の IoT ソリューションを管理します。

コマンド

名前	説明	型	状態
az iot edge deployment	大規模な IoT Edge デプロイを管理します。	拡張子	GA
az iot edge deployment create	ターゲット IoT Hub に IoT Edge デプロイを作成します。	拡張子	GA
az iot edge deployment delete	IoT Edge デプロイを削除します。	拡張子	GA
az iot edge deployment list	IoT Hub 内の IoT Edge デプロイを一覧表示します。	拡張子	GA
az iot edge deployment show	IoT Edge デプロイの詳細を取得します。	拡張子	GA
az iot edge deployment show-metric	IoT Edge デプロイで定義されているターゲットシステムメトリックを評価します。	拡張子	GA
az iot edge deployment update	IoT Edge デプロイの指定されたプロパティを更新します。	拡張子	GA
az iot edge devices	IoT Edge デバイスを管理するコマンド。	拡張子	GA
az iot edge devices create	IoT Hub で複数のエッジデバイスを作成して構成します。	拡張子	実験用
az iot edge export-modules	エッジモジュールの構成を 1 つのエッジデバイスにエクスポートします。	拡張子	GA
az iot edge set-modules	1 台のデバイスにエッジモジュールを設定します。	拡張子	GA

az iot edge export-modules

エッジモジュールの構成を 1 つのエッジデバイスにエクスポートします。

モジュールツイン構成出力は、"az iot edge set-modules" の --content として直接使用できます。

az iot edge export-modules --device-id
                           [--auth-type {key, login}]
                           [--hub-name]
                           [--login]
                           [--resource-group]

例

ターゲットデバイスでモジュールツイン構成をエクスポートします。

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

必須のパラメーター

--device-id -d

ターゲットデバイス ID。

省略可能のパラメーター

--auth-type

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

指定可能な値: key, login

規定値: key

--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 edge set-modules

1 台のデバイスにエッジモジュールを設定します。

モジュールのコンテンツは json であり、{"modulesContent":{...}} の形式です。または {"content":{"modulesContent":{...}}}。

システムモジュール$edgeAgentおよび$edgeHubの既定のプロパティは、IoT 拡張機能と共にインストールされたスキーマに対して検証されます。これは、--no-validation スイッチを使用して無効にすることができます。

注: コマンドを実行すると、デバイスに適用されたモジュールのコレクションが出力されます。

az iot edge set-modules --content
                        --device-id
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--resource-group]

例

ターゲットデバイスにモジュールを設定して、開発中にエッジモジュールをテストします。

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

必須のパラメーター

--content -k

IoT Edge のデプロイコンテンツ。ファイルパスまたは生の json を指定します。

--device-id -d

ターゲットデバイス 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 edge

コマンド

az iot edge export-modules

例

必須のパラメーター

省略可能のパラメーター

az iot edge set-modules

例

必須のパラメーター

省略可能のパラメーター

その他のリソース