az iot du update

Note

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

デバイス更新プログラムの更新管理。

コマンド

名前	説明	型	状態
az iot du update calculate-hash	ファイルの base64 ハッシュ表現を計算します。	拡張子	GA
az iot du update delete	特定の更新バージョンを削除します。	拡張子	GA
az iot du update file	ファイル操作を更新します。	拡張子	GA
az iot du update file list	更新プロバイダー、名前、およびバージョンに関する更新ファイル ID を一覧表示します。	拡張子	GA
az iot du update file show	更新プロバイダー、名前、およびバージョンに関する特定の更新ファイルの詳細を表示します。	拡張子	GA
az iot du update import	Device Update インスタンスに新しい更新バージョンをインポートします。	拡張子	GA
az iot du update init	インポート マニフェストの初期化のためのユーティリティ。	拡張子	プレビュー
az iot du update init v5	目的の状態で v5 インポート マニフェストを初期化します。	拡張子	プレビュー
az iot du update list	Device Update インスタンスにインポートされた更新プログラムを一覧表示します。	拡張子	GA
az iot du update show	特定の更新プログラムのバージョンを表示します。	拡張子	GA
az iot du update stage	ターゲット インスタンスにインポートするための更新プログラムをステージングします。	拡張子	プレビュー

az iot du update calculate-hash

ファイルの base64 ハッシュ表現を計算します。

az iot du update calculate-hash --file-path
                                [--hash-algo {sha256}]

例

ターゲット更新ファイルの sha256 ダイジェストの base64 表現を計算します。

az iot du update calculate-hash --file-path /path/to/file

複数のターゲット更新ファイルの sha256 ダイジェストの base64 表現を計算します。

az iot du update calculate-hash --file-path /path/to/file1 --file-path /path/to/file2 --file-path /path/to/file3

必須のパラメーター

--file-path -f

ハッシュ計算用のターゲット ファイルへのローカル パス。 --file-path は 1 回以上使用できます。

省略可能のパラメーター

--hash-algo

ハッシュに使用する暗号化アルゴリズム。

指定可能な値: sha256

規定値: sha256

グローバル パラメーター

--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 du update delete

特定の更新バージョンを削除します。

az iot du update delete --account
                        --instance
                        --un
                        --up
                        --update-version
                        [--no-wait]
                        [--resource-group]
                        [--yes {false, true}]

例

更新プロバイダー、名前、バージョンに関するターゲット更新プログラムを削除します。

az iot du update delete -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {update_version}

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--instance -i

デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

--un --update-name

更新プログラムの名前。

--up --update-provider

更新プロバイダー。

--update-version --uv

更新プログラムのバージョン。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--yes -y

ユーザー プロンプトをスキップします。 アクションの受け入れを示します。 主に自動化シナリオに使用されます。 既定値は false です。

指定可能な値: false, true

グローバル パラメーター

--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 du update import

Device Update インスタンスに新しい更新バージョンをインポートします。

このコマンドは、この機能を --defer サポートします。 このコマンドを使用すると、Azure に送信されることを意図したオブジェクト ペイロードがローカル キャッシュに格納されます。 このコマンドを使用しない --defer 次の使用では、新しい要求ペイロードと、それらを一緒に送信するキャッシュされたオブジェクトが組み合わされます。

成功すると、対応するローカル キャッシュ エントリが消去されます。 エラーが発生した場合、キャッシュされたコンテンツは削除されません。 コマンドを使用して az cache 、ローカル キャッシュ エントリを個別に管理します。

遅延サポートは、親と子の更新を一緒に送信できるように、主に複数の参照手順を含む更新プログラムを対象としています。

az iot du update import --account
                        --instance
                        --url
                        [--defer]
                        [--file]
                        [--friendly-name]
                        [--hashes]
                        [--no-wait]
                        [--resource-group]
                        [--size]

例

2 つの関連ファイルと参照手順を含まない更新プログラムをインポートします。マニフェスト ハッシュ値とマニフェスト サイズを明示的にバイト単位で指定します。

az iot du update import -n {account_name} -i {instance_name} --hashes sha256={hash_value} --size {size_in_bytes} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

