Share via

ImageTemplate interface

  • Reference
Package:
@azure/arm-imagebuilder

Image template is an ARM resource managed by Microsoft.VirtualMachineImages provider

Extends
TrackedResource

Properties

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. NOTE: This property will not be serialized. It can only be populated by the server.
identity

The identity of the image template, if configured.
lastRunStatus

State of 'run' that is currently executing or was last executed. NOTE: This property will not be serialized. It can only be populated by the server.
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 NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state of the resource NOTE: This property will not be serialized. It can only be populated by the server.
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

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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. NOTE: This property will not be serialized. It can only be populated by the server.

exactStagingResourceGroup?: string

Property Value

string

identity

The identity of the image template, if configured.

identity: ImageTemplateIdentity

Property Value

ImageTemplateIdentity

lastRunStatus

State of 'run' that is currently executing or was last executed. NOTE: This property will not be serialized. It can only be populated by the server.

lastRunStatus?: ImageTemplateLastRunStatus

Property Value

ImageTemplateLastRunStatus

managedResourceTags

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

managedResourceTags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

optimize

Specifies optimization to be performed on image.

optimize?: ImageTemplatePropertiesOptimize

Property Value

ImageTemplatePropertiesOptimize

provisioningError

Provisioning error, if any NOTE: This property will not be serialized. It can only be populated by the server.

provisioningError?: ProvisioningError

Property Value

ProvisioningError

provisioningState

Provisioning state of the resource NOTE: This property will not be serialized. It can only be populated by the server.

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

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type