Microsoft.VirtualMachineImages imageTemplates 2021-10-01

[アーティクル]
10/19/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2021-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {}
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
}

ImageTemplateCustomizer オブジェクト

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

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

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

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

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

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

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

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

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

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

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

ImageTemplateDistributor オブジェクト

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

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

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

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

  type: 'SharedImage'
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'

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

  type: 'VHD'

ImageTemplateSource オブジェクト

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

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

  type: 'ManagedImage'
  imageId: 'string'

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

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

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

  type: 'SharedImageVersion'
  imageVersionId: 'string'

プロパティ値

imageTemplates

名前	形容	価値
名前	リソース名	string (必須)
場所	リソースが存在する地理的な場所	string (必須)
タグ	リソースタグ。	タグ名と値のディクショナリ。テンプレートのタグを参照してください
同一性	イメージテンプレートの ID (構成されている場合)。	ImageTemplateIdentity (必須)
プロパティ	イメージテンプレートのプロパティ	ImageTemplateProperties

ImageTemplateIdentity

名前	形容	価値
種類	イメージテンプレートに使用される ID の種類。型 'None' は、イメージテンプレートからすべての ID を削除します。	'None' 'UserAssigned'
userAssignedIdentities	イメージテンプレートに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

名前	形容	価値
{カスタマイズされたプロパティ}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

このオブジェクトには、配置時に設定するプロパティは含まれません。すべてのプロパティは ReadOnly です。

ImageTemplateProperties

名前	形容	価値
buildTimeoutInMinutes	イメージテンプレートのビルド中に待機する最大時間。既定値 (4 時間) を使用するには、0 を省略するか指定します。	int 制約：最小値 = 0 最大値 = 960
カスタマイズ	イメージソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。	ImageTemplateCustomizer[]
配る	イメージ出力の移動先となる配布ターゲット。	ImageTemplateDistributor[] (必須)
源	ソースイメージの説明に使用するプロパティを指定します。	ImageTemplateSource (必須)
vmProfile	イメージをビルドするように仮想マシンを設定する方法について説明します	ImageTemplateVmProfile の

ImageTemplateCustomizer

名前	形容	価値
名前	このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名	糸
種類	オブジェクトの種類を設定する	ファイルの PowerShell のシェル WindowsRestart の WindowsUpdate (必須)

ImageTemplateFileCustomizer

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

ImageTemplatePowerShellCustomizer

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

ImageTemplateShellCustomizer

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

ImageTemplateRestartCustomizer

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

ImageTemplateWindowsUpdateCustomizer

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

ImageTemplateDistributor

名前	形容	価値
artifactTags	ディストリビューターによって作成/更新された成果物に適用されるタグ。	オブジェクト
runOutputName	関連付けられた RunOutput に使用する名前。	string (必須) 制約：パターン = `^[A-Za-z0-9-_.]{1,64}$`
種類	オブジェクトの種類を設定する	ManagedImage の SharedImage VHD (必須)

ImageTemplateManagedImageDistributor

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

ImageTemplateSharedImageDistributor

名前	形容	価値
種類	分布の種類。	'SharedImage' (必須)
excludeFromLatest	作成されたイメージバージョンを最新のバージョンから除外するかどうかを示すフラグ。既定値 (false) を使用する場合は省略します。	bool
galleryImageId	共有イメージギャラリーイメージのリソース ID	string (必須)
replicationRegions	イメージがレプリケートされるリージョンの一覧	string[] (必須)
storageAccountType	共有イメージの格納に使用するストレージアカウントの種類。既定値 (Standard_LRS) を使用するには省略します。	'Standard_LRS' 'Standard_ZRS'

ImageTemplateVhdDistributor

名前	形容	価値
種類	分布の種類。	'VHD' (必須)

ImageTemplateSource

名前	形容	価値
種類	オブジェクトの種類を設定する	ManagedImage の PlatformImage SharedImageVersion (必須)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

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

PlatformImagePurchasePlan

名前	形容	価値
planName	購入プランの名前。	string (必須)
planProduct	購入プランの製品。	string (必須)
planPublisher	購入プランの発行元。	string (必須)

ImageTemplateSharedImageVersionSource

名前	形容	価値
種類	開始するソースイメージの種類を指定します。	'SharedImageVersion' (必須)
imageVersionId	共有イメージギャラリー内のイメージバージョンの ARM リソース ID	string (必須)

