Microsoft.VirtualMachineImages imageTemplates 2021-10-01

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@2021-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    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
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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'
}

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'
  type: 'SharedImage'
}

Para VHD, use:

{
  type: 'VHD'
}

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
}

Valores de propriedade

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome	Descrição	Valor

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)

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	A lista de identidades de usuário associadas ao modelo de imagem. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nome	Descrição	Valor

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[]

ImageTemplateProperties

Nome	Descrição	Valor
buildTimeoutInMinutes	Duração máxima para aguardar durante a criação do modelo de imagem. 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)
fonte	Especifica as propriedades usadas para descrever a imagem de origem.	ImageTemplateSource (obrigatório)
vmProfile	Descreve como a máquina virtual é configurada para criar imagens	ImageTemplateVmProfile

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 do recurso da imagem da Galeria de Imagens Compartilhadas	cadeia de caracteres (obrigatório)
replicationRegions	Uma lista de regiões para as quais a imagem será replicada	string[] (obrigatório)
storageAccountType	Tipo de conta de armazenamento a ser usado para armazenar a imagem compartilhada. Omita para usar o padrão (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'
tipo	Tipo de distribuição.	'SharedImage' (obrigatório)

ImageTemplateSharedImageVersionSource

Nome	Descrição	Valor
imageVersionId	ID de recurso do ARM da versão da imagem na galeria de imagens compartilhadas	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)

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)

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. 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_D2ds_v4).	corda
vnetConfig	Configuração opcional da rede virtual a ser usada para implantar a máquina virtual de build. 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