次の方法で共有

az iot edge

Note

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

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

コマンド

名前 説明 型 状態
az iot edge deployment

大規模な IoT Edge デプロイを管理します。

 Extension GA
az iot edge deployment create

ターゲット IoT Hub に IoT Edge デプロイを作成します。

 Extension GA
az iot edge deployment delete

IoT Edge デプロイを削除します。

 Extension GA
az iot edge deployment list

IoT Hub 内の IoT Edge デプロイを一覧表示します。

 Extension GA
az iot edge deployment show

IoT Edge デプロイの詳細を取得します。

 Extension GA
az iot edge deployment show-metric

IoT Edge デプロイで定義されているターゲット システム メトリックを評価します。

 Extension GA
az iot edge deployment update

IoT Edge デプロイの指定されたプロパティを更新します。

 Extension GA
az iot edge devices

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

 Extension GA
az iot edge devices create

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

 Extension Experimental
az iot edge export-modules

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

 Extension GA
az iot edge set-modules

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

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

省略可能のパラメーター

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
--hub-name -n

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

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

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

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

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

グローバル パラメーター
--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 set-modules

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

モジュールのコンテンツは json であり、{"modulesContent":{...}} の形式です。 or {"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。

省略可能のパラメーター

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
--hub-name -n

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

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

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

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

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

グローバル パラメーター
--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