ImageTemplateProperties interface

Package:

@azure/arm-imagebuilder

Describes the properties of an image template

Properties

additionalDataDisks	Optional array of additional data disks to be added to the image.
autoRun	Indicates whether or not to automatically run the image template build on template creation or update.
buildTimeoutInMinutes	Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours).
customize	Specifies the properties used to describe the customization steps of the image, like Image source etc
distribute	The distribution targets where the image output needs to go to.
errorHandling	Error handling options upon a build failure
exactStagingResourceGroup	The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty.
lastRunStatus	State of 'run' that is currently executing or was last executed.
managedResourceTags	Tags that will be applied to the resource group and/or resources created by the service.
optimize	Specifies optimization to be performed on image.
provisioningError	Provisioning error, if any
provisioningState	Provisioning state of the resource
source	Specifies the properties used to describe the source image.
stagingResourceGroup	The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain.
validate	Configuration options and list of validations to be performed on the resulting image.
vmProfile	Describes how virtual machine is set up to build images

Property Details

additionalDataDisks

Optional array of additional data disks to be added to the image.

additionalDataDisks?: DataDisk[]

Property Value

DataDisk[]

autoRun

Indicates whether or not to automatically run the image template build on template creation or update.

autoRun?: ImageTemplateAutoRun

Property Value

ImageTemplateAutoRun

buildTimeoutInMinutes

Maximum duration to wait while building the image template (includes all customizations, optimization, validations, and distributions). Omit or specify 0 to use the default (4 hours).

buildTimeoutInMinutes?: number

Property Value

number

customize

Specifies the properties used to describe the customization steps of the image, like Image source etc

customize?: ImageTemplateCustomizerUnion[]

Property Value

ImageTemplateCustomizerUnion[]

distribute

The distribution targets where the image output needs to go to.

distribute: ImageTemplateDistributorUnion[]

Property Value

ImageTemplateDistributorUnion[]

errorHandling

Error handling options upon a build failure

errorHandling?: ImageTemplatePropertiesErrorHandling

Property Value

ImageTemplatePropertiesErrorHandling

exactStagingResourceGroup

The staging resource group id in the same subscription as the image template that will be used to build the image. This read-only field differs from 'stagingResourceGroup' only if the value specified in the 'stagingResourceGroup' field is empty.

exactStagingResourceGroup?: string

Property Value

string

lastRunStatus

State of 'run' that is currently executing or was last executed.

lastRunStatus?: ImageTemplateLastRunStatus

Property Value

ImageTemplateLastRunStatus

managedResourceTags

Tags that will be applied to the resource group and/or resources created by the service.

managedResourceTags?: Record<string, string>

Property Value

Record<string, string>

optimize

Specifies optimization to be performed on image.

optimize?: ImageTemplatePropertiesOptimize

Property Value

ImageTemplatePropertiesOptimize

provisioningError

Provisioning error, if any

provisioningError?: ProvisioningError

Property Value

ProvisioningError

provisioningState

Provisioning state of the resource

provisioningState?: ProvisioningState

Property Value

ProvisioningState

source

Specifies the properties used to describe the source image.

source: ImageTemplateSourceUnion

Property Value

ImageTemplateSourceUnion

stagingResourceGroup

The staging resource group id in the same subscription as the image template that will be used to build the image. If this field is empty, a resource group with a random name will be created. If the resource group specified in this field doesn't exist, it will be created with the same name. If the resource group specified exists, it must be empty and in the same region as the image template. The resource group created will be deleted during template deletion if this field is empty or the resource group specified doesn't exist, but if the resource group specified exists the resources created in the resource group will be deleted during template deletion and the resource group itself will remain.

stagingResourceGroup?: string

Property Value

string

validate

Configuration options and list of validations to be performed on the resulting image.

validate?: ImageTemplatePropertiesValidate

Property Value

ImageTemplatePropertiesValidate

vmProfile

Describes how virtual machine is set up to build images

vmProfile?: ImageTemplateVmProfile

Property Value

ImageTemplateVmProfile