Microsoft.VirtualMachineImages imageTemplates

Artigo
12/17/2024

Definição de recursos do bíceps

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

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

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

Formato do recurso

Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o seguinte Bíceps ao seu 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 type 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 mais recentes, utilize:

{
  major: int
  scheme: 'Latest'
}

Para de origem, use:

{
  scheme: 'Source'
}

Objetos ImageTemplateCustomizer

Defina a propriedade type para especificar o tipo de objeto.

Para File, use:

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

Para 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 type para especificar o tipo de objeto.

Para File, use:

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

Para 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 type 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

Designação	Descrição	Valor
Regime	Defina como 'Mais recente' para o tipo DistributeVersionerLatest. Defina como 'Source' para o tipo DistributeVersionerSource.	'Mais recente' 'Fonte' (obrigatório)

DistributeVersionerLatest

Designação	Descrição	Valor
major	Versão principal para o 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 equivale a deixá-lo desdefinido.	Int Restrições: Valor mínimo = -1
Regime	Esquema de numeração das versões a utilizar.	«Mais recente» (obrigatório)

DistributeVersionerSource

Designação	Descrição	Valor
Regime	Esquema de numeração das versões a utilizar.	'Fonte' (obrigatório)

ImageTemplateAutoRun

Designação	Descrição	Valor
Estado	Ativar este campo acionará uma compilação automática na criação ou atualização de modelo de imagem.	'Desativado' 'Habilitado'

ImageTemplateCustomizer

Designação	Descrição	Valor
Designação	Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz	string
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.	'Ficheiro' 'PowerShell' 'Concha' 'WindowsRestart' 'WindowsUpdate' (obrigatório)

ImageTemplateDistribuidor

Designação	Descrição	Valor
artifactTags	Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor.	ImageTemplateDistributorArtifactTags
runOutputName	O nome a ser usado para o RunOutput associado.	string 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' 'Imagem compartilhada' «VHD» (obrigatório)

ImageTemplateDistributorArtifactTags

Designação	Descrição	Valor

ImageTemplateFileCustomizer

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

ImageTemplateFileValidator

Designação	Descrição	Valor
destino	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) onde o arquivo (de sourceUri) será carregado na VM	string
sha256Soma de verificação	Soma de verificação SHA256 do arquivo fornecido no campo sourceUri acima	string
fonteUri	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	string
tipo	O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell	'Ficheiro' (obrigatório)

ImageTemplateIdentity

Designação	Descrição	Valor
tipo	O tipo de identidade usado para o modelo de imagem. O tipo 'Nenhum' removerá todas as identidades do modelo de imagem.	'Nenhuma' '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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações.	UserAssignedIdentities

ImageTemplateInVMValidator

Designação	Descrição	Valor
Designação	Nome amigável para fornecer contexto sobre o que esta etapa de validação faz	string
tipo	Defina como 'File' para o tipo ImageTemplateFileValidator. Defina como 'PowerShell' para o tipo ImageTemplatePowerShellValidator. Defina como 'Shell' para o tipo ImageTemplateShellValidator.	'Ficheiro' 'PowerShell' 'Shell' (obrigatório)

ImageTemplateManagedImageDistributor

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

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Designação	Descrição	Valor
oferta	Oferta de imagem do Azure Gallery Images.	string
planInfo	Configuração opcional do plano de compra para imagem da plataforma.	PlatformImagePurchasePlan
editora	Image Publisher no Azure Gallery Images.	string
SKU	Documento de imagem do Azure Gallery Images.	string
tipo	Especifica o tipo de imagem de origem com a qual você deseja começar.	'PlatformImage' (obrigatório)
Versão	Versão da imagem do Azure Gallery Images. Se 'mais recente' for especificado aqui, a versão é avaliada quando a construção da imagem ocorre, não quando o modelo é enviado.	string

ImageTemplatePowerShellCustomizer

Designação	Descrição	Valor
em linha	Matriz de comandos do PowerShell para executar	string[]
runAsSystem	Se especificado, o script do PowerShell será executado com privilégios elevados usando o usuário do Sistema Local. Só pode ser true quando o campo runElevated acima está definido como true.	Bool
runElevado	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 github, URI SAS para Armazenamento do Azure, etc	string
sha256Soma de verificação	Soma de verificação SHA256 do script power shell fornecido no campo scriptUri acima	string
tipo	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell	'PowerShell' (obrigatório)
validExitCodes	Códigos de saída válidos para o script do PowerShell. [Padrão: 0]	int[]

ImageTemplatePowerShellValidator

Designação	Descrição	Valor
em linha	Matriz de comandos do PowerShell para executar	string[]
runAsSystem	Se especificado, o script do PowerShell será executado com privilégios elevados usando o usuário do Sistema Local. Só pode ser true quando o campo runElevated acima está definido como true.	Bool
runElevado	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	string
sha256Soma de verificação	Soma de verificação SHA256 do script power shell fornecido no campo scriptUri acima	string
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

