az iot edge deployment

注意

このリファレンスは Azure CLI 用の azure iot 拡張機能の一部であり、バージョン2.17.1 以降が必要です。 この拡張機能は、 az iot edge deployment コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細を参照してください

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

コマンド

az iot edge deployment create

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

az iot edge deployment delete

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

az iot edge deployment list

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

az iot edge deployment show

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

az iot edge deployment show-metric

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

az iot edge deployment update

IoT Edge の展開の指定したプロパティを更新します。

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

注: IoT Edge 展開コンテンツは変更できません。 更新可能な展開のプロパティは、' labels '、' metrics '、' priority '、' targetCondition ' です。

az iot edge deployment create

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

デプロイコンテンツは json で、{"モジュールコンテンツ": {...}} という形式になっています または {"content": {"モジュールコンテンツ": {...}}}。

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

エッジデプロイは、ユーザー定義メトリックを使用して、要求時評価用に作成できます。 ユーザーメトリックは json で、{"queries": {...}} という形式になっています。 または {"metrics": {"queries": {...}}}。

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

"ビル 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 構文の例)。

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'}}" --layered

' ビル 9 ' と環境 ' test ' のデバイスに適用されるレイヤーデプロイを作成します。 ユーザーメトリックとモジュールの両方のコンテンツがインラインで定義されています (bash 構文の例)。

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"}}' --layered

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

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

必須のパラメーター

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

IoT Hub 名。

--lab --labels

ターゲットの配置に適用されるラベルのマップ。 次の形式を使用します: ' {"key0": "value0", "key1": "value1"} '。

--layered

階層化されたデプロイでは、基本デプロイの上にレイヤーを配置する $edgeAgent、$edgeHub、ユーザーモジュールで、必要なプロパティを定義できます。 たとえば、階層型デプロイで指定されたルートは、基本デプロイのルートとマージされます。 同じ名前のルートは、展開の優先順位に基づいて上書きされます。

承認された値: false, true
--login -l

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

--metrics -m

展開メトリックの定義を IoT Edge します。 ファイルパスまたは未加工の json を指定します。

--no-validation

エッジ展開の作成でのクライアント側のスキーマ検証を無効にします。

承認された値: false, true
--pri --priority

ルールの競合が発生した場合の展開の重み (最高の優先度)。

--resource-group -g

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

--target-condition --tc -t

エッジ展開が適用されるターゲット条件。

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

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

--resource-group -g

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

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

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

--resource-group -g

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

--top

返される配置の最大数。 既定では、すべての展開が返されます。

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

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

--resource-group -g

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

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]

' コンピューターの数 ' システムメトリックを評価します

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

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

--metric-type --mt

メトリックを参照するために使用するメトリックコレクションを示します。

承認された値: system, user
既定値: user
--resource-group -g

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

az iot edge deployment update

IoT Edge の展開の指定したプロパティを更新します。

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

注: IoT Edge 展開コンテンツは変更できません。 更新可能な展開のプロパティは、' labels '、' metrics '、' priority '、' 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、または 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 への変換を試みる代わりに文字列リテラルを保持します。

--hub-name -n

IoT Hub 名。

--login -l

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

--remove

プロパティまたは要素をリストから削除します。 例:--プロパティを削除します。リスト または--propertyToRemove を削除します。

--resource-group -g

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

--set

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