Microsoft.VirtualMachineImages imageTemplates

Artigo
12/17/2024

Definição de recurso do Bicep

O tipo de recurso imageTemplates pode ser implantado com operações de destino:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoRun: {
      state: 'string'
    }
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    errorHandling: {
      onCustomizerError: 'string'
      onValidationError: 'string'
    }
    managedResourceTags: {
      {customized property}: 'string'
    }
    optimize: {
      vmBoot: {
        state: 'string'
      }
    }
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    stagingResourceGroup: 'string'
    validate: {
      continueDistributeOnFailure: bool
      inVMValidations: [
        {
          name: 'string'
          type: 'string'
          // For remaining properties, see ImageTemplateInVMValidator objects
        }
      ]
      sourceValidationOnly: bool
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        containerInstanceSubnetId: 'string'
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos ImageTemplateDistributor

Defina a propriedade tipo para especificar o tipo de objeto.

Para ManagedImage, use:

{
  imageId: 'string'
  location: 'string'
  type: 'ManagedImage'
}

Para SharedImage, use:

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  targetRegions: [
    {
      name: 'string'
      replicaCount: int
      storageAccountType: 'string'
    }
  ]
  type: 'SharedImage'
  versioning: {
    scheme: 'string'
    // For remaining properties, see DistributeVersioner objects
  }
}

Para VHD, use:

{
  type: 'VHD'
  uri: 'string'
}

Objetos DistributeVersioner

Defina o esquema propriedade para especificar o tipo de objeto.

Para última, use:

{
  major: int
  scheme: 'Latest'
}

Para de origem, use:

{
  scheme: 'Source'
}

Objetos ImageTemplateCustomizer

Defina a propriedade tipo para especificar o tipo de objeto.

Para de Arquivo, use:

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

Para do PowerShell, use:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

Para shell, use:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

Para windowsRestart, use:

{
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'
  type: 'WindowsRestart'
}

Para windowsUpdate, use:

{
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  type: 'WindowsUpdate'
  updateLimit: int
}

Objetos ImageTemplateInVMValidator

Defina a propriedade tipo para especificar o tipo de objeto.

Para de Arquivo, use:

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

Para do PowerShell, use:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

Para shell, use:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

Objetos ImageTemplateSource

Defina a propriedade tipo para especificar o tipo de objeto.

Para ManagedImage, use:

{
  imageId: 'string'
  type: 'ManagedImage'
}

Para PlatformImage, use:

{
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

Para SharedImageVersion, use:

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

Valores de propriedade

DistributeVersioner

Nome	Descrição	Valor
esquema	Defina como 'Latest' para o tipo DistributeVersionerLatest. Defina como "Origem" para o tipo DistributedVersionerSource.	'Latest' 'Origem' (obrigatório)

DistributeVersionerLatest

Nome	Descrição	Valor
principal	Versão principal do número de versão gerado. Determine o que é "mais recente" com base em versões com esse valor como a versão principal. -1 é equivalente a deixá-lo não definido.	int Restrições: Valor mínimo = -1
esquema	Esquema de numeração de versão a ser usado.	'Latest' (obrigatório)

DistributeVersionerSource

Nome	Descrição	Valor
esquema	Esquema de numeração de versão a ser usado.	'Origem' (obrigatório)

ImageTemplateAutoRun

Nome	Descrição	Valor
estado	Habilitar esse campo disparará um build automático na criação ou atualização do modelo de imagem.	'Desabilitado' 'Habilitado'

ImageTemplateCustomizer

Nome	Descrição	Valor
nome	Nome Amigável para fornecer contexto sobre o que essa etapa de personalização faz	corda
tipo	Defina como 'Arquivo' para o tipo ImageTemplateFileCustomizer. Defina como 'PowerShell' para o tipo ImageTemplatePowerShellCustomizer. Defina como 'Shell' para o tipo ImageTemplateShellCustomizer. Defina como 'WindowsRestart' para o tipo ImageTemplateRestartCustomizer. Defina como 'WindowsUpdate' para o tipo ImageTemplateWindowsUpdateCustomizer.	'Arquivo' 'PowerShell' 'Shell' 'WindowsRestart' 'WindowsUpdate' (obrigatório)

ImageTemplateDistributor

Nome	Descrição	Valor
artifactTags	Marcas que serão aplicadas ao artefato depois que ele tiver sido criado/atualizado pelo distribuidor.	ImageTemplateDistributorArtifactTags
runOutputName	O nome a ser usado para o RunOutput associado.	corda Restrições: Padrão = `^[A-Za-z0-9-_.]{1,64}$` (obrigatório)
tipo	Defina como 'ManagedImage' para o tipo ImageTemplateManagedImageDistributor. Defina como 'SharedImage' para o tipo ImageTemplateSharedImageDistributor. Defina como 'VHD' para o tipo ImageTemplateVhdDistributor.	'ManagedImage' 'SharedImage' 'VHD' (obrigatório)

ImageTemplateDistributorArtifactTags

Nome	Descrição	Valor

ImageTemplateFileCustomizer

Nome	Descrição	Valor
destino	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) em que o arquivo (de sourceUri) será carregado na VM	corda
sha256Checksum	Soma de verificação SHA256 do arquivo fornecido no campo sourceUri acima	corda
sourceUri	O URI do arquivo a ser carregado para personalizar a VM. Pode ser um link do github, URI SAS para Armazenamento do Azure etc.	corda
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell	'File' (obrigatório)

ImageTemplateFileValidator

Nome	Descrição	Valor
destino	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) em que o arquivo (de sourceUri) será carregado na VM	corda
sha256Checksum	Soma de verificação SHA256 do arquivo fornecido no campo sourceUri acima	corda
sourceUri	O URI do arquivo a ser carregado na VM para validação. Pode ser um link do GitHub, URI do Armazenamento do Azure (autorizado ou SAS), etc.	corda
tipo	O tipo de validação que você deseja usar na Imagem. Por exemplo, "Shell" pode ser validação de shell	'File' (obrigatório)

ImageTemplateIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade usado para o modelo de imagem. O tipo 'None' removerá as identidades do modelo de imagem.	'None' 'UserAssigned'
userAssignedIdentities	O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

ImageTemplateInVMValidator

Nome	Descrição	Valor
nome	Nome Amigável para fornecer contexto sobre o que esta etapa de validação faz	corda
tipo	Defina como "Arquivo" para o tipo ImageTemplateFileValidator. Defina como 'PowerShell' para o tipo ImageTemplatePowerShellValidator. Defina como 'Shell' para o tipo ImageTemplateShellValidator.	'Arquivo' 'PowerShell' 'Shell' (obrigatório)

ImageTemplateManagedImageDistributor

Nome	Descrição	Valor
imageId	ID do recurso da imagem de disco gerenciado	cadeia de caracteres (obrigatório)
localização	O local do Azure para a imagem deve corresponder se a imagem já existir	cadeia de caracteres (obrigatório)
tipo	Tipo de distribuição.	'ManagedImage' (obrigatório)

ImageTemplateManagedImageSource

Nome	Descrição	Valor
imageId	ID de recurso do ARM da imagem gerenciada na assinatura do cliente	cadeia de caracteres (obrigatório)
tipo	Especifica o tipo de imagem de origem com a qual você deseja começar.	'ManagedImage' (obrigatório)

ImageTemplatePlatformImageSource

Nome	Descrição	Valor
oferecer	Oferta de imagem doImagens da Galeria do Azure.	corda
planInfo	Configuração opcional do plano de compra para a imagem da plataforma.	PlatformImagePurchasePlan
editor	Editor de Imagens no de Imagens da Galeria do Azure.	corda
Sku	SKU de imagem dode Imagens da Galeria do Azure .	corda
tipo	Especifica o tipo de imagem de origem com a qual você deseja começar.	'PlatformImage' (obrigatório)
Versão	Versão da imagem dode Imagens da Galeria do Azure . Se 'latest' for especificado aqui, a versão será avaliada quando o build de imagem ocorrer, não quando o modelo for enviado.	corda

ImageTemplatePowerShellCustomizer

Nome	Descrição	Valor
Inline	Matriz de comandos do PowerShell a serem executados	string[]
runAsSystem	Se especificado, o script do PowerShell será executado com privilégios elevados usando o usuário do Sistema Local. Só pode ser verdadeiro quando o campo runElevated acima é definido como true.	Bool
runElevated	Se especificado, o script do PowerShell será executado com privilégios elevados	Bool
scriptUri	URI do script do PowerShell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc.	corda
sha256Checksum	Soma de verificação SHA256 do script do power shell fornecido no campo scriptUri acima	corda
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell	'PowerShell' (obrigatório)
validExitCodes	Códigos de saída válidos para o script do PowerShell. [Padrão: 0]	int[]

ImageTemplatePowerShellValidator

