Microsoft.VirtualMachineImages imageTemplates
Bicep リソース定義
imageTemplates リソースの種類は、次の対象にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2022-02-14' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
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
}
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: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
}
ImageTemplateCustomizer オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
[ファイル] には、次の値を使用します。
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
PowerShell の場合は、次の値を使用します。
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Shell の場合は、次のコマンドを使用します。
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 オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
ManagedImage の場合は、次の値を使用します。
type: 'ManagedImage'
imageId: 'string'
location: 'string'
SharedImage の場合は、次の値を使用します。
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
VHD の場合は、次の値を使用します。
type: 'VHD'
ImageTemplateSource オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
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'
ImageTemplateInVMValidator オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
PowerShell の場合は、次の値を使用します。
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Shell の場合は、次のコマンドを使用します。
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
プロパティ値
imageTemplates
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) |
location | リソースが保存されている地理的な場所 | string (必須) |
tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
identity | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
properties | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 説明 | 値 |
---|---|---|
type | イメージ テンプレートに使用される ID の種類。 型 'None' では、イメージ テンプレートから ID が削除されます。 | 'None' 'UserAssigned' |
userAssignedIdentities | イメージ テンプレートに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | object |
ImageTemplateProperties
名前 | 説明 | 値 |
---|---|---|
buildTimeoutInMinutes | (すべてのカスタマイズ、検証、配布を含む) イメージ テンプレートの構築中に待機する最大継続期間。 既定値 (4 時間) を使用するには、0 を省略または指定します。 | INT |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用されるプロパティを指定します。 | ImageTemplateCustomizer[] |
配布 (distribute) | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
source | ソース イメージの記述に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドで指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定したリソース グループが存在する場合は、イメージ テンプレートと同じリージョン内に空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、テンプレートの削除中に作成されたリソース グループは削除されますが、指定されたリソース グループが存在する場合、テンプレートの削除中にリソース グループに作成されたリソースは削除され、リソース グループ自体は残ります。 | string |
validate | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
vmProfile | イメージをビルドするように仮想マシンを設定する方法について説明します | ImageTemplateVmProfile |
ImageTemplateCustomizer
名前 | 説明 | 値 |
---|---|---|
name | このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | [最近使ったファイル] PowerShell Shell WindowsRestart WindowsUpdate (必須) |
ImageTemplateFileCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'File' (必須) |
destination | (入れ子になったディレクトリ構造が既に作成されている) ファイルへの絶対パス。このファイル (sourceUri から) が VM にアップロードされます | string |
sha256Checksum | 上記の sourceUri フィールドに指定されたファイルの SHA256 チェックサム | string |
sourceUri | VM をカスタマイズするためにアップロードするファイルの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
ImageTemplatePowerShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'PowerShell' (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | [bool] |
scriptUri | カスタマイズのために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | 上記の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'Shell' (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | カスタマイズのために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateRestartCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'WindowsRestart' (必須) |
restartCheckCommand | 再起動が成功した場合にチェックするコマンド [既定値: ''] | string |
restartCommand | 再起動を実行するコマンド [既定値: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
restartTimeout | 大きさと単位の文字列として指定された再起動タイムアウト (例: '5m' (5 分) または '2h' (2 時間) [既定値: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'WindowsUpdate' (必須) |
filters | 適用する更新プログラムを選択するフィルターの配列。 既定 (フィルターなし) を使用するには、空の配列を省略または指定します。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string[] |
searchCriteria | 更新プログラムを検索する条件。 既定値 (すべて検索) を使用するには、空の文字列を省略または指定します。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string |
updateLimit | 一度に適用する更新プログラムの最大数。 既定値を使用するには、0 を省略または指定します (1000) | INT |
ImageTemplateDistributor
名前 | 説明 | 値 |
---|---|---|
artifactTags | ディストリビューターによって作成または更新されると、成果物に適用されるタグ。 | object |
runOutputName | 関連付けられた RunOutput に使用する名前。 | string (必須) |
型 | オブジェクトの種類を設定する | ManagedImage SharedImage VHD (必須) |
ImageTemplateManagedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'ManagedImage' (必須) |
imageId | マネージド ディスク イメージのリソース ID | string (必須) |
location | イメージの Azure の場所は、イメージが既に存在する場合は一致する必要があります | string (必須) |
ImageTemplateSharedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'SharedImage' (必須) |
excludeFromLatest | 作成されたイメージ バージョンを最新のバージョンから除外するかどうかを示すフラグ。 既定値 (false) を使用する場合は 省略します。 | [bool] |
galleryImageId | Shared Image Gallery イメージのリソース ID | string (必須) |
replicationRegions | イメージがレプリケートされるリージョンの一覧 | string[] (必須) |
storageAccountType | 共有イメージの格納に使用するストレージ アカウントの種類。 既定値 (Standard_LRS) を使用する場合は 省略します。 | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'VHD' (必須) |
ImageTemplateSource
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ManagedImage PlatformImage SharedImageVersion (必須) |
ImageTemplateManagedImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'ManagedImage' (必須) |
imageId | 顧客サブスクリプション内のマネージド イメージの ARM リソース ID | string (必須) |
ImageTemplatePlatformImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'PlatformImage' (必須) |
offer | Azure ギャラリー イメージからのイメージ オファー。 | string |
planInfo | プラットフォーム イメージの購入プランのオプション構成。 | PlatformImagePurchasePlan |
publisher | Azure ギャラリー イメージの Image Publisher。 | string |
sku | Azure ギャラリー イメージのイメージ SKU。 | string |
version | Azure ギャラリー イメージのイメージ バージョン。 ここで 'latest' を指定すると、テンプレートの送信時ではなく、イメージ ビルドの実行時にバージョンが評価されます。 | string |
PlatformImagePurchasePlan
名前 | 説明 | 値 |
---|---|---|
planName | 購入プランの名前。 | string (必須) |
planProduct | 購入プランの製品。 | string (必須) |
planPublisher | 購入プランの発行元。 | string (必須) |
ImageTemplateSharedImageVersionSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'SharedImageVersion' (必須) |
imageVersionId | 共有イメージ ギャラリー内のイメージ バージョンの ARM リソース ID | string (必須) |
ImageTemplatePropertiesValidate
名前 | 説明 | 値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合でも、出力イメージは分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンド ツー エンドのイメージ実行が失敗したと報告されます。 [注: 検証が成功した場合、このフィールドは無効です。] | [bool] |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | [bool] |
ImageTemplateInVMValidator
名前 | 説明 | 値 |
---|---|---|
name | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | PowerShell シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'PowerShell' (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは管理者特権で実行されます | [bool] |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などです。 | string |
sha256Checksum | 上の scriptUri フィールドに用意されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'Shell' (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 github リンク、Azure Storage URI などです | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateVmProfile
名前 | 説明 | 値 |
---|---|---|
osDiskSizeGB | OS ディスクのサイズ (GB 単位)。 Azure の既定の OS ディスク サイズを使用するには、0 を省略するか、指定します。 | INT |
userAssignedIdentities | ビルド VM と検証 VM で構成するユーザー割り当てマネージド ID のリソース ID のオプション配列。 これには、イメージ テンプレートの ID が含まれる場合があります。 | string[] |
vmSize | イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。 既定 (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合は Standard_D2ds_v4) を使用するには、空の文字列を省略または指定します。 | string |
vnetConfig | ビルド VM と検証 VM のデプロイに使用する仮想ネットワークのオプション構成。 特定の仮想ネットワークを使用する必要がない場合は、省略します。 | VirtualNetworkConfig |
VirtualNetworkConfig
名前 | 説明 | 値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定値 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | string |
subnetId | 既存のサブネットのリソース ID。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Windows ベースラインを使用した Azure Image Builder |
Azure Image Builder 環境を作成し、最新の Windows 更新と Azure Windows ベースラインが適用された Windows Server イメージをビルドします。 |
Dev Box サービスを構成する |
このテンプレートでは、Dev Box クイック スタート ガイドに従って、すべての Dev Box 管理リソースが作成されます。 作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。 |
ARM テンプレート リソース定義
imageTemplates リソースの種類は、次のようにデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.VirtualMachineImages/imageTemplates リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2022-02-14",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"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
},
"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": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
}
}
ImageTemplateCustomizer オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
[ファイル] には、次の値を使用します。
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
PowerShell の場合は、次の値を使用します。
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Shell の場合は、次のコマンドを使用します。
"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 オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
ManagedImage の場合は、次の値を使用します。
"type": "ManagedImage",
"imageId": "string",
"location": "string"
SharedImage の場合は、次の値を使用します。
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
VHD の場合は、次の値を使用します。
"type": "VHD"
ImageTemplateSource オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
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"
ImageTemplateInVMValidator オブジェクト
type プロパティを設定して、オブジェクトの種類を指定します。
PowerShell の場合は、次の値を使用します。
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Shell の場合は、次のコマンドを使用します。
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
プロパティ値
imageTemplates
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.VirtualMachineImages/imageTemplates' |
apiVersion | リソース API のバージョン | '2022-02-14' |
name | リソース名 | string (必須) |
location | リソースが保存されている地理的な場所 | string (必須) |
tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
identity | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
properties | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 説明 | 値 |
---|---|---|
type | イメージ テンプレートに使用される ID の種類。 型 'None' では、イメージ テンプレートから ID が削除されます。 | 'None' 'UserAssigned' |
userAssignedIdentities | イメージ テンプレートに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | object |
ImageTemplateProperties
名前 | 説明 | 値 |
---|---|---|
buildTimeoutInMinutes | (すべてのカスタマイズ、検証、配布を含む) イメージ テンプレートの構築中に待機する最大継続期間。 既定値 (4 時間) を使用するには、0 を省略または指定します。 | INT |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用されるプロパティを指定します。 | ImageTemplateCustomizer[] |
配布 (distribute) | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
source | ソース イメージの記述に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドで指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定したリソース グループが存在する場合は、イメージ テンプレートと同じリージョン内に空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、テンプレートの削除中に作成されたリソース グループは削除されますが、指定されたリソース グループが存在する場合、テンプレートの削除中にリソース グループに作成されたリソースは削除され、リソース グループ自体は残ります。 | string |
validate | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
vmProfile | イメージをビルドするように仮想マシンを設定する方法について説明します | ImageTemplateVmProfile |
ImageTemplateCustomizer
名前 | 説明 | 値 |
---|---|---|
name | このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | [最近使ったファイル] PowerShell Shell WindowsRestart WindowsUpdate (必須) |
ImageTemplateFileCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'File' (必須) |
destination | ファイル (sourceUri から) が VM にアップロードされるファイルへの絶対パス (入れ子になったディレクトリ構造が既に作成されています) | string |
sha256Checksum | 上記の sourceUri フィールドに指定されたファイルの SHA256 チェックサム | string |
sourceUri | VM をカスタマイズするためにアップロードするファイルの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
ImageTemplatePowerShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'PowerShell' (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | [bool] |
scriptUri | カスタマイズのために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | 上記の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'Shell' (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | カスタマイズのために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateRestartCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'WindowsRestart' (必須) |
restartCheckCommand | 再起動が成功した場合にチェックするコマンド [既定値: ''] | string |
restartCommand | 再起動を実行するコマンド [既定値: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
restartTimeout | 大きさと単位の文字列として指定された再起動タイムアウト (例: '5m' (5 分) または '2h' (2 時間) [既定値: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | 'WindowsUpdate' (必須) |
filters | 適用する更新プログラムを選択するフィルターの配列。 既定値 (フィルターなし) を使用するには、空の配列を省略または指定します。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string[] |
searchCriteria | 更新プログラムを検索する条件。 既定値を使用するには、空の文字列を省略するか指定します (すべて検索)。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string |
updateLimit | 一度に適用する更新の最大数。 既定値を使用するには、0 を省略または指定します (1000) | INT |
ImageTemplateDistributor
名前 | 説明 | 値 |
---|---|---|
artifactTags | ディストリビューターによって作成または更新された成果物に適用されるタグ。 | object |
runOutputName | 関連付けられた RunOutput に使用する名前。 | string (必須) |
型 | オブジェクトの種類を設定する | ManagedImage SharedImage VHD (必須) |
ImageTemplateManagedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'ManagedImage' (必須) |
imageId | マネージド ディスク イメージのリソース ID | string (必須) |
location | イメージの Azure の場所は、イメージが既に存在する場合は一致する必要があります | string (必須) |
ImageTemplateSharedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'SharedImage' (必須) |
excludeFromLatest | 作成されたイメージ バージョンを最新のバージョンから除外するかどうかを示すフラグ。 既定値 (false) を使用する場合は 省略します。 | [bool] |
galleryImageId | Shared Image Gallery イメージのリソース ID | string (必須) |
replicationRegions | イメージがレプリケートされるリージョンの一覧 | string[] (必須) |
storageAccountType | 共有イメージの格納に使用するストレージ アカウントの種類。 既定値 (Standard_LRS) を使用する場合は 省略します。 | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | 'VHD' (必須) |
ImageTemplateSource
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ManagedImage PlatformImage SharedImageVersion (必須) |
ImageTemplateManagedImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'ManagedImage' (必須) |
imageId | 顧客サブスクリプション内のマネージド イメージの ARM リソース ID | string (必須) |
ImageTemplatePlatformImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'PlatformImage' (必須) |
offer | Azure ギャラリー イメージからのイメージ オファー。 | string |
planInfo | プラットフォーム イメージの購入プランのオプション構成。 | PlatformImagePurchasePlan |
publisher | Azure ギャラリー イメージの Image Publisher。 | string |
sku | Azure ギャラリー イメージのイメージ SKU。 | string |
version | Azure ギャラリー イメージのイメージ バージョン。 ここで 'latest' を指定すると、テンプレートの送信時ではなく、イメージ ビルドの実行時にバージョンが評価されます。 | string |
PlatformImagePurchasePlan
名前 | 説明 | 値 |
---|---|---|
planName | 購入プランの名前。 | string (必須) |
planProduct | 購入プランの製品。 | string (必須) |
planPublisher | 購入プランの発行元。 | string (必須) |
ImageTemplateSharedImageVersionSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | 'SharedImageVersion' (必須) |
imageVersionId | 共有イメージ ギャラリー内のイメージ バージョンの ARM リソース ID | string (必須) |
ImageTemplatePropertiesValidate
名前 | 説明 | 値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合でも、出力イメージは分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンドツーエンドのイメージ実行が失敗したと報告されます。 [注: 検証が成功した場合、このフィールドは無効です。] | [bool] |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | [bool] |
ImageTemplateInVMValidator
名前 | 説明 | 値 |
---|---|---|
name | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | PowerShell シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'PowerShell' (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | [bool] |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 github リンク、Azure Storage URI などです | string |
sha256Checksum | 上記の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'Shell' (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 github リンク、Azure Storage URI などです | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateVmProfile
名前 | 説明 | 値 |
---|---|---|
osDiskSizeGB | OS ディスクのサイズ (GB 単位)。 Azure の既定の OS ディスク サイズを使用するには、0 を省略するか、指定します。 | INT |
userAssignedIdentities | ビルド VM と検証 VM で構成するユーザー割り当てマネージド ID のリソース ID のオプション配列。 これには、イメージ テンプレートの ID が含まれる場合があります。 | string[] |
vmSize | イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。 既定 (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合は Standard_D2ds_v4) を使用するには、空の文字列を省略または指定します。 | string |
vnetConfig | ビルド VM と検証 VM のデプロイに使用する仮想ネットワークのオプション構成。 特定の仮想ネットワークを使用する必要がない場合は、省略します。 | VirtualNetworkConfig |
VirtualNetworkConfig
名前 | 説明 | 値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | string |
subnetId | 既存のサブネットのリソース ID。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
Azure Image Builder と Azure Windows ベースライン |
Azure Image Builder 環境を作成し、最新の Windows 更新と Azure Windows ベースラインが適用された Windows Server イメージを構築します。 |
Dev Box サービスを構成する |
このテンプレートでは、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@2022-02-14"
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
}
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 = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
ImageTemplateCustomizer オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
[ファイル] には、次の値を使用します。
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
PowerShell の場合は、次の値を使用します。
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Shell の場合は、次のコマンドを使用します。
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 オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
ManagedImage の場合は、次の値を使用します。
type = "ManagedImage"
imageId = "string"
location = "string"
SharedImage の場合は、次の値を使用します。
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
VHD の場合は、次の値を使用します。
type = "VHD"
ImageTemplateSource オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
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"
ImageTemplateInVMValidator オブジェクト
オブジェクトの 型 を指定するには、type プロパティを設定します。
PowerShell の場合は、次の値を使用します。
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Shell の場合は、次のコマンドを使用します。
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
プロパティ値
imageTemplates
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14" |
name | リソース名 | string (必須) |
location | リソースが保存されている地理的な場所 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソース タグ。 | タグの名前と値のディクショナリ。 |
identity | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
properties | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 説明 | 値 |
---|---|---|
type | イメージ テンプレートに使用される ID の種類。 型 'None' では、イメージ テンプレートから ID が削除されます。 | "UserAssigned" |
identity_ids | イメージ テンプレートに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | ユーザー ID ID の配列。 |
ImageTemplateProperties
名前 | 説明 | 値 |
---|---|---|
buildTimeoutInMinutes | (すべてのカスタマイズ、検証、配布を含む) イメージ テンプレートの構築中に待機する最大継続期間。 既定値 (4 時間) を使用するには、0 を省略または指定します。 | INT |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用されるプロパティを指定します。 | ImageTemplateCustomizer[] |
配布 (distribute) | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
source | ソース イメージの記述に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドで指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定したリソース グループが存在する場合は、イメージ テンプレートと同じリージョン内に空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、テンプレートの削除中に作成されたリソース グループは削除されますが、指定されたリソース グループが存在する場合、テンプレートの削除中にリソース グループに作成されたリソースは削除され、リソース グループ自体は残ります。 | string |
validate | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
vmProfile | イメージをビルドするように仮想マシンを設定する方法について説明します | ImageTemplateVmProfile |
ImageTemplateCustomizer
名前 | 説明 | 値 |
---|---|---|
name | このカスタマイズ手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | [最近使ったファイル] PowerShell Shell WindowsRestart WindowsUpdate (必須) |
ImageTemplateFileCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | "File" (必須) |
destination | ファイル (sourceUri から) が VM にアップロードされるファイルへの絶対パス (入れ子になったディレクトリ構造が既に作成されています) | string |
sha256Checksum | 上記の sourceUri フィールドに指定されたファイルの SHA256 チェックサム | string |
sourceUri | VM をカスタマイズするためにアップロードするファイルの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
ImageTemplatePowerShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | "PowerShell" (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは管理者特権で実行されます | [bool] |
scriptUri | カスタマイズのために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | 上の scriptUri フィールドに用意されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | "Shell" (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | カスタマイズのために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage の SAS URI などです。 | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateRestartCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | "WindowsRestart" (必須) |
restartCheckCommand | 再起動に成功した場合にチェックするコマンド [既定値: ''] | string |
restartCommand | 再起動を実行するコマンド [既定値: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
restartTimeout | "5m" (5 分) や '2h' (2 時間) など、大きさと単位の文字列として指定された再起動タイムアウト [既定値: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用するカスタマイズ ツールの種類。 たとえば、"Shell" はシェル カスタマイザーにすることができます | "WindowsUpdate" (必須) |
filters | 適用する更新プログラムを選択するフィルターの配列。 既定 (フィルターなし) を使用するには、空の配列を省略または指定します。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string[] |
searchCriteria | 更新プログラムを検索する条件。 既定値 (すべて検索) を使用するには、空の文字列を省略または指定します。 このフィールドの例と詳細な説明については、上記のリンクを参照してください。 | string |
updateLimit | 一度に適用する更新プログラムの最大数。 既定値を使用するには、0 を省略または指定します (1000) | INT |
ImageTemplateDistributor
名前 | 説明 | 値 |
---|---|---|
artifactTags | ディストリビューターによって作成または更新されると、成果物に適用されるタグ。 | object |
runOutputName | 関連付けられた RunOutput に使用する名前。 | string (必須) |
型 | オブジェクトの種類を設定する | ManagedImage SharedImage VHD (必須) |
ImageTemplateManagedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | "ManagedImage" (必須) |
imageId | マネージド ディスク イメージのリソース ID | string (必須) |
location | イメージの Azure の場所は、イメージが既に存在する場合は一致する必要があります | string (必須) |
ImageTemplateSharedImageDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | "SharedImage" (必須) |
excludeFromLatest | 作成されたイメージ バージョンを最新のバージョンから除外するかどうかを示すフラグ。 既定値 (false) を使用する場合は 省略します。 | [bool] |
galleryImageId | Shared Image Gallery イメージのリソース ID | string (必須) |
replicationRegions | イメージがレプリケートされるリージョンの一覧 | string[] (必須) |
storageAccountType | 共有イメージの格納に使用するストレージ アカウントの種類。 既定値 (Standard_LRS) を使用する場合は 省略します。 | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
名前 | 説明 | 値 |
---|---|---|
type | 分布の種類。 | "VHD" (必須) |
ImageTemplateSource
名前 | 説明 | 値 |
---|---|---|
type | オブジェクトの種類を設定する | ManagedImage PlatformImage SharedImageVersion (必須) |
ImageTemplateManagedImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | "ManagedImage" (必須) |
imageId | 顧客サブスクリプション内のマネージド イメージの ARM リソース ID | string (必須) |
ImageTemplatePlatformImageSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | "PlatformImage" (必須) |
offer | Azure ギャラリー イメージからのイメージ オファー。 | string |
planInfo | プラットフォーム イメージの購入プランのオプション構成。 | PlatformImagePurchasePlan |
publisher | Azure ギャラリー イメージの Image Publisher。 | string |
sku | Azure ギャラリー イメージのイメージ SKU。 | string |
version | Azure ギャラリー イメージのイメージ バージョン。 ここで 'latest' を指定すると、テンプレートの送信時ではなく、イメージ ビルドの実行時にバージョンが評価されます。 | string |
PlatformImagePurchasePlan
名前 | 説明 | 値 |
---|---|---|
planName | 購入プランの名前。 | string (必須) |
planProduct | 購入プランの製品。 | string (必須) |
planPublisher | 購入プランの発行元。 | string (必須) |
ImageTemplateSharedImageVersionSource
名前 | 説明 | 値 |
---|---|---|
type | 開始するソース イメージの種類を指定します。 | "SharedImageVersion" (必須) |
imageVersionId | 共有イメージ ギャラリー内のイメージ バージョンの ARM リソース ID | string (必須) |
ImageTemplatePropertiesValidate
名前 | 説明 | 値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合でも、出力イメージは分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンド ツー エンドのイメージ実行が失敗したと報告されます。 [注: 検証が成功した場合、このフィールドは無効です。] | [bool] |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | [bool] |
ImageTemplateInVMValidator
名前 | 説明 | 値 |
---|---|---|
name | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | string |
type | オブジェクトの種類を設定する | PowerShell シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | "PowerShell" (必須) |
inline | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して管理者特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | [bool] |
runElevated | 指定した場合、PowerShell スクリプトは管理者特権で実行されます | [bool] |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などです。 | string |
sha256Checksum | 上の scriptUri フィールドに用意されている Power Shell スクリプトの SHA256 チェックサム | string |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 説明 | 値 |
---|---|---|
type | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | "Shell" (必須) |
inline | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage URI などです。 | string |
sha256Checksum | scriptUri フィールドで提供されるシェル スクリプトの SHA256 チェックサム | string |
ImageTemplateVmProfile
名前 | 説明 | 値 |
---|---|---|
osDiskSizeGB | OS ディスクのサイズ (GB 単位)。 Azure の既定の OS ディスク サイズを使用するには、0 を省略または指定します。 | INT |
userAssignedIdentities | ビルド VM と検証 VM で構成するユーザー割り当てマネージド ID のリソース ID のオプション配列。 これには、イメージ テンプレートの ID が含まれる場合があります。 | string[] |
vmSize | イメージのビルド、カスタマイズ、キャプチャに使用される仮想マシンのサイズ。 既定 (Gen1 イメージの場合はStandard_D1_v2、Gen2 イメージの場合はStandard_D2ds_v4) を使用するには、空の文字列を省略または指定します。 | string |
vnetConfig | ビルド VM と検証 VM のデプロイに使用する仮想ネットワークのオプションの構成。 特定の仮想ネットワークを使用する必要がない場合は、省略します。 | VirtualNetworkConfig |
VirtualNetworkConfig
名前 | 説明 | 値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | string |
subnetId | 既存のサブネットのリソース ID。 | string |