ImageTemplateVmProfile

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

VirtualNetworkConfig

名前	形容	価値
proxyVmSize	イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。既定値を使用するには空の文字列を省略するか指定します (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4)。	糸
subnetId	既存のサブネットのリソース ID。	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
Azure Windows ベースラインを使用して Azure Image Builder をする Azure にデプロイする	Azure Image Builder 環境を作成し、最新の Windows 更新プログラムと Azure Windows ベースラインが適用された Windows Server イメージを構築します。
Dev Box サービスの構成 Azure にデプロイする	このテンプレートでは、Dev Box クイックスタートガイド (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box) に従って、すべての Dev Box 管理リソースが作成されます。作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。

ARM テンプレートリソース定義

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

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

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

リソースの形式

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

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "buildTimeoutInMinutes": "int",
    "customize": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ],
    "distribute": [
      {
        "artifactTags": {},
        "runOutputName": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    },
    "vmProfile": {
      "osDiskSizeGB": "int",
      "userAssignedIdentities": [ "string" ],
      "vmSize": "string",
      "vnetConfig": {
        "proxyVmSize": "string",
        "subnetId": "string"
      }
    }
  }
}

ImageTemplateCustomizer オブジェクト

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

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

  "type": "File",
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string"

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

  "type": "PowerShell",
  "inline": [ "string" ],
  "runAsSystem": "bool",
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "validExitCodes": [ "int" ]

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

  "type": "Shell",
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string"

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

  "type": "WindowsRestart",
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string"

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

  "type": "WindowsUpdate",
  "filters": [ "string" ],
  "searchCriteria": "string",
  "updateLimit": "int"

ImageTemplateDistributor オブジェクト

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

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

  "type": "ManagedImage",
  "imageId": "string",
  "location": "string"

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

  "type": "SharedImage",
  "excludeFromLatest": "bool",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "storageAccountType": "string"

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

  "type": "VHD"

ImageTemplateSource オブジェクト

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

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

  "type": "ManagedImage",
  "imageId": "string"

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

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

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

  "type": "SharedImageVersion",
  "imageVersionId": "string"

プロパティ値

imageTemplates

名前	形容	価値
種類	リソースの種類	'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion	リソース API のバージョン	'2021-10-01'
名前	リソース名	string (必須)
場所	リソースが存在する地理的な場所	string (必須)
タグ	リソースタグ。	タグ名と値のディクショナリ。テンプレートのタグを参照してください
同一性	イメージテンプレートの ID (構成されている場合)。	ImageTemplateIdentity (必須)
プロパティ	イメージテンプレートのプロパティ	ImageTemplateProperties

ImageTemplateIdentity

名前	形容	価値
種類	イメージテンプレートに使用される ID の種類。型 'None' は、イメージテンプレートからすべての ID を削除します。	'None' 'UserAssigned'
userAssignedIdentities	イメージテンプレートに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

名前	形容	価値
{カスタマイズされたプロパティ}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

このオブジェクトには、配置時に設定するプロパティは含まれません。すべてのプロパティは ReadOnly です。

ImageTemplateProperties

名前	形容	価値
buildTimeoutInMinutes	イメージテンプレートのビルド中に待機する最大時間。既定値 (4 時間) を使用するには、0 を省略するか指定します。	int 制約：最小値 = 0 最大値 = 960
カスタマイズ	イメージソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。	ImageTemplateCustomizer[]
配る	イメージ出力の移動先となる配布ターゲット。	ImageTemplateDistributor[] (必須)
源	ソースイメージの説明に使用するプロパティを指定します。	ImageTemplateSource (必須)
vmProfile	イメージをビルドするように仮想マシンを設定する方法について説明します	ImageTemplateVmProfile の

ImageTemplateCustomizer

名前	形容	価値
名前	このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名	糸
種類	オブジェクトの種類を設定する	ファイルの PowerShell のシェル WindowsRestart の WindowsUpdate (必須)

ImageTemplateFileCustomizer

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

ImageTemplatePowerShellCustomizer

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

ImageTemplateShellCustomizer

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

ImageTemplateRestartCustomizer

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

ImageTemplateWindowsUpdateCustomizer

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

ImageTemplateDistributor

名前	形容	価値
artifactTags	ディストリビューターによって作成/更新された成果物に適用されるタグ。	オブジェクト
runOutputName	関連付けられた RunOutput に使用する名前。	string (必須) 制約：パターン = `^[A-Za-z0-9-_.]{1,64}$`
種類	オブジェクトの種類を設定する	ManagedImage の SharedImage VHD (必須)

