az iot edge devices

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). az iot edge devices コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 Learn more about extensions.

IoT Edge デバイスを管理するコマンド。

コマンド

名前	説明	型	状態
az iot edge devices create	IoT Hub で複数のエッジデバイスを作成して構成します。	Extension	Experimental

az iot edge devices create

実験用

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

IoT Hub で複数のエッジデバイスを作成して構成します。

この操作では、インラインデバイス引数またはエッジデバイス構成ファイルを YAML または JSON 形式で受け入れます。インラインコマンド引数 ('--device-auth' など) が優先され、構成ファイルのプロパティが指定されている場合はオーバーライドされます。サンプル構成ファイルについては、 https://aka.ms/aziotcli-edge-devices-config この操作を完全に利用する方法の例とパラメーターの説明を確認します。

az iot edge devices create [--auth-type {key, login}]
                           [--cfg --config --config-file]
                           [--clean {false, true}]
                           [--dct --device-config-template]
                           [--dea --default-agent --default-edge-agent]
                           [--device]
                           [--device-auth --device-auth-type {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out --output-path]
                           [--rc --root-cert]
                           [--resource-group]
                           [--rk --root-key]
                           [--root-pass --rp]
                           [--vis --visualize {false, true}]
                           [--yes {false, true}]

例

対称キー認証を使用してエッジデバイスをいくつか作成する (既定)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

インライン引数を使用して、さまざまなエッジプロパティ構成で自己署名証明書認証を使用して、エッジデバイスのフラットリストを作成します。

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

ハブ上のすべての既存のデバイス ID を削除し、(進行状況バーと視覚化出力を含む) 構成ファイルに基づいて新しいデバイスを作成します。

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

カスタムモジュールデプロイを使用して入れ子になったエッジデバイスのグループを作成します。インライン引数を使用して、それぞれ 1 つの子デバイスを持つ 2 つの親デバイスを含みます。また、デバイス証明書バンドルの出力パスも指定します。

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

x509 認証を使用して、既存のルート CA を使用して単純な入れ子になったエッジデバイス構成を作成し、カスタムデバイスバンドルの出力パスを指定します。

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auth-type

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

プロパティ	値
Parameter group:	Access Control Arguments
規定値:	key
指定可能な値:	key, login

--cfg --config --config-file

デバイス構成ファイルへのパス。サンプル構成ファイル: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

新しいデバイスを作成する前に、ターゲットハブ内のすべてのデバイスを削除します。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--dct --device-config-template

エッジデバイス構成の基礎として使用する IoT Edge config.toml ファイルへのパス。

--dea --default-agent --default-edge-agent

作成された Edge デバイスの既定のエッジエージェント (個別に指定されていない場合)。

--device -d

作成するエッジデバイスのプロパティに対応するスペース区切りのキーと値のペア。次のキー値がサポートされています。id (device_id)、deployment (インライン json またはファイルへのパス)、hostname、parent (device_id)、edge_agent (イメージ URL)、および container_auth (インライン json またはファイルへのパス)。 --device は 1 回以上使用できます。完全なパラメーター使用法のヘルプ例を確認します。これらのパラメーターは、サンプル構成ファイルの対応する値も参照します:https://aka.ms/aziotcli-edge-devices-config。

--device-auth --device-auth-type

デバイスからハブへの承認メカニズム。

プロパティ	値
指定可能な値:	shared_private_key, x509_thumbprint

--hub-name -n

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--login -l

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

プロパティ	値
Parameter group:	IoT Hub Identifier Arguments

--out --output-path

出力デバイス構成バンドルへのディレクトリパス。この値を指定しない場合、ファイル出力は作成されません。

--rc --root-cert

入れ子になったエッジデバイス証明書に署名するためのルート公開キー証明書へのパス。

プロパティ	値
Parameter group:	Root Certificate Arguments

--resource-group -g

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

--rk --root-key

入れ子になったエッジデバイス証明書に署名するためのルート秘密キーへのパス。

プロパティ	値
Parameter group:	Root Certificate Arguments

--root-pass --rp

ルートキーのパスワード。

プロパティ	値
Parameter group:	Root Certificate Arguments

--vis --visualize -v

デバイスの視覚化と、さまざまなタスク (デバイスの作成、親の設定、構成の更新など) の進行状況を示します。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--yes -y

--clean スイッチを使用して既存のハブデバイスを削除する場合は、確認を求めないでください。

プロパティ	値
規定値:	False
指定可能な値:	false, true

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az iot edge devices

コマンド

az iot edge devices create

例

省略可能のパラメーター

フィードバック