az iot du update init

Note

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

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

インポート マニフェストの初期化のためのユーティリティ。

コマンド

Name 説明 型 状態
az iot du update init v5

目的の状態で v5 インポート マニフェストを初期化します。

Extension Preview

az iot du update init v5

プレビュー

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

目的の状態で v5 インポート マニフェストを初期化します。

このコマンドは、v5 インポート マニフェストのすべての属性をサポートします。 --stepと--fileの間には、--fileと--related-fileの位置の感度があることに注意してください。 操作を完全に利用する方法の詳細については、例とパラメーターの説明を確認してください。

さまざまなシェルで引用符とエスケープ文字を使用する方法の詳細については、 https://aka.ms/aziotcli-jsonを参照してください。

az iot du update init v5 --compat
                         --step
                         --update-name
                         --update-provider
                         --update-version
                         [--acquire-policy-token]
                         [--change-reference]
                         [--description]
                         [--file]
                         [--is-deployable {false, true}]
                         [--no-validation {false, true}]
                         [--related-file]

例

最小限のコンテンツ インポート マニフェストを初期化します。 'bash' 用に最適化されたインライン json。

az iot du update init v5 --update-provider Microsoft --update-name myAptUpdate --update-version 1.0.0 --description "My minimum update" --compat manufacturer=Contoso model=Vacuum --step handler=microsoft/apt:1 properties='{"installedCriteria": "1.0"}' --file path=/my/apt/manifest/file

最小限のコンテンツ インポート マニフェストを初期化します。 'powershell' 用に最適化されたインライン json。

az iot du update init v5 --update-provider Microsoft --update-name myAptUpdate --update-version 1.0.0 --description "My minimum update" --compat manufacturer=Contoso model=Vacuum --step handler=microsoft/apt:1 properties='{\"installedCriteria\": \"1.0\"}' --file path=/my/apt/manifest/file

最小限のコンテンツ インポート マニフェストを初期化します。 'cmd' 用に最適化されたインライン json。

az iot du update init v5 --update-provider Microsoft --update-name myAptUpdate --update-version 1.0.0 --description "My minimum update" --compat manufacturer=Contoso model=Vacuum --step handler=microsoft/apt:1 properties="{\"installedCriteria\": \"1.0\"}" --file path=/my/apt/manifest/file

最小限のコンテンツ インポート マニフェストを初期化します。 json のファイル入力を使用します。

az iot du update init v5 --update-provider Microsoft --update-name myAptUpdate --update-version 1.0.0 --description "My minimum update" --compat manufacturer=Contoso model=Vacuum --step handler=microsoft/apt:1 properties="@/path/to/file" --file path=/my/apt/manifest/file

バンドルされた更新プログラムで参照されるように、展開不可能なリーフ更新を初期化します。 'bash' 用に最適化されたインライン json。

az iot du update init v5 --update-provider Microsoft --update-name mySwUpdate --update-version 1.1.0 --compat manufacturer=Contoso model=Microphone --step handler=microsoft/swupdate:1 description="Deploy Update" properties='{"installedCriteria": "1.0"}' --file path=/my/update/image/file1 --file path=/my/update/image/file2 --is-deployable false

リーフ更新を参照し、独立した手順を定義するバンドルされた更新プログラムを初期化します。 コマンド継続を使用してインポート マニフェスト セグメントを示すために 'bash' 用に最適化された例。

az iot du update init v5 \
--update-provider Microsoft --update-name myBundled --update-version 2.0 \
--compat manufacturer=Contoso model=SpaceStation \
--step handler=microsoft/script:1 properties='{"arguments": "--pre"}' description="Pre-install script" \
--file path=/my/update/scripts/preinstall.sh downloadHandler=microsoft/delta:1 \
--related-file path=/my/update/scripts/related_preinstall.json properties='{"microsoft.sourceFileHashAlgorithm": "sha256"}' \
--step updateId.provider=Microsoft updateId.name=SwUpdate updateId.version=1.1 \
--step handler=microsoft/script:1 properties='{"arguments": "--post"}' description="Post-install script" \
--file path=/my/update/scripts/postinstall.sh

必須パラメーター

--compat

この更新プログラムと互換性のあるデバイスのプロパティに対応するスペース区切りのキーと値のペア。 通常、製造元やモデルなどのプロパティを定義するために使用されます。 --compat は 1 回以上使用できます。

--step

'instructions.steps' 要素プロパティに対応するスペース区切りの key=value ペア。 クライアントは、指定されたキー値ペアに基づいて、ステップがインラインステップか参照ステップかを判断します。 インラインまたは参照のいずれかのステップが満たされる場合は、参照ステップが優先されます。 --file の使用法は、最も近いインライン --step エントリに関連付けされ、'files' の値が派生します。 次の参照ステップ キーがサポートされています:updateId.provider、updateId.name、updateId.version、description。 次のインライン ステップ キーがサポートされています。handler (例: 'microsoft/script:1' または 'microsoft/swupdate:1' または 'microsoft/apt:1')、properties (エージェントがハンドラーに渡すインライン json オブジェクト)、および description。 --step は 1 回以上使用できます。

--update-name

updateId のコンポーネントとしての更新プログラム名。

--update-provider

updateId のコンポーネントとしての更新プロバイダー。

--update-version

updateId のコンポーネントとしての更新バージョン。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--description

インポート マニフェストの説明。

--file

'files' 要素プロパティに対応するスペース区切りのキーと値のペア。 --file エントリには、指定された場合、最も近い --related-file エントリを含めることができます。 次のキーがサポートされています。 path [必須] ローカル ファイル パスを更新するには、downloadHandler (例: 'microsoft/delta:1') ハンドラーを使用して関連ファイルを使用してペイロード ファイルをダウンロード properties (エージェントがハンドラーに渡すインライン json オブジェクト)。 --file は 1 回以上使用できます。

--is-deployable

更新プログラムが個別に展開可能かどうかを示します。

プロパティ 値
指定可能な値: false, true
--no-validation

インポート マニフェスト コンテンツのクライアント側 json スキーマ検証を無効にします。

プロパティ 値
指定可能な値: false, true
--related-file

'files[*].relatedFiles' 要素プロパティに対応するスペース区切りの key=value ペア。 関連ファイル エントリが存在する場合は、最も近い --file エントリに関連付けられます。 次のキーがサポートされています。関連する更新ファイルへの path [必須] ローカル ファイル パス、properties (ダウンロード ハンドラーに渡されるインライン json オブジェクト)。 --related-file は 1 回以上使用できます。

グローバル パラメーター
--debug

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

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: 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