ImageTemplateManagedImageDistributor

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

ImageTemplateSharedImageDistributor

名前	形容	価値
種類	分布の種類。	'SharedImage' (必須)
excludeFromLatest	作成されたイメージバージョンを最新のバージョンから除外するかどうかを示すフラグ。既定値 (false) を使用する場合は省略します。	bool
galleryImageId	共有イメージギャラリーイメージのリソース ID	string (必須)
replicationRegions	イメージがレプリケートされるリージョンの一覧	string[] (必須)
storageAccountType	共有イメージの格納に使用するストレージアカウントの種類。既定値 (Standard_LRS) を使用するには省略します。	'Standard_LRS' 'Standard_ZRS'

ImageTemplateVhdDistributor

名前	形容	価値
種類	分布の種類。	'VHD' (必須)

ImageTemplateSource

名前	形容	価値
種類	オブジェクトの種類を設定する	ManagedImage の PlatformImage SharedImageVersion (必須)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

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

PlatformImagePurchasePlan

名前	形容	価値
planName	購入プランの名前。	string (必須)
planProduct	購入プランの製品。	string (必須)
planPublisher	購入プランの発行元。	string (必須)

ImageTemplateSharedImageVersionSource

名前	形容	価値
種類	開始するソースイメージの種類を指定します。	'SharedImageVersion' (必須)
imageVersionId	共有イメージギャラリー内のイメージバージョンの ARM リソース ID	string (必須)

ImageTemplateVmProfile

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

VirtualNetworkConfig

名前	形容	価値
proxyVmSize	イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。既定値を使用するには空の文字列を省略するか指定します (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4)。	糸
subnetId	既存のサブネットのリソース ID。	糸

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
Azure Windows ベースラインを使用して Azure Image Builder をする Azure にデプロイする	Azure Image Builder 環境を作成し、最新の Windows 更新プログラムと Azure Windows ベースラインが適用された Windows Server イメージを構築します。
Dev Box サービスの構成 Azure にデプロイする	このテンプレートでは、Dev Box クイックスタートガイド (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box) に従って、すべての Dev Box 管理リソースが作成されます。作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。

Terraform (AzAPI プロバイダー) リソース定義

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      buildTimeoutInMinutes = int
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {}
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
      vmProfile = {
        osDiskSizeGB = int
        userAssignedIdentities = [
          "string"
        ]
        vmSize = "string"
        vnetConfig = {
          proxyVmSize = "string"
          subnetId = "string"
        }
      }
    }
  })
}

ImageTemplateCustomizer オブジェクト

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

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

  type = "File"
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"

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

  type = "PowerShell"
  inline = [
    "string"
  ]
  runAsSystem = bool
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  validExitCodes = [
    int
  ]

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

  type = "Shell"
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"

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

  type = "WindowsRestart"
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"

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

  type = "WindowsUpdate"
  filters = [
    "string"
  ]
  searchCriteria = "string"
  updateLimit = int

ImageTemplateDistributor オブジェクト

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

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

  type = "ManagedImage"
  imageId = "string"
  location = "string"

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

  type = "SharedImage"
  excludeFromLatest = bool
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  storageAccountType = "string"

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

  type = "VHD"

ImageTemplateSource オブジェクト

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

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

  type = "ManagedImage"
  imageId = "string"

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

  type = "PlatformImage"
  offer = "string"
  planInfo = {
    planName = "string"
    planProduct = "string"
    planPublisher = "string"
  }
  publisher = "string"
  sku = "string"
  version = "string"

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

  type = "SharedImageVersion"
  imageVersionId = "string"

プロパティ値

imageTemplates

名前	形容	価値
種類	リソースの種類	"Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
名前	リソース名	string (必須)
場所	リソースが存在する地理的な場所	string (必須)
parent_id	リソースグループにデプロイするには、そのリソースグループの ID を使用します。	string (必須)
タグ	リソースタグ。	タグ名と値のディクショナリ。
同一性	イメージテンプレートの ID (構成されている場合)。	ImageTemplateIdentity (必須)
プロパティ	イメージテンプレートのプロパティ	ImageTemplateProperties

ImageTemplateIdentity