Nome	Descrição	Valor
Inline	Matriz de comandos do PowerShell a serem executados	string[]
runAsSystem	Se especificado, o script do PowerShell será executado com privilégios elevados usando o usuário do Sistema Local. Só pode ser verdadeiro quando o campo runElevated acima é definido como true.	Bool
runElevated	Se especificado, o script do PowerShell será executado com privilégios elevados	Bool
scriptUri	URI do script do PowerShell a ser executado para validação. Pode ser um link do GitHub, URI do Armazenamento do Azure etc.	corda
sha256Checksum	Soma de verificação SHA256 do script do power shell fornecido no campo scriptUri acima	corda
tipo	O tipo de validação que você deseja usar na Imagem. Por exemplo, "Shell" pode ser validação de shell	'PowerShell' (obrigatório)
validExitCodes	Códigos de saída válidos para o script do PowerShell. [Padrão: 0]	int[]

ImageTemplateProperties

Nome	Descrição	Valor
AutoRun	Indica se o modelo de imagem deve ou não ser executado automaticamente na criação ou atualização do modelo.	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).	int Restrições: Valor mínimo = 0 Valor máximo = 960
Personalizar	Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como fonte de imagem etc.	ImageTemplateCustomizer []
distribuir	A distribuição é direcionada para onde a saída da imagem precisa ir.	ImageTemplateDistributor[] (obrigatório)
errorHandling	Opções de tratamento de erros após uma falha de build	ImageTemplatePropertiesErrorHandling
managedResourceTags	Marcas que serão aplicadas ao grupo de recursos e/ou recursos criados pelo serviço.	ImageTemplatePropertiesManagedResourceTags
otimizar	Especifica a otimização a ser executada na imagem.	ImageTemplatePropertiesOptimize
fonte	Especifica as propriedades usadas para descrever a imagem de origem.	ImageTemplateSource (obrigatório)
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á.	corda
validar	Opções de configuração e lista de validações a serem executadas na imagem resultante.	ImageTemplatePropertiesValidate
vmProfile	Descreve como a máquina virtual é configurada para criar imagens	ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Nome	Descrição	Valor
onCustomizerError	Se houver um erro do personalizador e esse campo estiver definido como "limpeza", a VM de build e os recursos de rede associados serão limpos. Esse é o comportamento padrão. Se houver um erro do personalizador e esse campo estiver definido como 'abortar', a VM de build será preservada.	'abortar' 'limpeza'
onValidationError	Se houver um erro de validação e esse campo for definido como "limpeza", a VM de build e os recursos de rede associados serão limpos. Esse é o comportamento padrão. Se houver um erro de validação e esse campo estiver definido como 'abortar', a VM de build será preservada.	'abortar' 'limpeza'

ImageTemplatePropertiesManagedResourceTags

Nome	Descrição	Valor

ImageTemplatePropertiesOptimize

Nome	Descrição	Valor
vmBoot	A otimização é aplicada na imagem para uma inicialização de VM mais rápida.	ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Nome	Descrição	Valor
estado	Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída da imagem personalizada final.	'Desabilitado' 'Habilitado'

ImageTemplatePropertiesValidate

Nome	Descrição	Valor
continueDistributeOnFailure	Se a validação falhar e esse campo for definido como false, as imagens de saída não serão distribuídas. Esse é o comportamento padrão. Se a validação falhar e esse campo for definido como true, as imagens de saída ainda serão distribuídas. Use essa opção com cuidado, pois pode resultar em imagens incorretas sendo distribuídas para uso. Em ambos os casos (true ou false), a execução de imagem de ponta a ponta será relatada como tendo falhado em caso de falha de validação. [Observação: este campo não terá efeito se a validação for bem-sucedida.]	Bool
inVMValidations	Lista de validações a serem executadas.	ImageTemplateInVMValidator[]
sourceValidationOnly	Se esse campo for definido como true, a imagem especificada na seção 'source' será validada diretamente. Nenhum build separado será executado para gerar e validar uma imagem personalizada.	Bool

ImageTemplateRestartCustomizer

Nome	Descrição	Valor
restartCheckCommand	Comando para verificar se a reinicialização foi bem-sucedida [Padrão: '']	corda
restartCommand	Comando para executar a reinicialização [Padrão: 'shutdown /r /f /t 0 /c "packer restart"']	corda
restartTimeout	Tempo limite de reinicialização especificado como uma cadeia de caracteres de magnitude e unidade, por exemplo, '5m' (5 minutos) ou '2h' (2 horas) [Padrão: '5m']	corda
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell	'WindowsRestart' (obrigatório)

ImageTemplateSharedImageDistributor

