ImageTemplate interface

Paquete:

@azure/arm-imagebuilder

La plantilla de imagen es un recurso de ARM administrado por el proveedor Microsoft.VirtualMachineImages.

Extends

TrackedResource

Propiedades

autoRun	Indica si se va a ejecutar o no automáticamente la compilación de la plantilla de imagen en la creación o actualización de la plantilla.
buildTimeoutInMinutes	Duración máxima para esperar al compilar la plantilla de imagen (incluye todas las personalizaciones, optimización, validaciones y distribuciones). Omita o especifique 0 para usar el valor predeterminado (4 horas).
customize	Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc.
distribute	Los destinos de distribución a los que debe ir la salida de la imagen.
errorHandling	Opciones de control de errores tras un error de compilación
exactStagingResourceGroup	Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Este campo de solo lectura difiere de "stagingResourceGroup" solo si el valor especificado en el campo "stagingResourceGroup" está vacío. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
identity	Identidad de la plantilla de imagen, si está configurada.
lastRunStatus	Estado de "run" que se está ejecutando actualmente o que se ejecutó por última vez. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
managedResourceTags	Etiquetas que se aplicarán al grupo de recursos o a los recursos creados por el servicio.
optimize	Especifica la optimización que se va a realizar en la imagen.
provisioningError	Error de aprovisionamiento, si hay alguna NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
provisioningState	Estado de aprovisionamiento del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
source	Especifica las propiedades usadas para describir la imagen de origen.
stagingResourceGroup	Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Si este campo está vacío, se creará un grupo de recursos con un nombre aleatorio. Si el grupo de recursos especificado en este campo no existe, se creará con el mismo nombre. Si el grupo de recursos especificado existe, debe estar vacío y en la misma región que la plantilla de imagen. El grupo de recursos creado se eliminará durante la eliminación de la plantilla si este campo está vacío o el grupo de recursos especificado no existe, pero si el grupo de recursos especificado existe los recursos creados en el grupo de recursos se eliminarán durante la eliminación de la plantilla y el propio grupo de recursos permanecerá.
validate	Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante.
vmProfile	Describe cómo se configura la máquina virtual para compilar imágenes

Propiedades heredadas

id	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
location	Ubicación geográfica donde reside el recurso
name	El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
tags	Etiquetas de recursos.
type	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

autoRun

Indica si se va a ejecutar o no automáticamente la compilación de la plantilla de imagen en la creación o actualización de la plantilla.

autoRun?: ImageTemplateAutoRun

Valor de propiedad

ImageTemplateAutoRun

buildTimeoutInMinutes

Duración máxima para esperar al compilar la plantilla de imagen (incluye todas las personalizaciones, optimización, validaciones y distribuciones). Omita o especifique 0 para usar el valor predeterminado (4 horas).

buildTimeoutInMinutes?: number

Valor de propiedad

number

customize

Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc.

customize?: ImageTemplateCustomizerUnion[]

Valor de propiedad

ImageTemplateCustomizerUnion[]

distribute

Los destinos de distribución a los que debe ir la salida de la imagen.

distribute?: ImageTemplateDistributorUnion[]

Valor de propiedad

ImageTemplateDistributorUnion[]

errorHandling

Opciones de control de errores tras un error de compilación

errorHandling?: ImageTemplatePropertiesErrorHandling

Valor de propiedad

ImageTemplatePropertiesErrorHandling

exactStagingResourceGroup

Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Este campo de solo lectura difiere de "stagingResourceGroup" solo si el valor especificado en el campo "stagingResourceGroup" está vacío. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

exactStagingResourceGroup?: string

Valor de propiedad

string

identity

Identidad de la plantilla de imagen, si está configurada.

identity: ImageTemplateIdentity

Valor de propiedad

ImageTemplateIdentity

lastRunStatus

Estado de "run" que se está ejecutando actualmente o que se ejecutó por última vez. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

lastRunStatus?: ImageTemplateLastRunStatus

Valor de propiedad

ImageTemplateLastRunStatus

managedResourceTags

Etiquetas que se aplicarán al grupo de recursos o a los recursos creados por el servicio.

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

Valor de propiedad

{[propertyName: string]: string}

optimize

Especifica la optimización que se va a realizar en la imagen.

optimize?: ImageTemplatePropertiesOptimize

Valor de propiedad

ImageTemplatePropertiesOptimize

provisioningError

Error de aprovisionamiento, si hay alguna NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

provisioningError?: ProvisioningError

Valor de propiedad

ProvisioningError

provisioningState

Estado de aprovisionamiento del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

provisioningState?: ProvisioningState

Valor de propiedad

ProvisioningState

source

Especifica las propiedades usadas para describir la imagen de origen.

source?: ImageTemplateSourceUnion

Valor de propiedad

ImageTemplateSourceUnion

stagingResourceGroup

Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Si este campo está vacío, se creará un grupo de recursos con un nombre aleatorio. Si el grupo de recursos especificado en este campo no existe, se creará con el mismo nombre. Si el grupo de recursos especificado existe, debe estar vacío y en la misma región que la plantilla de imagen. El grupo de recursos creado se eliminará durante la eliminación de la plantilla si este campo está vacío o el grupo de recursos especificado no existe, pero si el grupo de recursos especificado existe los recursos creados en el grupo de recursos se eliminarán durante la eliminación de la plantilla y el propio grupo de recursos permanecerá.

stagingResourceGroup?: string

Valor de propiedad

string

validate

Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante.

validate?: ImageTemplatePropertiesValidate

Valor de propiedad

ImageTemplatePropertiesValidate

vmProfile

Describe cómo se configura la máquina virtual para compilar imágenes

vmProfile?: ImageTemplateVmProfile

Valor de propiedad

ImageTemplateVmProfile

Detalles de las propiedades heredadas

id

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

heredado deTrackedResource.id

location

Ubicación geográfica donde reside el recurso

location: string

Valor de propiedad

string

heredado detrackedResource.location

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

heredado deTrackedResource.name

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

systemData?: SystemData

Valor de propiedad

SystemData

heredado detrackedResource.systemData

tags

Etiquetas de recursos.

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

Valor de propiedad

{[propertyName: string]: string}

Heredado deTrackedResource.tags

type

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredar detrackedResource.type