Microsoft.VirtualMachineImages imageTemplates 2021-10-01

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

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

Para VHD, use:

{
  type: 'VHD'
}

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
}

Valores de propriedade

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação	Descrição	Valor

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)

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	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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Designação	Descrição	Valor

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

ImageTemplateProperties

Designação	Descrição	Valor
buildTimeoutInMinutes	Duração máxima de espera durante a criação do modelo de imagem. 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)
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

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 Imagens Partilhadas	string (obrigatório)
replicaçãoRegiões	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. Omitir o padrão (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'
tipo	Tipo de distribuição.	'SharedImage' (obrigatório)

ImageTemplateSharedImageVersionSource

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

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)

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