az iot edge deployment

Note

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

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

コマンド

名前	説明	型	Status
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 deployment create

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

デプロイ コンテンツは json であり、{"modulesContent":{...}} の形式です。 または {"content":{"modulesContent":{...}}}。

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

モジュールに properties.desired.* が定義されている場合、エッジデプロイは階層化として分類されます。 階層展開の対象となるエッジ デバイスには、まず基本デプロイを適用する必要があります。

デバイスを対象とする階層展開は、そのデバイスの基本デプロイよりも優先順位が高い必要があります。

注: モジュール ツインの properties.desired フィールドが階層展開で設定されている場合、properties.desired は優先順位の低いデプロイでそのモジュールの必要なプロパティを上書きします。

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

例

'building 9' のデバイスに適用されるラベル (bash 構文の例) を使用してデプロイを作成し、環境が 'test' です。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

環境 'dev' でタグ付けされたデバイスに適用されるラベル (powershell 構文の例) を使用してデプロイを作成します。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

環境 'dev' でタグ付けされたデバイスに適用される階層展開を作成します。 ユーザー メトリックとモジュールコンテンツの両方がインラインで定義されています (powershell 構文の例)。 これは、properties.desired.* が定義されている階層展開形式であることに注意してください。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

'building 9' および環境 'test' のデバイスに適用される階層展開を作成します。 ユーザー メトリックとモジュールコンテンツの両方がインラインで定義されています (bash 構文の例)。 これは、properties.desired.* が定義されている階層展開形式であることに注意してください。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

'building 9' および環境 'test' のデバイスに適用されるデプロイを作成します。 ファイルから定義されたユーザー メトリックとモジュールコンテンツの両方。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

ラベルとメトリックのシェルに依存しない入力を使用して、ファイルからの定義を持つデプロイを作成します。

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

必須のパラメーター

--content -k

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

--deployment-id -d

ターゲットデプロイ名。 小文字と次の特殊文字を使用できます: [-+%_*!]。

省略可能のパラメーター

--auth-type

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

承認された値: key, login

既定値: key

--cl --custom-labels

--labels の代替入力スタイル (スペース区切りのキーと値のペア)。将来置き換えることを目的としています。 形式の例: key1=value1 key2="this is my value"。

--cmq --custom-metric-queries

--metrics 用の代替入力スタイル (スペース区切りのキーと値のペア)。将来的に置き換えることを目的としています。 形式の例: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

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

--lab --labels

ターゲットデプロイに適用されるラベルのマップ。 '{"key0":"value0", "key1":"value1"}' の形式を使用します。 --labels の代わりに --custom-labels を使用することをお勧めします。

--layered

階層展開を使用すると、基本デプロイの上に重ねて配置する$edgeAgent、$edgeHub、およびユーザー モジュールで必要なプロパティを定義できます。 階層展開で指定されたプロパティは、基本配置のプロパティとマージされます。 同じパスを持つプロパティは、デプロイの優先順位に基づいて上書きされます。 このオプションは、--no-validation のエイリアスです。

承認された値: false, true

既定値: False

--login -l

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

--metrics -m

IoT Edge デプロイ のユーザー メトリック定義。 ファイル パスまたは生の json を指定します。 ユーザー メトリックは {"queries":{...}} の形式です。 または {"metrics":{"queries":{...}}}。 --metrics の代わりに --custom-metric-queries を使用することをお勧めします。

--no-validation

エッジデプロイの作成に対するクライアント側スキーマ検証を無効にします。

承認された値: false, true

既定値: False

--pri --priority

競合するルール (最高の勝利) の場合のデプロイの重み。

既定値: 0

--resource-group -g

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

--target-condition --tc -t

エッジデプロイが適用されるターゲット条件。 ターゲット条件のないデプロイでは、デバイスはターゲットとされません。 "tags.environment='test'" の形式を使用します。

グローバル パラメーター

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

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

az iot edge deployment delete --deployment-id
                              [--auth-type {key, login}]
                              [--etag]
                              [--hub-name]
                              [--login]
                              [--resource-group]

必須のパラメーター

--deployment-id -d

ターゲットデプロイ名。 小文字と次の特殊文字を使用できます: [-+%_*!]。

省略可能のパラメーター

--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 edge deployment list

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

az iot edge deployment list [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

省略可能のパラメーター

--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> を使用して、既定のグループを構成できます。

--top

返されるデプロイの最大数。 既定では、すべてのデプロイが返されます。

グローバル パラメーター

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

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

az iot edge deployment show --deployment-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

必須のパラメーター

--deployment-id -d

ターゲットデプロイ名。 小文字と次の特殊文字を使用できます: [-+%_*!]。

省略可能のパラメーター

--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 deployment show-metric

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

az iot edge deployment show-metric --deployment-id
                                   --metric-id
                                   [--auth-type {key, login}]
                                   [--hub-name]
                                   [--login]
                                   [--metric-type {system, user}]
                                   [--resource-group]

例

"appliedCount" システム メトリックを評価する

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

"myCustomMetric" ユーザー メトリックを評価する

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

必須のパラメーター

--deployment-id -d

ターゲットデプロイ名。 小文字と次の特殊文字を使用できます: [-+%_*!]。

--metric-id -m

評価のターゲット メトリック。

省略可能のパラメーター

--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 が指定されていない場合は必須です。

--metric-type --mt

メトリックの検索に使用するメトリック コレクションを示します。

承認された値: system, user

既定値: user

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

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

展開を更新するために、--set の後にプロパティの割り当てを使用します。

注: IoT Edge のデプロイ コンテンツは不変です。 更新できる展開プロパティは、"ラベル"、"メトリック"、"優先度"、"targetCondition" です。

az iot edge deployment update --deployment-id
                              [--add]
                              [--auth-type {key, login}]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]

例

既存のエッジ デプロイのラベルとターゲット条件を変更する

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

必須のパラメーター

--deployment-id -d

ターゲットデプロイ名。 小文字と次の特殊文字を使用できます: [-+%_*!]。

省略可能のパラメーター

--add

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

既定値: []

--auth-type

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

承認された値: key, login

既定値: key

--etag -e

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

--force-string

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

既定値: False

--hub-name -n

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

--login -l

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

--remove

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

既定値: []

--resource-group -g

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

--set

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

既定値: []

グローバル パラメーター

--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 を使います。