Nome	Descrição	Valor
excludeFromLatest	Sinalizador que indica se a versão da imagem criada deve ser excluída da versão mais recente. Omita para usar o padrão (false).	Bool
galleryImageId	ID de recurso da imagem da Galeria de Computação do Azure	cadeia de caracteres (obrigatório)
replicationRegions	[Preterido] Uma lista de regiões para as quais a imagem será replicada. Essa lista só poderá ser especificada se targetRegions não for especificado. Esse campo foi preterido – use targetRegions em vez disso.	string[]
storageAccountType	[Preterido] Tipo de conta de armazenamento a ser usado para armazenar a imagem compartilhada. Omita para usar o padrão (Standard_LRS). Esse campo só poderá ser especificado se replicationRegions for especificado. Esse campo foi preterido – use targetRegions em vez disso.	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'
targetRegions	As regiões de destino para as quais a versão da imagem distribuída será replicada. Esse objeto substitui replicationRegions e só pode ser especificado se replicationRegions não for especificada.	de Região de Destino []
tipo	Tipo de distribuição.	'SharedImage' (obrigatório)
controle de versão	Descreve como gerar um novo número de versão x.y.z para distribuição.	DistributeVersioner

ImageTemplateSharedImageVersionSource

Nome	Descrição	Valor
imageVersionId	ID de recurso do ARM da versão da imagem. Quando o nome da versão da imagem é 'mais recente', a versão é avaliada quando o build de imagem ocorre.	cadeia de caracteres (obrigatório)
tipo	Especifica o tipo de imagem de origem com a qual você deseja começar.	'SharedImageVersion' (obrigatório)

ImageTemplateShellCustomizer

Nome	Descrição	Valor
Inline	Matriz de comandos de shell a serem executados	string[]
scriptUri	URI do script de shell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc.	corda
sha256Checksum	Soma de verificação SHA256 do script de shell fornecido no campo scriptUri	corda
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell	'Shell' (obrigatório)

ImageTemplateShellValidator

Nome	Descrição	Valor
Inline	Matriz de comandos de shell a serem executados	string[]
scriptUri	URI do script de shell a ser executado para validação. Pode ser um link do GitHub, URI do Armazenamento do Azure etc.	corda
sha256Checksum	Soma de verificação SHA256 do script de shell fornecido no campo scriptUri	corda
tipo	O tipo de validação que você deseja usar na Imagem. Por exemplo, "Shell" pode ser validação de shell	'Shell' (obrigatório)

ImageTemplateSource

Nome	Descrição	Valor
tipo	Defina como 'ManagedImage' para o tipo ImageTemplateManagedImageSource. Defina como 'PlatformImage' para o tipo ImageTemplatePlatformImageSource. Defina como 'SharedImageVersion' para o tipo ImageTemplateSharedImageVersionSource.	'ManagedImage' 'PlatformImage' 'SharedImageVersion' (obrigatório)

ImageTemplateVhdDistributor

Nome	Descrição	Valor
tipo	Tipo de distribuição.	'VHD' (obrigatório)
URI	URI opcional do Armazenamento do Azure para o blob de VHD distribuído. Omita usar o padrão (cadeia de caracteres vazia) nesse caso, o VHD seria publicado na conta de armazenamento no grupo de recursos de preparo.	corda

ImageTemplateVmProfile

Nome	Descrição	Valor
osDiskSizeGB	Tamanho do disco do sistema operacional em GB. Omita ou especifique 0 para usar o tamanho padrão do disco do sistema operacional do Azure.	int Restrições: Valor mínimo = 0
userAssignedIdentities	Matriz opcional de IDs de recurso de identidades gerenciadas atribuídas pelo usuário a serem configuradas na VM de build e na VM de validação. Isso pode incluir a identidade do modelo de imagem.	string[]
vmSize	Tamanho da máquina virtual usada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_D1_v2 para imagens gen1 e Standard_D2ds_v4 para imagens gen2).	corda
vnetConfig	Configuração opcional da rede virtual a ser usada para implantar a VM de build e a VM de validação. Omita se nenhuma rede virtual específica precisar ser usada.	virtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Nome	Descrição	Valor
Filtros	Matriz de filtros para selecionar atualizações a serem aplicadas. Omita ou especifique a matriz vazia para usar o padrão (sem filtro). Consulte o link acima para obter exemplos e descrição detalhada desse campo.	string[]
searchCriteria	Critérios para pesquisar atualizações. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (pesquise tudo). Consulte o link acima para obter exemplos e descrição detalhada desse campo.	corda
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell	'WindowsUpdate' (obrigatório)
updateLimit	Número máximo de atualizações a serem aplicadas por vez. Omita ou especifique 0 para usar o padrão (1000)	int Restrições: Valor mínimo = 0