az image

リファレンス

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

コマンド

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 list	イメージビルダーテンプレートを一覧表示します。
az image builder output	イメージビルダーテンプレート出力ディストリビューターを管理する。
az image builder output add	イメージビルダー出力ディストリビューターをイメージビルダーテンプレートに追加します。
az image builder output clear	イメージビルダーテンプレートからすべてのイメージビルダー出力ディストリビューターを削除します。
az image builder output remove	イメージビルダーテンプレートからイメージビルダー出力ディストリビューターを削除します。
az image builder run	イメージビルダーテンプレートを作成します。
az image builder show	イメージビルダーテンプレートを表示します。
az image builder show-runs	イメージビルダーテンプレートの実行出力を表示します。
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 copy	マネージドイメージ (または VM) を他のリージョンにコピーします。ソースディスクを使用できる必要があります。
az image create	マネージドディスクまたはスナップショットからカスタム仮想マシンイメージを作成します。
az image delete	イメージを削除します。
az image list	カスタム VM イメージを一覧表示します。
az image show	イメージを取得します。
az image update	カスタム VM イメージを更新します。

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

一時ストレージアカウントが作成されるリソースグループ名。 --temporary_resource_group_name は 0.2.7 で非推奨になります。

既定値: image-copy-rg

--timeout

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

既定値: 3600

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

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

場所。値のソース: 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

出力形式。

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az image delete

イメージを削除します。

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

省略可能のパラメーター

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

出力形式。

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az image list

カスタム VM イメージを一覧表示します。

az image list [--resource-group]

省略可能のパラメーター

--resource-group -g

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az image show

イメージを取得します。

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

省略可能のパラメーター

--expand

操作に適用する展開式。既定値は [なし] です。

--ids

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

出力形式。

--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、または JSON 文字列>。

既定値: []

--force-string

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

既定値: False

--ids

--name -n

イメージの名前。必須。

--remove

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

既定値: []

--resource-group -g

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

--set

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

既定値: []

--subscription

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

--tags

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az image

コマンド

az image copy

例

必須のパラメーター

省略可能のパラメーター

az image create

例

必須のパラメーター

省略可能のパラメーター

az image delete

省略可能のパラメーター

az image list

省略可能のパラメーター

az image show

省略可能のパラメーター

az image update

例

省略可能のパラメーター

フィードバック

その他のリソース