ImageTemplate interface

Pacote:

@azure/arm-imagebuilder

O modelo de imagem é um recurso do ARM gerenciado pelo provedor Microsoft.VirtualMachineImages

Extends

TrackedResource

Propriedades

autoRun	Indica se o modelo de imagem deve ou não ser executado automaticamente na criação ou atualização do modelo.
buildTimeoutInMinutes	Duração máxima para aguardar durante a criação do modelo de imagem (inclui todas as personalizações, otimização, validações e distribuições). Omita ou especifique 0 para usar o padrão (4 horas).
customize	Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc.
distribute	A distribuição é direcionada para onde a saída da imagem precisa ir.
errorHandling	Opções de tratamento de erros após uma falha de build
exactStagingResourceGroup	A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Esse campo somente leitura difere de "stagingResourceGroup" somente se o valor especificado no campo 'stagingResourceGroup' estiver vazio. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
identity	A identidade do modelo de imagem, se configurada.
lastRunStatus	Estado de "run" que está em execução ou foi executado pela última vez. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
managedResourceTags	Marcas que serão aplicadas ao grupo de recursos e/ou recursos criados pelo serviço.
optimize	Especifica a otimização a ser executada na imagem.
provisioningError	Erro de provisionamento, se houver OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
provisioningState	Estado de provisionamento do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
source	Especifica as propriedades usadas para descrever a imagem de origem.
stagingResourceGroup	A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Se esse campo estiver vazio, um grupo de recursos com um nome aleatório será criado. Se o grupo de recursos especificado neste campo não existir, ele será criado com o mesmo nome. Se o grupo de recursos especificado existir, ele deverá estar vazio e na mesma região que o modelo de imagem. O grupo de recursos criado será excluído durante a exclusão do modelo se esse campo estiver vazio ou o grupo de recursos especificado não existir, mas se o grupo de recursos especificado existir, os recursos criados no grupo de recursos serão excluídos durante a exclusão do modelo e o próprio grupo de recursos permanecerá.
validate	Opções de configuração e lista de validações a serem executadas na imagem resultante.
vmProfile	Descreve como a máquina virtual é configurada para criar imagens

Propriedades herdadas

id	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
location	A localização geográfica onde o recurso reside
name	O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags	Marcas de recurso.
type	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

autoRun

Indica se o modelo de imagem deve ou não ser executado automaticamente na criação ou atualização do modelo.

autoRun?: ImageTemplateAutoRun

Valor da propriedade

ImageTemplateAutoRun

buildTimeoutInMinutes

Duração máxima para aguardar durante a criação do modelo de imagem (inclui todas as personalizações, otimização, validações e distribuições). Omita ou especifique 0 para usar o padrão (4 horas).

buildTimeoutInMinutes?: number

Valor da propriedade

number

customize

Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc.

customize?: ImageTemplateCustomizerUnion[]

Valor da propriedade

ImageTemplateCustomizerUnion[]

distribute

A distribuição é direcionada para onde a saída da imagem precisa ir.

distribute?: ImageTemplateDistributorUnion[]

Valor da propriedade

ImageTemplateDistributorUnion[]

errorHandling

Opções de tratamento de erros após uma falha de build

errorHandling?: ImageTemplatePropertiesErrorHandling

Valor da propriedade

ImageTemplatePropertiesErrorHandling

exactStagingResourceGroup

A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Esse campo somente leitura difere de "stagingResourceGroup" somente se o valor especificado no campo 'stagingResourceGroup' estiver vazio. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

exactStagingResourceGroup?: string

Valor da propriedade

string

identity

A identidade do modelo de imagem, se configurada.

identity: ImageTemplateIdentity

Valor da propriedade

ImageTemplateIdentity

lastRunStatus

Estado de "run" que está em execução ou foi executado pela última vez. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

lastRunStatus?: ImageTemplateLastRunStatus

Valor da propriedade

ImageTemplateLastRunStatus

managedResourceTags

Marcas que serão aplicadas ao grupo de recursos e/ou recursos criados pelo serviço.

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

Valor da propriedade

{[propertyName: string]: string}

optimize

Especifica a otimização a ser executada na imagem.

optimize?: ImageTemplatePropertiesOptimize

Valor da propriedade

ImageTemplatePropertiesOptimize

provisioningError

Erro de provisionamento, se houver OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningError?: ProvisioningError

Valor da propriedade

ProvisioningError

provisioningState

Estado de provisionamento do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: ProvisioningState

Valor da propriedade

ProvisioningState

source

Especifica as propriedades usadas para descrever a imagem de origem.

source?: ImageTemplateSourceUnion

Valor da propriedade

ImageTemplateSourceUnion

stagingResourceGroup

A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Se esse campo estiver vazio, um grupo de recursos com um nome aleatório será criado. Se o grupo de recursos especificado neste campo não existir, ele será criado com o mesmo nome. Se o grupo de recursos especificado existir, ele deverá estar vazio e na mesma região que o modelo de imagem. O grupo de recursos criado será excluído durante a exclusão do modelo se esse campo estiver vazio ou o grupo de recursos especificado não existir, mas se o grupo de recursos especificado existir, os recursos criados no grupo de recursos serão excluídos durante a exclusão do modelo e o próprio grupo de recursos permanecerá.

stagingResourceGroup?: string

Valor da propriedade

string

validate

Opções de configuração e lista de validações a serem executadas na imagem resultante.

validate?: ImageTemplatePropertiesValidate

Valor da propriedade

ImageTemplatePropertiesValidate

vmProfile

Descreve como a máquina virtual é configurada para criar imagens

vmProfile?: ImageTemplateVmProfile

Valor da propriedade

ImageTemplateVmProfile

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

herdado deTrackedResource.id

location

A localização geográfica onde o recurso reside

location: string

Valor da propriedade

string

Herdado deTrackedResource.location

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

herdado deTrackedResource.name

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

systemData?: SystemData

Valor da propriedade

SystemData

herdado detrackedResource.systemData

tags

Marcas de recurso.

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

Valor da propriedade

{[propertyName: string]: string}

Herdado deTrackedResource.tags

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deTrackedResource.type