你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ImageTemplate interface
映像模板是由 Microsoft.VirtualMachineImages 提供程序管理的 ARM 资源
- 扩展
属性
| auto |
指示是否在创建或更新模板时自动运行映像模板生成。 |
| build |
生成映像模板时等待的最大持续时间（包括所有自定义、优化、验证和分发）。 省略或指定 0 以使用默认值 （4 小时）。 |
| customize | 指定用于描述映像的自定义步骤的属性，如图像源等 |
| distribute | 映像输出需要转到的分发目标。 |
| error |
生成失败时的错误处理选项 |
| exact |
与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。 仅当“stagingResourceGroup”字段中指定的值为空时，此只读字段与“stagingResourceGroup”不同。 注意：此属性不会序列化。 它只能由服务器填充。 |
| identity | 映像模板的标识（如果已配置）。 |
| last |
当前正在执行的或上次执行的“run”状态。 注意：此属性不会序列化。 它只能由服务器填充。 |
| managed |
将应用于服务创建的资源组和/或资源的标记。 |
| optimize | 指定要对图像执行的优化。 |
| provisioning |
预配错误（如果有注意）：此属性不会序列化。 它只能由服务器填充。 |
| provisioning |
资源说明的预配状态：此属性不会序列化。 它只能由服务器填充。 |
| source | 指定用于描述源图像的属性。 |
| staging |
与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。 如果此字段为空，则会创建一个具有随机名称的资源组。 如果此字段中指定的资源组不存在，则会创建具有相同名称的资源组。 如果指定的资源组存在，则它必须是空的，并且与映像模板位于同一区域中。 如果此字段为空或指定的资源组不存在，则在模板删除期间将删除创建的资源组，但在模板删除期间将删除资源组中创建的资源，并且资源组本身将保留。 |
| validate | 要对生成的映像执行的验证的配置选项和列表。 |
| vm |
描述如何设置虚拟机以生成映像 |
继承属性
| id | 资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。 |
| location | 资源所在的地理位置 |
| name | 资源说明的名称：此属性不会序列化。 它只能由服务器填充。 |
| system |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。 |
| tags | 资源标记。 |
| type | 资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。 |
属性详细信息
autoRun
buildTimeoutInMinutes
生成映像模板时等待的最大持续时间（包括所有自定义、优化、验证和分发）。 省略或指定 0 以使用默认值 （4 小时）。
buildTimeoutInMinutes?: number属性值
number
customize
指定用于描述映像的自定义步骤的属性，如图像源等
customize?: ImageTemplateCustomizerUnion[]属性值
distribute
errorHandling
生成失败时的错误处理选项
errorHandling?: ImageTemplatePropertiesErrorHandling属性值
exactStagingResourceGroup
与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。 仅当“stagingResourceGroup”字段中指定的值为空时，此只读字段与“stagingResourceGroup”不同。 注意：此属性不会序列化。 它只能由服务器填充。
exactStagingResourceGroup?: string属性值
string
identity
lastRunStatus
当前正在执行的或上次执行的“run”状态。 注意：此属性不会序列化。 它只能由服务器填充。
lastRunStatus?: ImageTemplateLastRunStatus属性值
managedResourceTags
将应用于服务创建的资源组和/或资源的标记。
managedResourceTags?: {[propertyName: string]: string}属性值
{[propertyName: string]: string}
optimize
provisioningError
provisioningState
source
stagingResourceGroup
与用于生成映像的映像模板相同的订阅中的暂存资源组 ID。 如果此字段为空，则会创建一个具有随机名称的资源组。 如果此字段中指定的资源组不存在，则会创建具有相同名称的资源组。 如果指定的资源组存在，则它必须是空的，并且与映像模板位于同一区域中。 如果此字段为空或指定的资源组不存在，则在模板删除期间将删除创建的资源组，但在模板删除期间将删除资源组中创建的资源，并且资源组本身将保留。
stagingResourceGroup?: string属性值
string
validate
要对生成的映像执行的验证的配置选项和列表。
validate?: ImageTemplatePropertiesValidate属性值
vmProfile
继承属性详细信息
id
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。
id?: string属性值
string
继承自
location
name
资源说明的名称：此属性不会序列化。 它只能由服务器填充。
name?: string属性值
string
继承自
systemData
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
systemData?: SystemData属性值
tags
资源标记。
tags?: {[propertyName: string]: string}属性值
{[propertyName: string]: string}
type
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。
type?: string属性值
string