2 つの関連ファイルと参照ステップのない更新プログラムをインポートします。これにより、CLI はインポート マニフェストのハッシュ値とサイズをバイト単位で計算できます。

az iot du update import -n {account_name} -i {instance_name} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

2 つの子更新の参照手順を使用して親更新プログラムをインポートします。3 つのインポート マニフェストはすべて、1 つの関連ファイルを持ちます。 CLI ですべてのハッシュ値とサイズをバイト単位で計算します。 この操作は、"--defer" 機能に依存します。

az iot du update import -n {account_name} -i {instance_name} --url {parent_manifest_location} --file filename={parent_file_name} url={parent_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child1_manifest_location} --file filename={child1_file_name} url={child1_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child2_manifest_location} --file filename={child2_file_name} url={child2_file_url}

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--instance -i

デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

--url

Device Update for IoT Hub によってインポート マニフェストをダウンロードできるルーティング可能な場所。 これは通常、有効期限が少なくとも 3 時間に設定された読み取り専用の SAS で保護された BLOB URL です。

省略可能のパラメーター

--defer

オブジェクトを Azure に送信するのではなく、ローカル キャッシュに一時的に格納します。 コマンドを使用して az cache 表示/クリアします。

--file

マニフェスト メタデータ ファイルのプロパティのインポートに対応するスペース区切りのキーと値のペア。 必要なキーには、ファイル名と URL が含まれます。 --file は 1 回以上使用できます。

--friendly-name

更新定義に関連付けられているフレンドリ名。

--hashes

キーが使用されるハッシュ アルゴリズムであり、値が base64 でエンコードされたインポート マニフェスト ファイル ハッシュである、スペース区切りのキーと値のペア。 少なくとも sha256 エントリが必要です。 指定しない場合は、指定された URL から計算されます。

--no-wait

実行時間の長い操作の終了を待機しません。

規定値: False

--resource-group -g

Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--size

ファイルサイズ (バイト数)。 指定しない場合は、指定された URL から計算されます。

グローバル パラメーター

--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 du update list

Device Update インスタンスにインポートされた更新プログラムを一覧表示します。

更新プロバイダーを一覧表示する場合は、共通インスタンスの検索引数に加えて、プロバイダーごとのフラグのみを指定する必要があります。 更新プログラム名を一覧表示するときは、更新プロバイダーを指定する必要があります。 更新プログラムのバージョンを一覧表示するときは、更新プロバイダーと更新プログラムの名前を指定する必要があります。

az iot du update list --account
                      --instance
                      [--by-provider {false, true}]
                      [--filter]
                      [--resource-group]
                      [--search]
                      [--un]
                      [--up]

例

すべての更新プログラムを一覧表示します。

az iot du update list -n {account_name} -i {instance_name}

自由形式の検索条件 (この場合は Contoso の更新プロバイダー) を満たすすべての更新プログラムを一覧表示します。

az iot du update list -n {account_name} -i {instance_name} --search 'Contoso'

odata フィルターを満たすすべての更新プログラムを一覧表示します。この場合は、展開不可能な更新プログラムをフィルター処理します。

az iot du update list -n {account_name} -i {instance_name} --filter 'isDeployable eq false'

すべての更新プロバイダーを一覧表示します。

az iot du update list -n {account_name} -i {instance_name} --by-provider

更新プロバイダーごとにすべての更新プログラム名を一覧表示します。

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name}

更新プロバイダーと更新プログラムの名前で、すべての更新バージョンを一覧表示します。

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name}

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--instance -i

デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

省略可能のパラメーター

--by-provider

結果セットを更新プロバイダーに制限する必要があることを示すフラグ。

指定可能な値: false, true

--filter

プロパティ値によって返される更新のセットを制限します。 制約のない更新プログラムを一覧表示する場合、またはバージョン別に一覧表示する場合にサポートされます。

--resource-group -g

Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--search

自由テキスト検索式に一致する更新を要求します。 制約のない更新プログラムを一覧表示する場合にサポートされます。

--un --update-name

更新プログラムの名前。

--up --update-provider

更新プロバイダー。

グローバル パラメーター

--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 du update show

特定の更新プログラムのバージョンを表示します。

