az image builder

コマンド

名前	説明	型	状態
az image builder cancel	イメージ テンプレートに基づいて実行時間の長いイメージ ビルドをキャンセルします。	Core	GA
az image builder create	イメージ ビルダー テンプレートを作成します。	Core	GA
az image builder customizer	イメージ ビルダー テンプレート カスタマイザーを管理します。	Core	GA
az image builder customizer add	イメージ ビルダー カスタマイザーをイメージ ビルダー テンプレートに追加します。	Core	GA
az image builder customizer clear	イメージ ビルダー テンプレートからすべてのイメージ ビルダー カスタマイザーを削除します。	Core	GA
az image builder customizer remove	イメージ ビルダー テンプレートからイメージ ビルダー カスタマイザーを削除します。	Core	GA
az image builder delete	イメージ ビルダー テンプレートを削除します。	Core	GA
az image builder error-handler	イメージ ビルダー テンプレートのエラー ハンドラーを管理します。	Core	GA
az image builder error-handler add	既存のイメージ ビルダー テンプレートにエラー ハンドラーを追加します。	Core	GA
az image builder error-handler remove	既存のイメージ ビルダー テンプレートからエラー ハンドラーを削除します。	Core	GA
az image builder error-handler show	既存のイメージ ビルダー テンプレートのエラー ハンドラーを表示します。	Core	GA
az image builder identity	イメージ ビルダー テンプレートの ID を管理します。	Core	GA
az image builder identity assign	既存のイメージ ビルダー テンプレートにマネージド ID を追加します。 現在、サポートされているユーザー ID は 1 つだけです。	Core	GA
az image builder identity remove	既存のイメージ ビルダー テンプレートからマネージド ID を削除します。	Core	GA
az image builder identity show	イメージ ビルダー テンプレートのマネージド ID を表示します。	Core	GA
az image builder list	イメージ ビルダー テンプレートを一覧表示します。	Core	GA
az image builder optimizer	イメージ ビルダー テンプレート オプティマイザーを管理します。	Core	GA
az image builder optimizer add	既存のイメージ ビルダー テンプレートにオプティマイザーを追加します。	Core	GA
az image builder optimizer remove	既存のイメージ ビルダー テンプレートからオプティマイザーを削除します。	Core	GA
az image builder optimizer show	既存のイメージ ビルダー テンプレートのオプティマイザーを表示します。	Core	GA
az image builder optimizer update	既存のイメージ ビルダー テンプレートからオプティマイザーを更新します。	Core	GA
az image builder output	イメージ ビルダー テンプレートの出力ディストリビューターを管理します。	Core	GA
az image builder output add	イメージ ビルダーの出力ディストリビューターをイメージ ビルダー テンプレートに追加します。	Core	GA
az image builder output clear	イメージ ビルダー テンプレートからすべてのイメージ ビルダー出力ディストリビューターを削除します。	Core	GA
az image builder output remove	イメージ ビルダー テンプレートからイメージ ビルダーの出力ディストリビューターを削除します。	Core	GA
az image builder output versioning	イメージ ビルダー テンプレートの出力バージョナーを管理します。	Core	GA
az image builder output versioning remove	指定した出力のすべてのバージョン管理オプションを削除します。	Core	GA
az image builder output versioning set	イメージ ビルダー テンプレートのイメージ ビルダー出力バージョナーを設定します。	Core	GA
az image builder output versioning show	指定した出力のバージョン管理オプションを表示します。	Core	GA
az image builder run	イメージ ビルダー テンプレートを作成します。	Core	GA
az image builder show	イメージ ビルダー テンプレートを表示します。	Core	GA
az image builder show-runs	イメージ ビルダー テンプレートの実行出力を表示します。	Core	GA
az image builder trigger	イメージ ビルダー テンプレート トリガーを管理します。	Core	GA
az image builder trigger create	指定した仮想マシン イメージ テンプレートのトリガーを作成します。	Core	GA
az image builder trigger delete	指定した仮想マシン イメージ テンプレートのトリガーを削除します。	Core	GA
az image builder trigger list	指定したイメージ テンプレート リソースのすべてのトリガーを一覧表示します。	Core	GA
az image builder trigger show	指定したイメージ テンプレート リソースの指定したトリガーを取得します。	Core	GA
az image builder trigger wait	条件が満たされるまで CLI を待機状態にします。	Core	GA
az image builder update	イメージ ビルダー テンプレートを更新します。	Core	GA
az image builder validator	イメージ ビルダー テンプレートの検証を管理します。	Core	GA
az image builder validator add	既存のイメージ ビルダー テンプレートに検証を追加します。	Core	GA
az image builder validator remove	既存のイメージ ビルダー テンプレートから検証を削除します。	Core	GA
az image builder validator show	既存のイメージ ビルダー テンプレートの検証を表示します。	Core	GA
az image builder wait	テンプレートの条件が満たされるまで、CLI を待機状態にします。	Core	GA

