az image

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細をご覧ください。

カスタムの仮想マシン イメージを管理する。

コマンド

名前 説明 Status
az image builder

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

コア GA
az image builder cancel

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

コア GA
az image builder create

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

コア GA
az image builder customizer

イメージ ビルダー テンプレート カスタマイザーを管理する。

コア GA
az image builder customizer add

イメージ ビルダー カスタマイザーをイメージ ビルダー テンプレートに追加します。

コア GA
az image builder customizer clear

イメージ ビルダー テンプレートからすべてのイメージ ビルダー カスタマイザーを削除します。

コア GA
az image builder customizer remove

イメージ ビルダー テンプレートからイメージ ビルダー カスタマイザーを削除します。

コア GA
az image builder delete

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

コア GA
az image builder error-handler

イメージ ビルダー テンプレートのエラー ハンドラーを管理します。

コア GA
az image builder error-handler add

既存のイメージ ビルダー テンプレートにエラー ハンドラーを追加します。

コア GA
az image builder error-handler remove

既存のイメージ ビルダー テンプレートからエラー ハンドラーを削除します。

コア GA
az image builder error-handler show

既存のイメージ ビルダー テンプレートのエラー ハンドラーを表示します。

コア GA
az image builder identity

イメージ ビルダー テンプレートの ID を管理します。

コア GA
az image builder identity assign

既存のイメージ ビルダー テンプレートにマネージド ID を追加します。 現在、サポートされているユーザー ID は 1 つだけです。

コア GA
az image builder identity remove

既存のイメージ ビルダー テンプレートからマネージド ID を削除します。

コア GA
az image builder identity show

イメージ ビルダー テンプレートのマネージド ID を表示します。

コア GA
az image builder list

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

コア GA
az image builder optimizer

イメージ ビルダー テンプレート オプティマイザーを管理します。

コア GA
az image builder optimizer add

既存のイメージ ビルダー テンプレートにオプティマイザーを追加します。

コア GA
az image builder optimizer remove

既存のイメージ ビルダー テンプレートからオプティマイザーを削除します。

コア GA
az image builder optimizer show

既存のイメージ ビルダー テンプレートのオプティマイザーを表示します。

コア GA
az image builder optimizer update

既存のイメージ ビルダー テンプレートからオプティマイザーを更新します。

コア GA
az image builder output

イメージ ビルダー テンプレート出力ディストリビューターを管理する。

コア GA
az image builder output add

イメージ ビルダーの出力ディストリビューターをイメージ ビルダー テンプレートに追加します。

コア GA
az image builder output clear

イメージ ビルダー テンプレートからすべてのイメージ ビルダー出力ディストリビューターを削除します。

コア GA
az image builder output remove

イメージ ビルダー テンプレートからイメージ ビルダーの出力ディストリビューターを削除します。

コア GA
az image builder output versioning

イメージ ビルダー テンプレートの出力バージョナーを管理します。

コア GA
az image builder output versioning remove

指定した出力のすべてのバージョン管理オプションを削除します。

コア GA
az image builder output versioning set

イメージ ビルダー テンプレートのイメージ ビルダー出力バージョナーを設定します。

コア GA
az image builder output versioning show

指定した出力のバージョン管理オプションを表示します。

コア GA
az image builder run

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

コア GA
az image builder show

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

コア GA
az image builder show-runs

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

コア GA
az image builder trigger

イメージ ビルダー テンプレート トリガーを管理します。

コア GA
az image builder trigger create

指定した仮想マシン イメージ テンプレートのトリガーを作成します。

コア GA
az image builder trigger delete

指定した仮想マシン イメージ テンプレートのトリガーを削除します。

コア GA
az image builder trigger list

指定したイメージ テンプレート リソースのすべてのトリガーを一覧表示します。

コア GA
az image builder trigger show

指定したイメージ テンプレート リソースの指定したトリガーを取得します。

コア GA
az image builder trigger wait

条件が満たされるまで CLI を待機状態にします。

コア GA
az image builder update

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

コア GA
az image builder validator

イメージ ビルダー テンプレートの検証を管理します。

コア GA
az image builder validator add

既存のイメージ ビルダー テンプレートに検証を追加します。

コア GA
az image builder validator remove

既存のイメージ ビルダー テンプレートから検証を削除します。

コア GA
az image builder validator show

既存のイメージ ビルダー テンプレートの検証を表示します。

コア GA
az image builder wait

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

コア GA
az image copy

マネージド イメージ (または VM) を他のリージョンにコピーします。 ソース ディスクを使用できる必要があります。

拡張子 GA
az image create

マネージド ディスクまたはスナップショットからカスタム仮想マシン イメージを作成します。

コア GA
az image delete

イメージを削除します。

コア GA
az image list

リソース グループの下にあるイメージの一覧を一覧表示します。

コア GA
az image show

画像を取得します。

コア GA
az image update

カスタム VM イメージを更新します。

コア GA
az image wait

条件が満たされるまで CLI を待機状態にします。

コア GA

az image copy

マネージド イメージ (または VM) を他のリージョンにコピーします。 ソース ディスクを使用できる必要があります。

