Microsoft.VirtualMachineImages imageTemplates

[アーティクル]
2024-12-17

Bicep リソース定義

imageTemplates リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoRun: {
      state: 'string'
    }
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    errorHandling: {
      onCustomizerError: 'string'
      onValidationError: 'string'
    }
    managedResourceTags: {
      {customized property}: 'string'
    }
    optimize: {
      vmBoot: {
        state: 'string'
      }
    }
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    stagingResourceGroup: 'string'
    validate: {
      continueDistributeOnFailure: bool
      inVMValidations: [
        {
          name: 'string'
          type: 'string'
          // For remaining properties, see ImageTemplateInVMValidator objects
        }
      ]
      sourceValidationOnly: bool
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        containerInstanceSubnetId: 'string'
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

ImageTemplateCustomizer オブジェクト

型プロパティを設定して、オブジェクトの型を指定します。

ファイルの場合は、次を使用します。

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

PowerShellの場合は、次のコマンドを使用します。

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

シェルの場合は、次のコマンドを使用します。

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

WindowsRestartをする場合は、次のコマンドを使用します。

{
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'
  type: 'WindowsRestart'
}

WindowsUpdateをする場合は、次を使用します。

{
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  type: 'WindowsUpdate'
  updateLimit: int
}

DistributeVersioner オブジェクト

オブジェクトの種類を指定するには、スキーム プロパティを設定します。

[最新の場合は、次の値を使用します。

{
  major: int
  scheme: 'Latest'
}

ソースの場合は、次を使用します。

{
  scheme: 'Source'
}

ImageTemplateSource オブジェクト

型プロパティを設定して、オブジェクトの型を指定します。

ManagedImage場合は、次を使用します。

{
  imageId: 'string'
  type: 'ManagedImage'
}

PlatformImageの場合は、次を使用します。

{
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

SharedImageVersionの場合は、次を使用します。

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

ImageTemplateInVMValidator オブジェクト

型プロパティを設定して、オブジェクトの型を指定します。

ファイルの場合は、次を使用します。

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

PowerShellの場合は、次のコマンドを使用します。

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

シェルの場合は、次のコマンドを使用します。

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

ImageTemplateDistributor オブジェクト

型プロパティを設定して、オブジェクトの型を指定します。

ManagedImage場合は、次を使用します。

{
  imageId: 'string'
  location: 'string'
  type: 'ManagedImage'
}

SharedImageの場合は、次を使用します。

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  targetRegions: [
    {
      name: 'string'
      replicaCount: int
      storageAccountType: 'string'
    }
  ]
  type: 'SharedImage'
  versioning: {
    scheme: 'string'
    // For remaining properties, see DistributeVersioner objects
  }
}

VHDの場合は、次を使用します。

{
  type: 'VHD'
  uri: 'string'
}

プロパティ値

DistributeVersioner

名前	形容	価値
計画	DistributeVersionerLatest型 'Latest' に設定します。 DistributeVersionerSourceの型 "Source" に設定します。	'Latest' 'Source' (必須)

DistributeVersionerLatest

名前	形容	価値
少佐	生成されたバージョン番号のメジャーバージョン。メジャーバージョンとしてこの値を持つバージョンに基づいて、"最新" とは何かを判断します。 -1 は、設定を解除したままにすることと同じです。	int 制約：最小値 = -1
計画	使用するバージョン番号スキーム。	'Latest' (必須)

DistributeVersionerSource

名前	形容	価値
計画	使用するバージョン番号スキーム。	'Source' (必須)

ImageTemplateAutoRun

名前	形容	価値
状態	このフィールドを有効にすると、イメージテンプレートの作成または更新時に自動ビルドがトリガーされます。	'Disabled' 'Enabled'

ImageTemplateCustomizer

名前	形容	価値
名前	このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名	糸
種類	ImageTemplateFileCustomizerの種類 'File' に設定します。 ImageTemplatePowerShellCustomizerの型 'PowerShell' に設定します。 ImageTemplateShellCustomizerの型 'Shell' に設定します。 ImageTemplateRestartCustomizer型の場合は、'WindowsRestart' に設定します。 ImageTemplateWindowsUpdateCustomizer型の場合は、'WindowsUpdate' に設定します。	'File' 'PowerShell' 'Shell' 'WindowsRestart' 'WindowsUpdate' (必須)

ImageTemplateDistributor

名前	形容	価値
artifactTags	ディストリビューターによって作成/更新された成果物に適用されるタグ。	ImageTemplateDistributorArtifactTags
runOutputName	関連付けられた RunOutput に使用する名前。	糸制約：パターン = `^[A-Za-z0-9-_.]{1,64}$` (必須)
種類	ImageTemplateManagedImageDistributor型の場合は、'ManagedImage' に設定します。 ImageTemplateSharedImageDistributor型 'SharedImage' に設定します。 ImageTemplateVhdDistributorの種類 "VHD" に設定します。	'ManagedImage' 'SharedImage' 'VHD' (必須)

ImageTemplateDistributorArtifactTags

名前	形容	価値

ImageTemplateFileCustomizer

名前	形容	価値
行き先	(入れ子になったディレクトリ構造が既に作成されている) ファイルへの絶対パス。ファイル (sourceUri から) が VM にアップロードされます。	糸
sha256Checksum	上記の sourceUri フィールドに指定されたファイルの SHA256 チェックサム	糸
sourceUri	VM をカスタマイズするためにアップロードするファイルの URI。 GitHub リンク、Azure Storage の SAS URI などです。	糸
種類	イメージで使用するカスタマイズツールの種類。たとえば、"Shell" はシェルカスタマイザーにすることができます	'File' (必須)

ImageTemplateFileValidator

名前	形容	価値
行き先	(入れ子になったディレクトリ構造が既に作成されている) ファイルへの絶対パス。ファイル (sourceUri から) が VM にアップロードされます。	糸
sha256Checksum	上記の sourceUri フィールドに指定されたファイルの SHA256 チェックサム	糸
sourceUri	検証のために VM にアップロードするファイルの URI。 GitHub リンク、Azure Storage URI (承認済みまたは SAS) などを指定できます。	糸
種類	イメージで使用する検証の種類。たとえば、"Shell" はシェル検証にすることができます	'File' (必須)

ImageTemplateIdentity

名前	形容	価値
種類	イメージテンプレートに使用される ID の種類。型 'None' は、イメージテンプレートからすべての ID を削除します。	'None' 'UserAssigned'
userAssignedIdentities	リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。	UserAssignedIdentities の

ImageTemplateInVMValidator

名前	形容	価値
名前	この検証手順の内容に関するコンテキストを提供するフレンドリ名	糸
種類	ImageTemplateFileValidatorの型 'File' に設定します。 ImageTemplatePowerShellValidator型 'PowerShell' に設定します。 ImageTemplateShellValidator型 'Shell' に設定します。	'File' 'PowerShell' 'Shell' (必須)

ImageTemplateManagedImageDistributor

名前	形容	価値
imageId	マネージドディスクイメージのリソース ID	string (必須)
場所	イメージの Azure の場所 (イメージが既に存在する場合) と一致する必要がある	string (必須)
種類	分布の種類。	'ManagedImage' (必須)

ImageTemplateManagedImageSource

名前	形容	価値
imageId	顧客サブスクリプションのマネージドイメージの ARM リソース ID	string (必須)
種類	開始するソースイメージの種類を指定します。	'ManagedImage' (必須)

ImageTemplatePlatformImageSource

名前	形容	価値
提供	Azure ギャラリーイメージからのイメージオファー。	糸
planInfo	プラットフォームイメージの購入計画のオプション構成。	PlatformImagePurchasePlan
発行者	Azure ギャラリーイメージの Image Publisher。	糸
sku	Azure ギャラリーイメージのイメージ SKU。	糸
種類	開始するソースイメージの種類を指定します。	'PlatformImage' (必須)
バージョン	Azure ギャラリーイメージからのイメージバージョン。ここで 'latest' が指定されている場合、テンプレートの送信時ではなく、イメージビルドが行われるときにバージョンが評価されます。	糸

ImageTemplatePowerShellCustomizer

名前	形容	価値
インライン	実行する PowerShell コマンドの配列	string[]
runAsSystem	指定した場合、PowerShell スクリプトはローカルシステムユーザーを使用して昇格された特権で実行されます。上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。	bool
runElevated	指定した場合、PowerShell スクリプトは昇格された特権で実行されます	bool
scriptUri	カスタマイズのために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。	糸
sha256Checksum	上の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム	糸
種類	イメージで使用するカスタマイズツールの種類。たとえば、"Shell" はシェルカスタマイザーにすることができます	'PowerShell' (必須)
validExitCodes	PowerShell スクリプトの有効な終了コード。 [既定値: 0]	int[]

ImageTemplatePowerShellValidator

名前	形容	価値
インライン	実行する PowerShell コマンドの配列	string[]
runAsSystem	指定した場合、PowerShell スクリプトはローカルシステムユーザーを使用して昇格された特権で実行されます。上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。	bool
runElevated	指定した場合、PowerShell スクリプトは昇格された特権で実行されます	bool
scriptUri	検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。	糸
sha256Checksum	上の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム	糸
種類	イメージで使用する検証の種類。たとえば、"Shell" はシェル検証にすることができます	'PowerShell' (必須)
validExitCodes	PowerShell スクリプトの有効な終了コード。 [既定値: 0]	int[]

ImageTemplateProperties

名前	形容	価値
autoRun	テンプレートの作成または更新時にイメージテンプレートビルドを自動的に実行するかどうかを示します。	ImageTemplateAutoRun
buildTimeoutInMinutes	イメージテンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、最適化、検証、およびディストリビューションが含まれます)。既定値 (4 時間) を使用するには、0 を省略するか指定します。	int 制約：最小値 = 0 最大値 = 960
カスタマイズ	イメージソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。	ImageTemplateCustomizer[]
配る	イメージ出力の移動先となる配布ターゲット。	ImageTemplateDistributor[] (必須)
errorHandling	ビルドエラー時のエラー処理オプション	ImageTemplatePropertiesErrorHandling
managedResourceTags	サービスによって作成されたリソースグループまたはリソースに適用されるタグ。	ImageTemplatePropertiesManagedResourceTags
最適化	イメージに対して実行する最適化を指定します。	ImageTemplatePropertiesOptimize
源	ソースイメージの説明に使用するプロパティを指定します。	ImageTemplateSource (必須)
stagingResourceGroup	イメージのビルドに使用されるイメージテンプレートと同じサブスクリプション内のステージングリソースグループ ID。このフィールドが空の場合は、ランダムな名前のリソースグループが作成されます。このフィールドに指定されたリソースグループが存在しない場合は、同じ名前で作成されます。指定されたリソースグループが存在する場合は、イメージテンプレートと同じリージョンに空である必要があります。このフィールドが空であるか、指定されたリソースグループが存在しない場合、作成されたリソースグループはテンプレートの削除中に削除されますが、指定されたリソースグループが存在する場合、リソースグループに作成されたリソースはテンプレートの削除中に削除され、リソースグループ自体は残ります。	糸
検証	結果のイメージに対して実行される構成オプションと検証の一覧。	ImageTemplatePropertiesValidate
vmProfile	イメージをビルドするように仮想マシンを設定する方法について説明します	ImageTemplateVmProfile の

ImageTemplatePropertiesErrorHandling

名前	形容	価値
onCustomizerError	カスタマイザーエラーが発生し、このフィールドが "cleanup" に設定されている場合、ビルド VM と関連するネットワークリソースがクリーンアップされます。これが既定の動作です。カスタマイザーエラーが発生し、このフィールドが "abort" に設定されている場合、ビルド VM は保持されます。	'abort' 'cleanup'
onValidationError	検証エラーが発生し、このフィールドが "cleanup" に設定されている場合、ビルド VM と関連するネットワークリソースがクリーンアップされます。これが既定の動作です。検証エラーが発生し、このフィールドが "abort" に設定されている場合、ビルド VM は保持されます。	'abort' 'cleanup'

ImageTemplatePropertiesManagedResourceTags

名前	形容	価値

ImageTemplatePropertiesOptimize

名前	形容	価値
vmBoot	VM の起動を高速化するために、イメージに最適化が適用されます。	ImageTemplatePropertiesOptimizeVmBoot の

ImageTemplatePropertiesOptimizeVmBoot

名前	形容	価値
状態	このフィールドを有効にすると、最終的にカスタマイズされたイメージ出力が最適化され、VM の起動時間が短縮されます。	'Disabled' 'Enabled'

ImageTemplatePropertiesValidate

名前	形容	価値
continueDistributeOnFailure	検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。これが既定の動作です。検証が失敗し、このフィールドが true に設定されている場合、出力イメージは引き続き分散されます。このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。いずれの場合も (true または false)、検証エラーが発生した場合に、エンドツーエンドのイメージの実行が失敗したと報告されます。 [注: 検証に成功した場合、このフィールドは無効です。]	bool
inVMValidations	実行する検証の一覧。	ImageTemplateInVMValidator[]
sourceValidationOnly	このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。	bool

ImageTemplateRestartCustomizer

名前	形容	価値
restartCheckCommand	再起動が成功したかどうかを確認するコマンド [既定値: '']	糸
restartCommand	再起動を実行するコマンド [既定値: 'shutdown /r /f /t 0 /c "packer restart"'	糸
restartTimeout	大きさと単位の文字列として指定された再起動タイムアウト (例: '5m' (5 分) または '2h' (2 時間) [既定値: '5m'] )	糸
種類	イメージで使用するカスタマイズツールの種類。たとえば、"Shell" はシェルカスタマイザーにすることができます	'WindowsRestart' (必須)

ImageTemplateSharedImageDistributor

名前	形容	価値
excludeFromLatest	作成されたイメージバージョンを最新のバージョンから除外するかどうかを示すフラグ。既定値 (false) を使用する場合は省略します。	bool
galleryImageId	Azure コンピューティングギャラリーイメージのリソース ID	string (必須)
replicationRegions	[非推奨]イメージがレプリケートされるリージョンの一覧。このリストは、targetRegions が指定されていない場合にのみ指定できます。このフィールドは非推奨です。代わりに targetRegions を使用してください。	string[]
storageAccountType	[非推奨]共有イメージの格納に使用するストレージアカウントの種類。既定値 (Standard_LRS) を使用するには省略します。このフィールドは、replicationRegions が指定されている場合にのみ指定できます。このフィールドは非推奨です。代わりに targetRegions を使用してください。	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'
targetRegions	分散イメージバージョンがレプリケートされるターゲットリージョン。このオブジェクトは replicationRegions よりも優先され、replicationRegions が指定されていない場合にのみ指定できます。	TargetRegion[]
種類	分布の種類。	'SharedImage' (必須)
バージョン管理	配布用に新しい x.y.z バージョン番号を生成する方法について説明します。	DistributeVersioner

ImageTemplateSharedImageVersionSource

名前	形容	価値
imageVersionId	イメージバージョンの ARM リソース ID。イメージバージョン名が 'latest' の場合、イメージビルドが行われるとバージョンが評価されます。	string (必須)
種類	開始するソースイメージの種類を指定します。	'SharedImageVersion' (必須)

ImageTemplateShellCustomizer

名前	形容	価値
インライン	実行するシェルコマンドの配列	string[]
scriptUri	カスタマイズのために実行するシェルスクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。	糸
sha256Checksum	scriptUri フィールドに指定されたシェルスクリプトの SHA256 チェックサム	糸
種類	イメージで使用するカスタマイズツールの種類。たとえば、"Shell" はシェルカスタマイザーにすることができます	'Shell' (必須)

ImageTemplateShellValidator

名前	形容	価値
インライン	実行するシェルコマンドの配列	string[]
scriptUri	検証のために実行するシェルスクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。	糸
sha256Checksum	scriptUri フィールドに指定されたシェルスクリプトの SHA256 チェックサム	糸
種類	イメージで使用する検証の種類。たとえば、"Shell" はシェル検証にすることができます	'Shell' (必須)

ImageTemplateSource

名前	形容	価値
種類	ImageTemplateManagedImageSource型の場合は、'ManagedImage' に設定します。 ImageTemplatePlatformImageSource型 'PlatformImage' に設定します。 ImageTemplateSharedImageVersionSource型 'SharedImageVersion' に設定します。	'ManagedImage' 'PlatformImage' 'SharedImageVersion' (必須)

ImageTemplateVhdDistributor

名前	形容	価値
種類	分布の種類。	'VHD' (必須)
uri	分散 VHD BLOB のオプションの Azure Storage URI。既定の (空の文字列) を使用する場合は省略します。この場合、VHD はステージングリソースグループ内のストレージアカウントに発行されます。	糸

ImageTemplateVmProfile

名前	形容	価値
osDiskSizeGB	OS ディスクのサイズ (GB 単位)。 Azure の既定の OS ディスクサイズを使用するには、0 を省略するか指定します。	int 制約：最小値 = 0
userAssignedIdentities	ビルド VM と検証 VM で構成するユーザー割り当てマネージド ID のリソース ID のオプション配列。これには、イメージテンプレートの ID が含まれる場合があります。	string[]
vmSize	イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。既定値を使用するには空の文字列を省略するか指定します (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4)。	糸
vnetConfig	ビルド VM と検証 VM のデプロイに使用する仮想ネットワークのオプション構成。特定の仮想ネットワークを使用する必要がない場合は省略します。	VirtualNetworkConfig の

ImageTemplateWindowsUpdateCustomizer

名前	形容	価値
フィルター	適用する更新プログラムを選択するフィルターの配列。既定値 (フィルターなし) を使用するには、空の配列を省略または指定します。このフィールドの例と詳細な説明については、上記のリンクを参照してください。	string[]
searchCriteria	更新プログラムを検索する条件。既定値 (すべて検索) を使用するには、空の文字列を省略または指定します。このフィールドの例と詳細な説明については、上記のリンクを参照してください。	糸
種類	イメージで使用するカスタマイズツールの種類。たとえば、"Shell" はシェルカスタマイザーにすることができます	'WindowsUpdate' (必須)
updateLimit	一度に適用する更新プログラムの最大数。既定値を使用するには、0 を省略または指定します (1000)	int 制約：最小値 = 0