az image builder cancel [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

例

イメージビルドをキャンセルします。

az image builder cancel -n mytemplate -g my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder create --name
                        --resource-group
                        [--build-timeout]
                        [--build-vm-identities]
                        [--checksum]
                        [--defer]
                        [--identity]
                        [--image-source]
                        [--image-template]
                        [--location]
                        [--managed-image-destinations]
                        [--no-wait]
                        [--os-disk-size]
                        [--proxy-vm-size]
                        [--scripts]
                        [--shared-image-destinations]
                        [--staging-resource-group]
                        [--subnet]
                        [--tags]
                        [--validator]
                        [--vm-size]
                        [--vnet]

例

Ubuntu2204 イメージからイメージ ビルダー テンプレートを作成します。 マネージド イメージと共有イメージ ギャラリー イメージ バージョンとして配布します。 イメージのビルドに使用するイメージ テンプレートとして、ステージング リソース グループ ID を指定します。

scripts="https://my-script-url.net/customize_script.sh"
imagesource="Canonical:0001-com-ubuntu-server-jammy:22_04-lts-gen2:latest"

az image builder create --image-source $imagesource -n myTemplate -g myGroup \
    --scripts $scripts --managed-image-destinations image_1=westus \
    --shared-image-destinations my_shared_gallery/linux_image_def=westus,brazilsouth \
    --identity myIdentity --staging-resource-group myStagingResourceGroup

イメージ テンプレート ファイルを使用してイメージ ビルダー テンプレートを作成します。

az image builder create -g my-group -n myTemplate --image-template filename

[詳細設定]--defer を使用して、CLI のオブジェクト キャッシュを使用して、複数のカスタマイザーとディストリビューターを含むイメージ テンプレートを作成します。 カスタマイザーと出力名、PowerShell 終了コード、インライン スクリプト、Windows 再起動、ファイル カスタマイザー、アーティファクト タグ、vhd 出力ディストリビューターなどの機能をサポートします。

script="https://my-script-url.com/customize_script.ps1"
imagesource="MicrosoftWindowsServer:WindowsServer:2019-Datacenter:2019.0.20190214"

# create and update template object in local cli cache. Defers put request to ARM
# Cache object ttl set via az configure.
az image builder create --image-source $imagesource -n myTemplate \
    -g myGroup --scripts $script --identity myIdentity --defer

# add customizers
az image builder customizer add -n myTemplate -g myGroup  \
    --customizer-name myPwshScript --exit-codes 0 1 --inline-script \
    "mkdir c:\buildActions" "echo Azure-Image-Builder-Was-Here \
     > c:\buildActions\Output.txt" --type powershell --defer

az image builder customizer add -n myTemplate -g myGroup \
    --customizer-name myFileCustomizer --type file \
    --file-source "https://my-file-source.net/file.txt"  \
    --dest-path "c:\buildArtifacts\file.txt" --defer

# add distributors
az image builder output add -n myTemplate -g myGroup --is-vhd \
    --output-name myWinImageVhd --artifact-tags "is_vhd=True" --defer

az image builder output add -n myTemplate -g myGroup \
    --output-name myWinImageManaged --managed-image winImage \
    --managed-image-location eastus \
    --artifact-tags "is_vhd=False" --defer

# Stop deferring put request to ARM. Create the template from the object cache.
# Cache object will be deleted.
az image builder update -n myTemplate -g myGroup

必須のパラメーター

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

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 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

az image builder delete [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

例

イメージ ビルダー テンプレートを削除します。 (autogenerated)

az image builder delete --name MyImageTemplate --resource-group MyResourceGroup

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder list [--resource-group]

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

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 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

az image builder run [--ids]
                     [--name]
                     [--no-wait]
                     [--resource-group]
                     [--subscription]

例

テンプレート ビルドの実行を開始し、完了するまで待ちます。

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show -n mytemplate -g my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

例

イメージ ビルダー テンプレートを表示する (自動生成)

az image builder show --name mytemplate  --resource-group my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder show-runs [--ids]
                           [--name]
                           [--output-name]
                           [--resource-group]
                           [--subscription]

例

テンプレート ビルド実行を実行し、その実行出力を表示します。

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show-runs -n mytemplate -g my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder update [--add]
                        [--defer]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]

例

cli キャッシュ内のテンプレート オブジェクトからテンプレート リソースを作成します。 詳細については、「az image builder create/output add/customizer add --help」および「az cache -h」を参照してください

# create and write template object to local cli cache
az image builder create --image-source {image_source} -n mytemplate -g my-group \
    --scripts {script} --managed-image-destinations image_1=westus --identity myidentity --defer

# add customizers and outputs to local cache template object via az image template output / customizer add
# one can also update cache object properties through generic update options, such as: --set
az image builder output add -n mytemplate -g my-group --output-name my-win-image-managed \
    --artifact-tags "is_vhd=False"  --managed-image winImage --managed-image-location eastus --defer

# send template create request to azure to create template resource
az image builder update -n mytemplate -g my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az image builder wait [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--timeout]
                      [--updated]

例

テンプレート ビルドの実行を開始し、完了するまで待ちます。

az image builder run -n mytemplate -g my-group --no-wait

az image builder wait -n mytemplate -g aibmdi \
    --custom "lastRunStatus.runState!='Running'"

az image builder show -n mytemplate -g my-group

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

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False