Designação	Descrição	Valor
Execução automática	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 de espera durante a criação do modelo de imagem (inclui todas as personalizações, otimizações, validações e distribuições). Omitir ou especificar 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 da imagem, etc	ImageTemplateCustomizer[]
distribuir	A distribuição destina-se para onde a saída de imagem precisa ir.	ImageTemplateDistributor[] (obrigatório)
tratamento de erros	Opções de tratamento de erros em caso de falha de compilação	ImageTemplatePropertiesErrorHandling
managedResourceTags	Tags 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	O ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Se este campo estiver vazio, será criado um grupo de recursos com um nome aleatório. 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 do modelo de imagem. O grupo de recursos criado será excluído durante a exclusão do modelo se esse campo estiver vazio ou se 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á.	string
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

Designação	Descrição	Valor
onCustomizerError	Se houver um erro do personalizador e esse campo estiver definido como 'limpeza', a VM de compilação e os recursos de rede associados serão limpos. Este é o comportamento padrão. Se houver um erro do personalizador e esse campo estiver definido como 'abortar', a VM de compilação será preservada.	'abortar' 'Limpeza'
onValidationError	Se houver um erro de validação e este campo estiver definido como 'limpeza', a VM de compilação e os recursos de rede associados serão limpos. Este é o comportamento padrão. Se houver um erro de validação e esse campo estiver definido como 'abortar', a VM de compilação será preservada.	'abortar' 'Limpeza'

ImageTemplatePropertiesManagedResourceTags

Designação	Descrição	Valor

ImageTemplatePropertiesOptimize

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

ImageTemplatePropertiesOptimizeVmBoot

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

ImageTemplatePropertiesValidate

Designação	Descrição	Valor
continueDistributeOnFailure	Se a validação falhar e este campo estiver definido como false, a(s) imagem(ns) de saída não será(ão) distribuída(s). Este é o comportamento padrão. Se a validação falhar e este campo estiver definido como true, a(s) imagem(ns) de saída ainda será(ão) distribuída(s). Por favor, use esta opção com cuidado, pois pode resultar em imagens ruins sendo distribuídas para uso. Em ambos os casos (verdadeiro ou falso), a execução da imagem de ponta a ponta será relatada como tendo falhado em caso de falha de validação. [Nota: Este campo não tem efeito se a validação for bem-sucedida.]	Bool
inVMValidações	Lista de validações a serem realizadas.	ImageTemplateInVMValidator[]
sourceValidationOnly	Se este campo estiver definido como true, a imagem especificada na secção 'fonte' será diretamente validada. Nenhuma compilação separada será executada para gerar e, em seguida, validar uma imagem personalizada.	Bool

ImageTemplateRestartCustomizer

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

ImageTemplateSharedImageDistributor

Designação	Descrição	Valor
excludeFromLatest	Sinalizador que indica se a versão da imagem criada deve ser excluída da versão mais recente. Omitir o padrão (false).	Bool
galeriaImageId	ID do recurso da imagem da Galeria de Computação do Azure	string (obrigatório)
replicaçãoRegiões	[Preterido] Uma lista de regiões para as quais a imagem será replicada. Esta lista só pode ser especificada se targetRegions não for especificado. Este campo foi preterido - use targetRegions em vez disso.	string[]
storageAccountType	[Preterido] Tipo de conta de armazenamento a ser usado para armazenar a imagem compartilhada. Omitir o padrão (Standard_LRS). Este campo só pode ser especificado se replicationRegions for especificado. Este campo foi preterido - use targetRegions em vez disso.	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'
targetRegiões	As regiões de destino para as quais a versão de imagem distribuída será replicada. Este objeto substitui replicationRegions e pode ser especificado somente se replicationRegions não for especificado.	TargetRegion[]
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

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

ImageTemplateShellCustomizer

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

ImageTemplateShellValidator

Designação	Descrição	Valor
em linha	Matriz de comandos do shell para executar	string[]
scriptUri	URI do shell script a ser executado para validação. Pode ser um link do github, URI do Armazenamento do Azure, etc	string
sha256Soma de verificação	Soma de verificação SHA256 do shell script fornecido no campo scriptUri	string
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

Designação	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' 'Imagem de plataforma' 'SharedImageVersion' (obrigatório)

ImageTemplateVhdDistribuidor

Designação	Descrição	Valor
tipo	Tipo de distribuição.	«VHD» (obrigatório)
URI	URI de Armazenamento do Azure opcional para o blob VHD distribuído. Omitir o uso padrão (cadeia de caracteres vazia), caso em que o VHD seria publicado na conta de armazenamento no grupo de recursos de preparo.	string

ImageTemplateVmProfile

Designação	Descrição	Valor
osDiskSizeGB	Tamanho do disco do SO em GB. Omita ou especifique 0 para usar o tamanho de disco padrão do sistema operacional do Azure.	Int Restrições: Valor mínimo = 0
userAssignedIdentities	Matriz opcional de IDs de recursos de identidades gerenciadas atribuídas pelo usuário a serem configuradas na VM de compilação e na VM de validação. Isso pode incluir a identidade do modelo de imagem.	string[]
vmTamanho	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).	string
vnetConfig	Configuração opcional da rede virtual a ser usada para implantar a VM de compilação e a VM de validação. Omitir se nenhuma rede virtual específica precisar ser usada.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

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