az image builder

イメージ ビルダー テンプレートを管理およびビルドします。

コマンド

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

az image builder cancel

イメージ テンプレートに基づいて実行時間の長いイメージ ビルドをキャンセルします。

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

例

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

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

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder create

イメージ ビルダー テンプレートを作成します。

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

必須のパラメーター

--name -n

イメージ テンプレートの名前。

--resource-group -g

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

省略可能のパラメーター

--build-timeout

イメージ テンプレートのビルド中に待機する最大時間 (分単位)。 既定値は 60 です。

--build-vm-identities

ビルド仮想マシンのデプロイに使用する仮想ネットワークのオプション構成。 特定の仮想ネットワークを使用する必要がない場合は省略します。

--checksum

Red Hat ISO イメージの SHA256 チェックサム。

--defer

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

--identity

イメージ テンプレートのユーザー割り当て ID (名前または ID、スペース区切り) の一覧。

--image-source -i

カスタマイズする基本イメージ。 有効なプラットフォーム イメージ URN、プラットフォーム イメージエイリアス、Red Hat ISO イメージ URI、マネージド イメージ名/ID、または共有イメージ バージョン ID である必要があります。

値の取得元: az vm image list, az vm image show

--image-template

イメージ テンプレート ファイルへのローカル パスまたは URL。 --image-template を使用する場合、-g と -n を除く他のすべてのパラメーターは無視されます。 リファレンス: https://learn.microsoft.com/azure/virtual-machines/linux/image-builder-json.

--location -l

場所。 値の取得場所: az account list-locations. az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--managed-image-destinations

マネージド イメージ出力ディストリビューター情報。 キーと値のペアのスペース区切りのリスト。 例: "image_1=westus2 image_2=westus"。 各キーは、作成するマネージド イメージの名前またはリソース ID です。 各値はイメージの場所です。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

規定値: False

--os-disk-size

OS ディスクのサイズ (GB 単位)。 Azure の既定の OS ディスク サイズを使用するには、0 を省略するか指定します。

--proxy-vm-size

イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4)。

--scripts

イメージをカスタマイズするためのシェルまたは PowerShell スクリプトのスペース区切りの一覧。 各スクリプトは、パブリックにアクセスできる URL である必要があります。 ファイル拡張子 ('.sh' または '.ps1') またはソースの種類からスクリプトの種類を推論します。 より多くのカスタマイザー オプションと柔軟性については、「az image template customizer add」を参照してください。

--shared-image-destinations

共有イメージ ギャラリー (sig) 出力ディストリビューター情報。 キーと値のペアのスペース区切りのリスト。 例: "my_gallery_1/image_def_1=eastus,westus my_gallery_2/image_def_2=uksouth,canadaeast,francesouth"各キーは、"/" で区切られた sig イメージ定義 ID または sig ギャラリー名と sig イメージ定義です。 各値は、レプリカの場所のコンマ区切りの一覧です。

--staging-resource-group

イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。

--subnet

ビルド仮想マシンをデプロイするサブネットの名前または ID。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--validator

イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます。

--vm-size

イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。 既定値 (Standard_D1_v2) を使用するには、空の文字列を省略または指定します。

--vnet

ビルド仮想マシンをデプロイする VNET の名前。 サブネットが名前の場合にのみ指定する必要があります。

グローバル パラメーター

--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 image builder delete

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

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

例

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

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

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder list

イメージ ビルダー テンプレートを一覧表示します。

az image builder list [--resource-group]

省略可能のパラメーター

--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 image builder run

イメージ ビルダー テンプレートを作成します。

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

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

規定値: False

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder show

イメージ ビルダー テンプレートを表示します。

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

例

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

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

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder show-runs

イメージ ビルダー テンプレートの実行出力を表示します。

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

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--output-name

イメージ ビルダーの実行出力の名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder update

イメージ ビルダー テンプレートを更新します。

イメージ ビルダー テンプレートの更新は現在サポートされていません。 このコマンドを --defer と組み合わせて使用して、CLI キャッシュ内のイメージ テンプレート オブジェクトを更新できます。 --defer を指定しないと、指定したイメージ テンプレートがキャッシュから取得され、イメージ テンプレートを作成するための要求が Azure に送信されます。

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

省略可能のパラメーター

--add

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

規定値: []

--defer

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

--force-string

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

規定値: False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

イメージ テンプレートの名前。

--remove

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

規定値: []

--resource-group -g

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

--set

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

規定値: []

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

グローバル パラメーター

--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 image builder wait

テンプレートの条件が満たされるまで、CLI を待機状態にします。

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

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False

--exists

リソースが存在するまで待ちます。

規定値: False

--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

規定値: 30

--name -n

イメージ テンプレートの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

グローバル パラメーター

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