名前	形容	価値
種類	イメージテンプレートに使用される ID の種類。型 'None' は、イメージテンプレートからすべての ID を削除します。	"UserAssigned"
identity_ids	イメージテンプレートに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。	ユーザー ID ID の配列。

ImageTemplateIdentityUserAssignedIdentities

名前	形容	価値
{カスタマイズされたプロパティ}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

このオブジェクトには、配置時に設定するプロパティは含まれません。すべてのプロパティは ReadOnly です。

ImageTemplateProperties

名前	形容	価値
buildTimeoutInMinutes	イメージテンプレートのビルド中に待機する最大時間。既定値 (4 時間) を使用するには、0 を省略するか指定します。	int 制約：最小値 = 0 最大値 = 960
カスタマイズ	イメージソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。	ImageTemplateCustomizer[]
配る	イメージ出力の移動先となる配布ターゲット。	ImageTemplateDistributor[] (必須)
源	ソースイメージの説明に使用するプロパティを指定します。	ImageTemplateSource (必須)
vmProfile	イメージをビルドするように仮想マシンを設定する方法について説明します	ImageTemplateVmProfile の

ImageTemplateCustomizer

名前	形容	価値
名前	このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名	糸
種類	オブジェクトの種類を設定する	ファイルの PowerShell のシェル WindowsRestart の WindowsUpdate (必須)

ImageTemplateFileCustomizer

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

ImageTemplatePowerShellCustomizer

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

ImageTemplateShellCustomizer

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

ImageTemplateRestartCustomizer

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

ImageTemplateWindowsUpdateCustomizer

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

ImageTemplateDistributor

名前	形容	価値
artifactTags	ディストリビューターによって作成/更新された成果物に適用されるタグ。	オブジェクト
runOutputName	関連付けられた RunOutput に使用する名前。	string (必須) 制約：パターン = `^[A-Za-z0-9-_.]{1,64}$`
種類	オブジェクトの種類を設定する	ManagedImage の SharedImage VHD (必須)

ImageTemplateManagedImageDistributor

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

ImageTemplateSharedImageDistributor

名前	形容	価値
種類	分布の種類。	"SharedImage" (必須)
excludeFromLatest	作成されたイメージバージョンを最新のバージョンから除外するかどうかを示すフラグ。既定値 (false) を使用する場合は省略します。	bool
galleryImageId	共有イメージギャラリーイメージのリソース ID	string (必須)
replicationRegions	イメージがレプリケートされるリージョンの一覧	string[] (必須)
storageAccountType	共有イメージの格納に使用するストレージアカウントの種類。既定値 (Standard_LRS) を使用するには省略します。	"Standard_LRS" "Standard_ZRS"

ImageTemplateVhdDistributor

名前	形容	価値
種類	分布の種類。	"VHD" (必須)

ImageTemplateSource

名前	形容	価値
種類	オブジェクトの種類を設定する	ManagedImage の PlatformImage SharedImageVersion (必須)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

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

PlatformImagePurchasePlan

名前	形容	価値
planName	購入プランの名前。	string (必須)
planProduct	購入プランの製品。	string (必須)
planPublisher	購入プランの発行元。	string (必須)

ImageTemplateSharedImageVersionSource

名前	形容	価値
種類	開始するソースイメージの種類を指定します。	"SharedImageVersion" (必須)
imageVersionId	共有イメージギャラリー内のイメージバージョンの ARM リソース ID	string (必須)

ImageTemplateVmProfile

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

VirtualNetworkConfig

名前	形容	価値
proxyVmSize	イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。既定値を使用するには空の文字列を省略するか指定します (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4)。	糸
subnetId	既存のサブネットのリソース ID。	糸

次の方法で共有

Microsoft.VirtualMachineImages imageTemplates 2021-10-01

Bicep リソース定義

リソースの形式

ImageTemplateCustomizer オブジェクト

ImageTemplateDistributor オブジェクト

ImageTemplateSource オブジェクト

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

PlatformImagePurchasePlan

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

VirtualNetworkConfig

クイック スタート テンプレート

ARM テンプレート リソース定義

リソースの形式

ImageTemplateCustomizer オブジェクト

ImageTemplateDistributor オブジェクト

ImageTemplateSource オブジェクト

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

PlatformImagePurchasePlan

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

VirtualNetworkConfig

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

ImageTemplateCustomizer オブジェクト

ImageTemplateDistributor オブジェクト

ImageTemplateSource オブジェクト

プロパティ値

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート