Microsoft.VirtualMachineImages imageTemplates 2022-02-14
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: {
{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
}
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: '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'
ImageTemplateInVMValidator オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
PowerShellの場合は、次のコマンドを使用します。
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
シェルの場合は、次のコマンドを使用します。
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
プロパティ値
imageTemplates
名前 | 形容 | 価値 |
---|---|---|
名前 | リソース名 | string (必須) |
場所 | リソースが存在する地理的な場所 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
同一性 | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
プロパティ | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージ テンプレートに使用される ID の種類。 型 'None' は、イメージ テンプレートからすべての ID を削除します。 | 'None' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities の |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity の |
UserAssignedIdentity
このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ImageTemplateProperties
名前 | 形容 | 価値 |
---|---|---|
buildTimeoutInMinutes | イメージ テンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、検証、およびディストリビューションが含まれます)。 既定値 (4 時間) を使用するには、0 を省略するか指定します。 | int 制約: 最小値 = 0 最大値 = 960 |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。 | ImageTemplateCustomizer[] |
配る | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
源 | ソース イメージの説明に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドに指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定されたリソース グループが存在する場合は、イメージ テンプレートと同じリージョンに空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、作成されたリソース グループはテンプレートの削除中に削除されますが、指定されたリソース グループが存在する場合、リソース グループに作成されたリソースはテンプレートの削除中に削除され、リソース グループ自体は残ります。 | 糸 |
検証 | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
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 (必須) |
ImageTemplatePropertiesValidate
名前 | 形容 | 価値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合、出力イメージは引き続き分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンド ツー エンドのイメージの実行が失敗したと報告されます。 [注: 検証に成功した場合、このフィールドは無効です。] | bool |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | bool |
ImageTemplateInVMValidator
名前 | 形容 | 価値 |
---|---|---|
名前 | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | 糸 |
種類 | オブジェクトの種類を設定する | PowerShell の シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'PowerShell' (必須) |
インライン | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して昇格された特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | bool |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | bool |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | 上の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | 糸 |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'Shell' (必須) |
インライン | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | scriptUri フィールドに指定されたシェル スクリプトの SHA256 チェックサム | 糸 |
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 の |
VirtualNetworkConfig
名前 | 形容 | 価値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定値 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | 糸 |
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": "2022-02-14",
"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
},
"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": "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"
ImageTemplateInVMValidator オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
PowerShellの場合は、次のコマンドを使用します。
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
シェルの場合は、次のコマンドを使用します。
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
プロパティ値
imageTemplates
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | 'Microsoft.VirtualMachineImages/imageTemplates' |
apiVersion | リソース API のバージョン | '2022-02-14' |
名前 | リソース名 | string (必須) |
場所 | リソースが存在する地理的な場所 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
同一性 | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
プロパティ | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージ テンプレートに使用される ID の種類。 型 'None' は、イメージ テンプレートからすべての ID を削除します。 | 'None' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | UserAssignedIdentities の |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity の |
UserAssignedIdentity
このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ImageTemplateProperties
名前 | 形容 | 価値 |
---|---|---|
buildTimeoutInMinutes | イメージ テンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、検証、およびディストリビューションが含まれます)。 既定値 (4 時間) を使用するには、0 を省略するか指定します。 | int 制約: 最小値 = 0 最大値 = 960 |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。 | ImageTemplateCustomizer[] |
配る | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
源 | ソース イメージの説明に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドに指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定されたリソース グループが存在する場合は、イメージ テンプレートと同じリージョンに空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、作成されたリソース グループはテンプレートの削除中に削除されますが、指定されたリソース グループが存在する場合、リソース グループに作成されたリソースはテンプレートの削除中に削除され、リソース グループ自体は残ります。 | 糸 |
検証 | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
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 (必須) |
ImageTemplatePropertiesValidate
名前 | 形容 | 価値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合、出力イメージは引き続き分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンド ツー エンドのイメージの実行が失敗したと報告されます。 [注: 検証に成功した場合、このフィールドは無効です。] | bool |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | bool |
ImageTemplateInVMValidator
名前 | 形容 | 価値 |
---|---|---|
名前 | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | 糸 |
種類 | オブジェクトの種類を設定する | PowerShell の シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'PowerShell' (必須) |
インライン | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して昇格された特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | bool |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | bool |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | 上の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | 糸 |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | 'Shell' (必須) |
インライン | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | scriptUri フィールドに指定されたシェル スクリプトの SHA256 チェックサム | 糸 |
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 の |
VirtualNetworkConfig
名前 | 形容 | 価値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定値 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | 糸 |
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@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 = "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"
ImageTemplateInVMValidator オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
PowerShellの場合は、次のコマンドを使用します。
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
シェルの場合は、次のコマンドを使用します。
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
プロパティ値
imageTemplates
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14" |
名前 | リソース名 | string (必須) |
場所 | リソースが存在する地理的な場所 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 |
同一性 | イメージ テンプレートの ID (構成されている場合)。 | ImageTemplateIdentity (必須) |
プロパティ | イメージ テンプレートのプロパティ | ImageTemplateProperties |
ImageTemplateIdentity
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージ テンプレートに使用される ID の種類。 型 'None' は、イメージ テンプレートからすべての ID を削除します。 | "UserAssigned" |
identity_ids | リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 | ユーザー ID ID の配列。 |
UserAssignedIdentities
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | UserAssignedIdentity の |
UserAssignedIdentity
このオブジェクトには、配置時に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
ImageTemplateProperties
名前 | 形容 | 価値 |
---|---|---|
buildTimeoutInMinutes | イメージ テンプレートのビルド中に待機する最大時間 (すべてのカスタマイズ、検証、およびディストリビューションが含まれます)。 既定値 (4 時間) を使用するには、0 を省略するか指定します。 | int 制約: 最小値 = 0 最大値 = 960 |
カスタマイズ | イメージ ソースなど、イメージのカスタマイズ手順を記述するために使用するプロパティを指定します。 | ImageTemplateCustomizer[] |
配る | イメージ出力の移動先となる配布ターゲット。 | ImageTemplateDistributor[] (必須) |
源 | ソース イメージの説明に使用するプロパティを指定します。 | ImageTemplateSource (必須) |
stagingResourceGroup | イメージのビルドに使用されるイメージ テンプレートと同じサブスクリプション内のステージング リソース グループ ID。 このフィールドが空の場合は、ランダムな名前のリソース グループが作成されます。 このフィールドに指定されたリソース グループが存在しない場合は、同じ名前で作成されます。 指定されたリソース グループが存在する場合は、イメージ テンプレートと同じリージョンに空である必要があります。 このフィールドが空であるか、指定されたリソース グループが存在しない場合、作成されたリソース グループはテンプレートの削除中に削除されますが、指定されたリソース グループが存在する場合、リソース グループに作成されたリソースはテンプレートの削除中に削除され、リソース グループ自体は残ります。 | 糸 |
検証 | 結果のイメージに対して実行される構成オプションと検証の一覧。 | ImageTemplatePropertiesValidate |
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 (必須) |
ImageTemplatePropertiesValidate
名前 | 形容 | 価値 |
---|---|---|
continueDistributeOnFailure | 検証が失敗し、このフィールドが false に設定されている場合、出力イメージは分散されません。 これが既定の動作です。 検証が失敗し、このフィールドが true に設定されている場合、出力イメージは引き続き分散されます。 このオプションは、不適切なイメージが使用のために配布される可能性があるため、注意して使用してください。 いずれの場合も (true または false)、検証エラーが発生した場合に、エンド ツー エンドのイメージの実行が失敗したと報告されます。 [注: 検証に成功した場合、このフィールドは無効です。] | bool |
inVMValidations | 実行する検証の一覧。 | ImageTemplateInVMValidator[] |
sourceValidationOnly | このフィールドが true に設定されている場合、'source' セクションで指定されたイメージが直接検証されます。 カスタマイズされたイメージを生成して検証するために、個別のビルドは実行されません。 | bool |
ImageTemplateInVMValidator
名前 | 形容 | 価値 |
---|---|---|
名前 | この検証手順の内容に関するコンテキストを提供するフレンドリ名 | 糸 |
種類 | オブジェクトの種類を設定する | PowerShell の シェル (必須) |
ImageTemplatePowerShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | "PowerShell" (必須) |
インライン | 実行する PowerShell コマンドの配列 | string[] |
runAsSystem | 指定した場合、PowerShell スクリプトはローカル システム ユーザーを使用して昇格された特権で実行されます。 上記の runElevated フィールドが true に設定されている場合にのみ true を指定できます。 | bool |
runElevated | 指定した場合、PowerShell スクリプトは昇格された特権で実行されます | bool |
scriptUri | 検証のために実行する PowerShell スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | 上の scriptUri フィールドで提供されている Power Shell スクリプトの SHA256 チェックサム | 糸 |
validExitCodes | PowerShell スクリプトの有効な終了コード。 [既定値: 0] | int[] |
ImageTemplateShellValidator
名前 | 形容 | 価値 |
---|---|---|
種類 | イメージで使用する検証の種類。 たとえば、"Shell" はシェル検証にすることができます | "Shell" (必須) |
インライン | 実行するシェル コマンドの配列 | string[] |
scriptUri | 検証のために実行するシェル スクリプトの URI。 GitHub リンク、Azure Storage URI などを指定できます。 | 糸 |
sha256Checksum | scriptUri フィールドに指定されたシェル スクリプトの SHA256 チェックサム | 糸 |
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 の |
VirtualNetworkConfig
名前 | 形容 | 価値 |
---|---|---|
proxyVmSize | ビルド VM と検証 VM にトラフィックを渡すために使用されるプロキシ仮想マシンのサイズ。 既定値 (Standard_A1_v2) を使用するには、空の文字列を省略または指定します。 | 糸 |
subnetId | 既存のサブネットのリソース ID。 | 糸 |