Microsoft.VirtualMachineImages imageTemplates
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
autoRun: {
state: 'string'
}
buildTimeoutInMinutes: int
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
errorHandling: {
onCustomizerError: 'string'
onValidationError: 'string'
}
managedResourceTags: {}
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'
}
}
}
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Para PowerShell, use:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Para Shell, use:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Para WindowsRestart, use:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Para WindowsUpdate , use:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Para SharedImage , use:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
targetRegions: [
{
name: 'string'
replicaCount: int
storageAccountType: 'string'
}
]
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:
scheme: 'Latest'
major: int
Para de origem, use:
scheme: 'Source'
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
type: 'ManagedImage'
imageId: 'string'
Para PlatformImage , use:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
Para SharedImageVersion, use:
type: 'SharedImageVersion'
imageVersionId: 'string'
Objetos ImageTemplateInVMValidator
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Para PowerShell, use:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Para Shell, use:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Valores de propriedade
imageTemplates
Designação | Descrição | Valor |
---|---|---|
Designação | O nome do recurso | string (obrigatório) |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
Etiquetas | Tags de recursos. | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
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 |
UserAssignedIdentities
Designação | Descrição | Valor |
---|---|---|
{propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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. | objeto |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell WindowsReiniciar WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplatePowerShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateRestartCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateWindowsUpdateCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
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 |
ImageTemplateDistribuidor
Designação | Descrição | Valor |
---|---|---|
artifactTags | Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor. | objeto |
runOutputName | O nome a ser usado para o RunOutput associado. | string (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-_.]{1,64}$ |
tipo | Definir o tipo de objeto |
ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | 'ManagedImage' (obrigatório) |
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) |
ImageTemplateSharedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | 'SharedImage' (obrigatório) |
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[] |
Controle de versão | Descreve como gerar um novo número de versão x.y.z para distribuição. | DistributeVersioner |
Região-alvo
Designação | Descrição | Valor |
---|---|---|
Designação | O nome da região. | string (obrigatório) |
replicaCount | O número de réplicas da versão da imagem a ser criada nesta região. Omitir o padrão (1). | Int Restrições: Valor mínimo = 1 |
storageAccountType | Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem nessa região. Omitir o padrão (Standard_LRS). | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
DistributeVersioner
Designação | Descrição | Valor |
---|---|---|
Regime | Definir o tipo de objeto |
Últimas de origem (obrigatório) |
DistributeVersionerLatest
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | «Mais recente» (obrigatório) |
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 |
DistributeVersionerSource
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | 'Fonte' (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 |
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' |
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' |
ImageTemplateSource
Designação | Descrição | Valor |
---|---|---|
tipo | Definir o tipo de objeto |
ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'ManagedImage' (obrigatório) |
imageId | ID de recurso ARM da imagem gerenciada na assinatura do cliente | string (obrigatório) |
ImageTemplatePlatformImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'PlatformImage' (obrigatório) |
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 |
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 |
PlatformImagePurchasePlan
Designação | Descrição | Valor |
---|---|---|
nome do plano | Nome do plano de compra. | string (obrigatório) |
planoProduto | Produto do plano de compra. | string (obrigatório) |
planPublisher | Editor do plano de compra. | string (obrigatório) |
ImageTemplateSharedImageVersionSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'SharedImageVersion' (obrigatório) |
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) |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell (obrigatório) |
ImageTemplateFileValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'Ficheiro' (obrigatório) |
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 |
ImageTemplatePowerShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'PowerShell' (obrigatório) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'Shell' (obrigatório) |
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 |
ImageTemplateVmProfile
VirtualNetworkConfig
Designação | Descrição | Valor |
---|---|---|
containerInstanceSubnetId | ID de recurso de uma sub-rede pré-existente na qual a Instância de Contêiner do Azure será implantada para Compilações Isoladas. Este campo só pode ser especificado se subnetId também for especificado e tiver de estar na mesma rede virtual que a sub-rede especificada em subnetId . |
string |
proxyVmSize | Tamanho da máquina virtual proxy usada para passar o tráfego para a VM de compilação e a VM de validação. Isso não deve ser especificado se containerInstanceSubnetId for especificado porque nenhuma máquina virtual proxy é implantada nesse caso. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_A1_v2). |
string |
subnetId | ID de recurso de uma sub-rede pré-existente na qual a VM de compilação e a VM de validação serão implantadas | string |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Construtor de Imagens do Azure com de Linha de Base do Windows do Azure |
Cria um ambiente do Azure Image Builder e cria uma imagem do Windows Server com as atualizações mais recentes do Windows e a linha de base do Windows do Azure aplicadas. |
Configurar o serviço Caixa de Desenvolvimento |
Este modelo criaria todos os recursos de administração da Caixa de Desenvolvimento de acordo com o guia de início rápido da Caixa de Desenvolvimento (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Você pode visualizar todos os recursos criados ou ir diretamente para DevPortal.microsoft.com para criar sua primeira Caixa de Desenvolvimento. |
Definição de recurso de modelo ARM
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 JSON ao seu modelo.
{
"type": "Microsoft.VirtualMachineImages/imageTemplates",
"apiVersion": "2024-02-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"autoRun": {
"state": "string"
},
"buildTimeoutInMinutes": "int",
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"errorHandling": {
"onCustomizerError": "string",
"onValidationError": "string"
},
"managedResourceTags": {},
"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"
}
}
}
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Para PowerShell, use:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Para Shell, use:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Para WindowsRestart, use:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Para WindowsUpdate , use:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Para SharedImage , use:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string",
"targetRegions": [
{
"name": "string",
"replicaCount": "int",
"storageAccountType": "string"
}
],
"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:
"scheme": "Latest",
"major": "int"
Para de origem, use:
"scheme": "Source"
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
"type": "ManagedImage",
"imageId": "string"
Para PlatformImage , use:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
Para SharedImageVersion, use:
"type": "SharedImageVersion",
"imageVersionId": "string"
Objetos ImageTemplateInVMValidator
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Para PowerShell, use:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Para Shell, use:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Valores de propriedade
imageTemplates
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | 'Microsoft.VirtualMachineImages/imageTemplates' |
apiVersion | A versão da api de recursos | '2024-02-01' |
Designação | O nome do recurso | string (obrigatório) |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
Etiquetas | Tags de recursos. | Dicionário de nomes e valores de tags. Consulte Tags em modelos |
identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
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 |
UserAssignedIdentities
Designação | Descrição | Valor |
---|---|---|
{propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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. | objeto |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell WindowsReiniciar WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplatePowerShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateRestartCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateWindowsUpdateCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
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 |
ImageTemplateDistribuidor
Designação | Descrição | Valor |
---|---|---|
artifactTags | Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor. | objeto |
runOutputName | O nome a ser usado para o RunOutput associado. | string (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-_.]{1,64}$ |
tipo | Definir o tipo de objeto |
ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | 'ManagedImage' (obrigatório) |
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) |
ImageTemplateSharedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | 'SharedImage' (obrigatório) |
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[] |
Controle de versão | Descreve como gerar um novo número de versão x.y.z para distribuição. | DistributeVersioner |
Região-alvo
Designação | Descrição | Valor |
---|---|---|
Designação | O nome da região. | string (obrigatório) |
replicaCount | O número de réplicas da versão da imagem a ser criada nesta região. Omitir o padrão (1). | Int Restrições: Valor mínimo = 1 |
storageAccountType | Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem nessa região. Omitir o padrão (Standard_LRS). | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
DistributeVersioner
Designação | Descrição | Valor |
---|---|---|
Regime | Definir o tipo de objeto |
Últimas de origem (obrigatório) |
DistributeVersionerLatest
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | «Mais recente» (obrigatório) |
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 |
DistributeVersionerSource
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | 'Fonte' (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 |
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' |
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' |
ImageTemplateSource
Designação | Descrição | Valor |
---|---|---|
tipo | Definir o tipo de objeto |
ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'ManagedImage' (obrigatório) |
imageId | ID de recurso ARM da imagem gerenciada na assinatura do cliente | string (obrigatório) |
ImageTemplatePlatformImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'PlatformImage' (obrigatório) |
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 |
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 |
PlatformImagePurchasePlan
Designação | Descrição | Valor |
---|---|---|
nome do plano | Nome do plano de compra. | string (obrigatório) |
planoProduto | Produto do plano de compra. | string (obrigatório) |
planPublisher | Editor do plano de compra. | string (obrigatório) |
ImageTemplateSharedImageVersionSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | 'SharedImageVersion' (obrigatório) |
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) |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell (obrigatório) |
ImageTemplateFileValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'Ficheiro' (obrigatório) |
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 |
ImageTemplatePowerShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'PowerShell' (obrigatório) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | 'Shell' (obrigatório) |
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 |
ImageTemplateVmProfile
VirtualNetworkConfig
Designação | Descrição | Valor |
---|---|---|
containerInstanceSubnetId | ID de recurso de uma sub-rede pré-existente na qual a Instância de Contêiner do Azure será implantada para Compilações Isoladas. Este campo só pode ser especificado se subnetId também for especificado e tiver de estar na mesma rede virtual que a sub-rede especificada em subnetId . |
string |
proxyVmSize | Tamanho da máquina virtual proxy usada para passar o tráfego para a VM de compilação e a VM de validação. Isso não deve ser especificado se containerInstanceSubnetId for especificado porque nenhuma máquina virtual proxy é implantada nesse caso. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_A1_v2). |
string |
subnetId | ID de recurso de uma sub-rede pré-existente na qual a VM de compilação e a VM de validação serão implantadas | string |
Modelos de início rápido
Os modelos de início rápido a seguir implantam esse tipo de recurso.
Modelo | Descrição |
---|---|
Construtor de Imagens do Azure com de Linha de Base do Windows do Azure |
Cria um ambiente do Azure Image Builder e cria uma imagem do Windows Server com as atualizações mais recentes do Windows e a linha de base do Windows do Azure aplicadas. |
Configurar o serviço Caixa de Desenvolvimento |
Este modelo criaria todos os recursos de administração da Caixa de Desenvolvimento de acordo com o guia de início rápido da Caixa de Desenvolvimento (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Você pode visualizar todos os recursos criados ou ir diretamente para DevPortal.microsoft.com para criar sua primeira Caixa de Desenvolvimento. |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso imageTemplates pode ser implantado com operações que visam:
- Grupos 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 Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
autoRun = {
state = "string"
}
buildTimeoutInMinutes = int
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
errorHandling = {
onCustomizerError = "string"
onValidationError = "string"
}
managedResourceTags = {}
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"
}
}
}
})
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Para PowerShell, use:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Para Shell, use:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Para WindowsRestart, use:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Para WindowsUpdate , use:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
type = "ManagedImage"
imageId = "string"
location = "string"
Para SharedImage , use:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
targetRegions = [
{
name = "string"
replicaCount = int
storageAccountType = "string"
}
]
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:
scheme = "Latest"
major = int
Para de origem, use:
scheme = "Source"
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage , use:
type = "ManagedImage"
imageId = "string"
Para PlatformImage , use:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
Para SharedImageVersion, use:
type = "SharedImageVersion"
imageVersionId = "string"
Objetos ImageTemplateInVMValidator
Defina a propriedade type para especificar o tipo de objeto.
Para File, use:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Para PowerShell, use:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Para Shell, use:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Valores de propriedade
imageTemplates
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01" |
Designação | O nome do recurso | string (obrigatório) |
Localização | A geolocalização onde o recurso vive | string (obrigatório) |
parent_id | Para implantar em um grupo de recursos, use a ID desse grupo de recursos. | string (obrigatório) |
Etiquetas | Tags de recursos. | Dicionário de nomes e valores de tags. |
identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
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. | "UserAssigned" |
identity_ids | 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. | Matriz de IDs de identidade do usuário. |
UserAssignedIdentities
Designação | Descrição | Valor |
---|---|---|
{propriedade personalizada} | UserAssignedIdentity |
UserAssignedIdentity
Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.
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. | objeto |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell WindowsReiniciar WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplatePowerShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateRestartCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
ImageTemplateWindowsUpdateCustomizer
Designação | Descrição | Valor |
---|---|---|
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) |
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 |
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 |
ImageTemplateDistribuidor
Designação | Descrição | Valor |
---|---|---|
artifactTags | Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor. | objeto |
runOutputName | O nome a ser usado para o RunOutput associado. | string (obrigatório) Restrições: Padrão = ^[A-Za-z0-9-_.]{1,64}$ |
tipo | Definir o tipo de objeto |
ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | "ManagedImage" (obrigatório) |
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) |
ImageTemplateSharedImageDistributor
Designação | Descrição | Valor |
---|---|---|
tipo | Tipo de distribuição. | "SharedImage" (obrigatório) |
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[] |
Controle de versão | Descreve como gerar um novo número de versão x.y.z para distribuição. | DistributeVersioner |
Região-alvo
Designação | Descrição | Valor |
---|---|---|
Designação | O nome da região. | string (obrigatório) |
replicaCount | O número de réplicas da versão da imagem a ser criada nesta região. Omitir o padrão (1). | Int Restrições: Valor mínimo = 1 |
storageAccountType | Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem nessa região. Omitir o padrão (Standard_LRS). | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
DistributeVersioner
Designação | Descrição | Valor |
---|---|---|
Regime | Definir o tipo de objeto |
Últimas de origem (obrigatório) |
DistributeVersionerLatest
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | "Mais recente" (obrigatório) |
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 |
DistributeVersionerSource
Designação | Descrição | Valor |
---|---|---|
Regime | Esquema de numeração das versões a utilizar. | "Fonte" (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 |
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" |
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" |
ImageTemplateSource
Designação | Descrição | Valor |
---|---|---|
tipo | Definir o tipo de objeto |
ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | "ManagedImage" (obrigatório) |
imageId | ID de recurso ARM da imagem gerenciada na assinatura do cliente | string (obrigatório) |
ImageTemplatePlatformImageSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | "PlatformImage" (obrigatório) |
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 |
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 |
PlatformImagePurchasePlan
Designação | Descrição | Valor |
---|---|---|
nome do plano | Nome do plano de compra. | string (obrigatório) |
planoProduto | Produto do plano de compra. | string (obrigatório) |
planPublisher | Editor do plano de compra. | string (obrigatório) |
ImageTemplateSharedImageVersionSource
Designação | Descrição | Valor |
---|---|---|
tipo | Especifica o tipo de imagem de origem com a qual você deseja começar. | "SharedImageVersion" (obrigatório) |
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) |
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 |
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 | Definir o tipo de objeto |
File PowerShell Shell (obrigatório) |
ImageTemplateFileValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | "Ficheiro" (obrigatório) |
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 |
ImageTemplatePowerShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | "PowerShell" (obrigatório) |
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 |
validExitCodes | Códigos de saída válidos para o script do PowerShell. [Padrão: 0] | int[] |
ImageTemplateShellValidator
Designação | Descrição | Valor |
---|---|---|
tipo | O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell | "Shell" (obrigatório) |
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 |
ImageTemplateVmProfile
VirtualNetworkConfig
Designação | Descrição | Valor |
---|---|---|
containerInstanceSubnetId | ID de recurso de uma sub-rede pré-existente na qual a Instância de Contêiner do Azure será implantada para Compilações Isoladas. Este campo só pode ser especificado se subnetId também for especificado e tiver de estar na mesma rede virtual que a sub-rede especificada em subnetId . |
string |
proxyVmSize | Tamanho da máquina virtual proxy usada para passar o tráfego para a VM de compilação e a VM de validação. Isso não deve ser especificado se containerInstanceSubnetId for especificado porque nenhuma máquina virtual proxy é implantada nesse caso. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_A1_v2). |
string |
subnetId | ID de recurso de uma sub-rede pré-existente na qual a VM de compilação e a VM de validação serão implantadas | string |