az iot du update show --account
                      --instance
                      --un
                      --up
                      --update-version
                      [--resource-group]

例

更新プロバイダー、名前、バージョンに関する特定の更新プログラムを表示します。

az iot du update show -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {update_version}

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--instance -i

デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

--un --update-name

更新プログラムの名前。

--up --update-provider

更新プロバイダー。

--update-version --uv

更新プログラムのバージョン。

省略可能のパラメーター

--resource-group -g

Device Update アカウントのリソース グループ名。 az config set defaults.adu_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 du update stage

プレビュー

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

ターゲット インスタンスにインポートするための更新プログラムをステージングします。

更新プログラムのステージングとは、ターゲット インスタンスに更新プログラムをインポートするための前提条件の手順を加速することを指します。 特定のインポート マニフェストでは、プロセスによって関連するファイルが決定され、目的のストレージ コンテナーにプッシュされ、SAS URI が生成され、正常なインポートのためのその他の準備手順が説明されます。

このコマンドは、更新ファイルの規則に基づく編成に依存します。 ターゲット マニフェストのすべての更新ファイルは、インポート マニフェストが存在するのと同じディレクトリ内にある必要があります。

キー ベースのアクセスは、BLOB アーティファクトをアップロードし、読み取りアクセス権を持つ 3 時間の期間の SAS URI を生成するために使用されます。

フラグが指定されている場合 --then-import 、コマンドはステージングされた更新プログラムをインポートします。 それ以外の場合、この操作の結果は、後で同じ結果を得るために実行するインポート コマンドです。

このコマンドは、ターゲット インスタンスのローカル キャッシュ エントリを消去して更新します。

az iot du update stage --account
                       --instance
                       --manifest-path
                       --storage-account
                       --storage-container
                       [--friendly-name]
                       [--overwrite {false, true}]
                       [--resource-group]
                       [--storage-subscription]
                       [--then-import {false, true}]

例

スタンドアロン更新プログラムをステージングします。 更新ファイルは、マニフェストと同じディレクトリに存在する必要があります。 結果のインポート コマンドは、後で実行して、SAS トークンの有効期限が切れる前にステージングされた更新プログラムのインポートを開始できます。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json

スタンドアロン更新プログラムをステージングします。 ステージング後、目的のフレンドリ名を使用してインスタンスに更新プログラムをインポートします。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json --then-import --friendly-name myAptUpdate

複数参照の更新をステージングします。 更新ファイルは、更新アカウントの別のサブスクリプションに存在するストレージ BLOB コンテナーにアップロードされます。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --storage-subscription {storage_account_subscription} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json

複数参照更新をステージングし、既存の BLOB が存在する場合は上書きします。 ステージング後、更新プログラムをインスタンスにインポートします。

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json --then-import --overwrite

必須のパラメーター

--account -n

Device Update アカウント名。 を使用して、既定のアカウント名を az config set defaults.adu_account=<name>構成できます。

--instance -i

デバイス更新インスタンス名。 を使用して、既定のインスタンス名を az config set defaults.adu_instance=<name>構成できます。

--manifest-path

ステージングする必要があるインポート マニフェストへのローカル ファイル パス。 1回以上使用できます。

--storage-account

インポート マニフェスト成果物をステージングするために必要なストレージ アカウント名。

--storage-container

インポート マニフェスト成果物をステージングするために必要なストレージ コンテナー名。

省略可能のパラメーター

--friendly-name

更新定義に関連付けられているフレンドリ名。

--overwrite

競合が存在する場合に既存の BLOB を上書きするかどうかを示すフラグ。

指定可能な値: false, true

規定値: False

--resource-group -g

Device Update アカウントのリソース グループ名。 az config set defaults.adu_group=<name> を使用して、既定のグループを構成できます。

--storage-subscription

マニフェスト成果物のインポートをステージングするための目的のストレージ アカウント サブスクリプション。 ストレージアカウントとデバイス更新アカウントが異なるサブスクリプションにある場合に適用されます。

--then-import

ステージング後に更新プログラムをインポートするかどうかを示すフラグ。

指定可能な値: false, true

グローバル パラメーター

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