az image copy --source-object-name
              --source-resource-group
              --target-location
              --target-resource-group
              [--cleanup]
              [--export-as-snapshot]
              [--parallel-degree]
              [--source-type {image, vm}]
              [--tags]
              [--target-name]
              [--target-subscription]
              [--temporary-resource-group-name]
              [--timeout]

複数のリージョンにイメージをコピーし、最後にクリーンします。

az image copy --source-resource-group mySources-rg --source-object-name myImage \
    --target-location uksouth northeurope --target-resource-group "images-repo-rg" --cleanup

既に一般化された VM を使用して、他のリージョンにイメージを作成します。

az image copy --source-resource-group mySources-rg --source-object-name myVm \
    --source-type vm --target-location uksouth northeurope --target-resource-group "images-repo-rg"

必須のパラメーター

--source-object-name

イメージまたは VM リソースの名前。

--source-resource-group

ソース リソースのリソース グループの名前。

--target-location

画像を作成するスペース区切りの場所リスト (westeurope など)。

--target-resource-group

イメージを作成するリソース グループの名前。

省略可能のパラメーター

--cleanup

完了時に一時的なリソースを削除するには、このスイッチを含めます。

既定値: False
--export-as-snapshot

コピーをイメージではなくスナップショットとしてエクスポートするには、このスイッチを含めます。

既定値: False
--parallel-degree

並列コピー操作の数。

既定値: -1
--source-type

イメージまたは VM。

承認された値: image, vm
既定値: image
--tags

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

--target-name

作成される最終的なイメージの名前。

--target-subscription

最終的なイメージを作成するサブスクリプションの名前または ID。

--temporary-resource-group-name

一時ストレージ アカウントが作成されるリソース グループ名。

既定値: image-copy-rg
--timeout

コピー操作が完了するまでの時間 (秒)。 512 GB 以上のような大きなイメージ (ディスク) をコピーする場合は、この時間を増やします。

既定値: 3600
グローバル パラメーター
--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 create

マネージド ディスクまたはスナップショットからカスタム仮想マシン イメージを作成します。

az image create --name
                --resource-group
                --source
                [--data-disk-caching {None, ReadOnly, ReadWrite}]
                [--data-disk-sources]
                [--edge-zone]
                [--hyper-v-generation {V1, V2}]
                [--location]
                [--os-disk-caching {None, ReadOnly, ReadWrite}]
                [--os-type {Linux, Windows}]
                [--storage-sku {PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS}]
                [--tags]
                [--zone-resilient {false, true}]

既存のディスクからイメージを作成します。

az image create -g MyResourceGroup -n image1 --os-type Linux \
    --source /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/rg1/providers/Microsoft.Compute/snapshots/s1

同じリソース グループ内の既存の一般化された仮想マシンをキャプチャして、イメージを作成します。

az image create -g MyResourceGroup -n image1 --source MyVm1

必須のパラメーター

--name -n

新しいイメージ名。

--resource-group -g

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

--source

仮想マシン ID または名前、OS ディスク BLOB URI、マネージド OS ディスク ID または名前、OS スナップショット ID または名前など、同じリージョンの OS ディスク ソース。

省略可能のパラメーター

--data-disk-caching

イメージのデータ ディスクのストレージ キャッシュの種類。

承認された値: None, ReadOnly, ReadWrite
--data-disk-sources

アンマネージド BLOB URI、マネージド ディスク ID または名前、スナップショット ID または名前など、データ ディスク ソースの領域で区切られた一覧。

--edge-zone

エッジ ゾーンの名前。

--hyper-v-generation

イメージから作成された仮想マシンのハイパーバイザー生成。

承認された値: V1, V2
既定値: V1
--location -l

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

--os-disk-caching

イメージの OS ディスクのストレージ キャッシュの種類。

承認された値: None, ReadOnly, ReadWrite
--os-type
承認された値: Linux, Windows
--storage-sku

VM イメージを作成するストレージ アカウントの SKU。 ソース VM が指定されている場合は使用されません。

承認された値: PremiumV2_LRS, Premium_LRS, Premium_ZRS, StandardSSD_LRS, StandardSSD_ZRS, Standard_LRS, UltraSSD_LRS
--tags

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

--zone-resilient

イメージがゾーンの回復性を持つかどうかを指定します。 既定値は 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 image delete

イメージを削除します。

az image delete [--ids]
                [--image-name]
                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                [--resource-group]
                [--subscription]

省略可能のパラメーター

--ids

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

--image-name --name -n

イメージの名前。

--no-wait

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--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 list

リソース グループの下にあるイメージの一覧を一覧表示します。

az image list [--max-items]
              [--next-token]
              [--resource-group]

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

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

画像を取得します。

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

省略可能のパラメーター

--expand

操作に適用する展開式。

--ids

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

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

カスタム VM イメージを更新します。

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

タグを追加または更新します。

az image update -n ImageName -g ResourceGroup --tags tag1=val1 tag2=val2

すべてのタグを削除します。

az image update -n ImageName -g resourceGroup --tags

省略可能のパラメーター

--add

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

既定値: []
--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 を使用して、既定のサブスクリプションを構成できます。

--tags

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

グローバル パラメーター
--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 wait

条件が満たされるまで CLI を待機状態にします。

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

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--expand

操作に適用する展開式。

--ids

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

--image-name --name -n

イメージの名前。

--interval

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

既定値: 30
--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 を使います。