Virtual Machine Image Templates - Get

Serviço:: Image Builder

Versão da API:: 2022-07-01

Obter informações sobre um modelo de imagem de máquina virtual

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	O nome do modelo de imagem
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Name	Tipo	Description
200 OK	ImageTemplate	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Retrieve an Image Template.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate?api-version=2022-07-01

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço Construtor de Imagens de VM do Azure.
CloudErrorBody	Uma resposta de erro do serviço Construtor de Imagens de VM do Azure.
createdByType	O tipo de identidade que criou o recurso.
DistributeVersionerLatest	Gera o número de versão que será mais recente com base nos números de versão existentes.
DistributeVersionerSource	Gera o número da versão com base no número da versão da imagem de origem
ImageTemplate	O modelo de imagem é um recurso ARM gerenciado pelo provedor Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Carrega arquivos para VMs (Linux, Windows). Corresponde ao provisionador de arquivos Packer
ImageTemplateFileValidator	Carrega arquivos necessários para validação em VMs (Linux, Windows). Corresponde ao provisionador de arquivos Packer
ImageTemplateIdentity	Identidade para o modelo de imagem.
ImageTemplateLastRunStatus	Descreve o status mais recente da execução de um modelo de imagem
ImageTemplateManagedImageDistributor	Distribua como uma imagem de disco gerenciada.
ImageTemplateManagedImageSource	Descreve uma fonte de imagem que é uma imagem gerenciada na assinatura do cliente. Esta imagem deve residir na mesma assinatura e região que o modelo do Construtor de Imagens.
ImageTemplatePlatformImageSource	Descreve uma fonte de imagem do Azure Gallery Images.
ImageTemplatePowerShellCustomizer	Executa o PowerShell especificado na VM (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.
ImageTemplatePowerShellValidator	Executa o script do PowerShell especificado durante a fase de validação (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.
ImageTemplateRestartCustomizer	Reinicia uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao Packer windows-restart provisioner
ImageTemplateSharedImageDistributor	Distribua através da Galeria de Computação do Azure.
ImageTemplateSharedImageVersionSource	Descreve uma fonte de imagem que é uma versão de imagem em uma Galeria de Computação do Azure ou em uma Galeria Compartilhada Direta.
ImageTemplateShellCustomizer	Executa um shell script durante a fase de personalização (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.
ImageTemplateShellValidator	Executa o shell script especificado durante a fase de validação (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.
ImageTemplateVhdDistributor	Distribua via VHD em uma conta de armazenamento.
ImageTemplateVmProfile	Descreve as máquinas virtuais usadas para criar e validar imagens
ImageTemplateWindowsUpdateCustomizer	Instala as atualizações do Windows. Corresponde ao Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Especifica a otimização a ser executada na imagem.
PlatformImagePurchasePlan	Configuração do plano de compra para imagem da plataforma.
ProvisioningError	Descreve o erro ocorrido ao criar ou atualizar um modelo de imagem
ProvisioningErrorCode	Código de erro da falha de provisionamento
ProvisioningState	Estado de provisionamento do recurso
ResourceIdentityType	O tipo de identidade usado para o modelo de imagem. O tipo 'Nenhum' removerá todas as identidades do modelo de imagem.
RunState	Estado da última execução
RunSubState	Subestado da última execução
SharedImageStorageAccountType	Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem da Galeria de Computação do Azure.
systemData	Metadados referentes à criação e última modificação do recurso.
TargetRegion	Descreve as informações da região de destino.
UserAssignedIdentity	Propriedades de identidade atribuídas pelo usuário
Validate	Opções de configuração e lista de validações a serem executadas na imagem resultante.
VirtualNetworkConfig	Configuração de rede virtual.
VmBoot	A otimização é aplicada na imagem para uma inicialização mais rápida da VM.
VMBootOptimizationState	Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída final da imagem personalizada.

CloudError

Object

Uma resposta de erro do serviço Construtor de Imagens de VM do Azure.

Name	Tipo	Description
error	CloudErrorBody	Detalhes sobre o erro.

CloudErrorBody

Object

Uma resposta de erro do serviço Construtor de Imagens de VM do Azure.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Object

Gera o número de versão que será mais recente com base nos números de versão existentes.

Name	Tipo	Default value	Description
major	integer (int32) minimum: -1	-1	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.
scheme	string: Latest		Esquema de numeração das versões a utilizar.

DistributeVersionerSource

Object

Gera o número da versão com base no número da versão da imagem de origem

Name	Tipo	Description
scheme	string: Source	Esquema de numeração das versões a utilizar.

ImageTemplate

Object

O modelo de imagem é um recurso ARM gerenciado pelo provedor Microsoft.VirtualMachineImages

Name	Tipo	Default value	Description
id	string		ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		A identidade do modelo de imagem, se configurado.
location	string		A geolocalização onde o recurso vive
name	string		O nome do recurso
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	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).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Especifica as propriedades usadas para descrever as etapas de personalização da imagem, como Fonte da imagem, etc
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		A distribuição destina-se para onde a saída de imagem precisa ir.
properties.exactStagingResourceGroup	string		O ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Este campo somente leitura difere de 'stagingResourceGroup' somente se o valor especificado no campo 'stagingResourceGroup' estiver vazio.
properties.lastRunStatus	ImageTemplateLastRunStatus		Estado de 'execução' que está atualmente em execução ou foi executado pela última vez.
properties.optimize	Optimize		Especifica a otimização a ser executada na imagem.
properties.provisioningError	ProvisioningError		Erro de provisionamento, se houver
properties.provisioningState	ProvisioningState		Estado de provisionamento do recurso
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Especifica as propriedades usadas para descrever a imagem de origem.
properties.stagingResourceGroup	string		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á.
properties.validate	Validate		Opções de configuração e lista de validações a serem executadas na imagem resultante.
properties.vmProfile	ImageTemplateVmProfile		Descreve como a máquina virtual é configurada para criar imagens
systemData	systemData		Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object		Tags de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Object

Carrega arquivos para VMs (Linux, Windows). Corresponde ao provisionador de arquivos Packer

Name	Tipo	Description
destination	string	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) onde o arquivo (de sourceUri) será carregado na VM
name	string	Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz
sha256Checksum	string	Soma de verificação SHA256 do arquivo fornecido no campo sourceUri acima
sourceUri	string	O URI do arquivo a ser carregado para personalizar a VM. Pode ser um link github, URI SAS para Armazenamento do Azure, etc
type	string: File	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell

ImageTemplateFileValidator

Object

Carrega arquivos necessários para validação em VMs (Linux, Windows). Corresponde ao provisionador de arquivos Packer

Name	Tipo	Description
destination	string	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) onde o arquivo (de sourceUri) será carregado na VM
name	string	Nome amigável para fornecer contexto sobre o que esta etapa de validação faz
sha256Checksum	string	Soma de verificação SHA256 do arquivo fornecido no campo sourceUri acima
sourceUri	string	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
type	string: File	O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell

ImageTemplateIdentity

Object

Identidade para o modelo de imagem.

Name	Tipo	Description
type	ResourceIdentityType	O tipo de identidade usado para o modelo de imagem. O tipo 'Nenhum' removerá todas as identidades do modelo de imagem.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identidades 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.

ImageTemplateLastRunStatus

Object

Descreve o status mais recente da execução de um modelo de imagem

Name	Tipo	Description
endTime	string (date-time)	Hora de fim da última execução (UTC)
message	string	Informações detalhadas sobre o estado da última execução
runState	RunState	Estado da última execução
runSubState	RunSubState	Subestado da última execução
startTime	string (date-time)	Hora de início da última execução (UTC)

ImageTemplateManagedImageDistributor

Object

Distribua como uma imagem de disco gerenciada.

Name	Tipo	Description
artifactTags	object	Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor.
imageId	string	ID do recurso da imagem de disco gerenciado
location	string	O local do Azure para a imagem, deve corresponder se a imagem já existir
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	O nome a ser usado para o RunOutput associado.
type	string: ManagedImage	Tipo de distribuição.

ImageTemplateManagedImageSource

Object

Descreve uma fonte de imagem que é uma imagem gerenciada na assinatura do cliente. Esta imagem deve residir na mesma assinatura e região que o modelo do Construtor de Imagens.

Name	Tipo	Description
imageId	string	ID de recurso ARM da imagem gerenciada na assinatura do cliente
type	string: ManagedImage	Especifica o tipo de imagem de origem com a qual você deseja começar.

ImageTemplatePlatformImageSource

Object

Descreve uma fonte de imagem do Azure Gallery Images.

Name	Tipo	Description
exactVersion	string	Versão da imagem do Azure Gallery Images. Este campo só de leitura difere de «versão», apenas se o valor especificado no campo «versão» for «mais recente».
offer	string	Oferta de imagem do Azure Gallery Images.
planInfo	PlatformImagePurchasePlan	Configuração opcional do plano de compra para imagem da plataforma.
publisher	string	Image Publisher no Azure Gallery Images.
sku	string	Documento de imagem do Azure Gallery Images.
type	string: PlatformImage	Especifica o tipo de imagem de origem com a qual você deseja começar.
version	string	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.

ImageTemplatePowerShellCustomizer

Object

Executa o PowerShell especificado na VM (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.

Name	Tipo	Default value	Description
inline	string[]		Matriz de comandos do PowerShell para executar
name	string		Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz
runAsSystem	boolean	False	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.
runElevated	boolean	False	Se especificado, o script do PowerShell será executado com privilégios elevados
scriptUri	string		URI do script do PowerShell a ser executado para personalização. Pode ser um link github, URI SAS para Armazenamento do Azure, etc
sha256Checksum	string		Soma de verificação SHA256 do script power shell fornecido no campo scriptUri acima
type	string: PowerShell		O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell
validExitCodes	integer[] (int32)		Códigos de saída válidos para o script do PowerShell. [Padrão: 0]

ImageTemplatePowerShellValidator

Object

Executa o script do PowerShell especificado durante a fase de validação (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.

Name	Tipo	Default value	Description
inline	string[]		Matriz de comandos do PowerShell para executar
name	string		Nome amigável para fornecer contexto sobre o que esta etapa de validação faz
runAsSystem	boolean	False	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.
runElevated	boolean	False	Se especificado, o script do PowerShell será executado com privilégios elevados
scriptUri	string		URI do script do PowerShell a ser executado para validação. Pode ser um link do github, URI do Armazenamento do Azure, etc
sha256Checksum	string		Soma de verificação SHA256 do script power shell fornecido no campo scriptUri acima
type	string: PowerShell		O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell
validExitCodes	integer[] (int32)		Códigos de saída válidos para o script do PowerShell. [Padrão: 0]

ImageTemplateRestartCustomizer

Object

Reinicia uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao Packer windows-restart provisioner

Name	Tipo	Description
name	string	Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz
restartCheckCommand	string	Comando para verificar se a reinicialização foi bem-sucedida [Padrão: '']
restartCommand	string	Comando para executar a reinicialização [Padrão: 'shutdown /r /f /t 0 /c "packer restart"']
restartTimeout	string	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']
type	string: WindowsRestart	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell

ImageTemplateSharedImageDistributor

Object

Distribua através da Galeria de Computação do Azure.

Name	Tipo	Default value	Description
artifactTags	object		Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor.
excludeFromLatest	boolean	False	Sinalizador que indica se a versão da imagem criada deve ser excluída da versão mais recente. Omitir o padrão (false).
galleryImageId	string		ID do recurso da imagem da Galeria de Computação do Azure
replicationRegions	string[]		[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.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		O nome a ser usado para o RunOutput associado.
storageAccountType	SharedImageStorageAccountType		[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.
targetRegions	TargetRegion[]		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.
type	string: SharedImage		Tipo de distribuição.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Descreve como gerar um novo número de versão x.y.z para distribuição.

ImageTemplateSharedImageVersionSource

Object

Descreve uma fonte de imagem que é uma versão de imagem em uma Galeria de Computação do Azure ou em uma Galeria Compartilhada Direta.

Name	Tipo	Description
exactVersion	string	ID exato do recurso ARM da versão da imagem. Este campo somente leitura difere do ID da versão da imagem em 'imageVersionId' somente se o nome da versão especificado no campo 'imageVersionId' for 'mais recente'.
imageVersionId	string	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.
type	string: SharedImageVersion	Especifica o tipo de imagem de origem com a qual você deseja começar.

ImageTemplateShellCustomizer

Object

Executa um shell script durante a fase de personalização (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.

Name	Tipo	Description
inline	string[]	Matriz de comandos do shell para executar
name	string	Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz
scriptUri	string	URI do shell script a ser executado para personalização. Pode ser um link github, URI SAS para Armazenamento do Azure, etc
sha256Checksum	string	Soma de verificação SHA256 do shell script fornecido no campo scriptUri
type	string: Shell	O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell

ImageTemplateShellValidator

Object

Executa o shell script especificado durante a fase de validação (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado.

Name	Tipo	Description
inline	string[]	Matriz de comandos do shell para executar
name	string	Nome amigável para fornecer contexto sobre o que esta etapa de validação faz
scriptUri	string	URI do shell script a ser executado para validação. Pode ser um link do github, URI do Armazenamento do Azure, etc
sha256Checksum	string	Soma de verificação SHA256 do shell script fornecido no campo scriptUri
type	string: Shell	O tipo de validação que você deseja usar na imagem. Por exemplo, "Shell" pode ser validação de shell

ImageTemplateVhdDistributor

Object

Distribua via VHD em uma conta de armazenamento.

Name	Tipo	Description
artifactTags	object	Tags que serão aplicadas ao artefato depois que ele for criado/atualizado pelo distribuidor.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	O nome a ser usado para o RunOutput associado.
type	string: VHD	Tipo de distribuição.
uri	string	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.

ImageTemplateVmProfile

Object

Descreve as máquinas virtuais usadas para criar e validar imagens

Name	Tipo	Default value	Description
osDiskSizeGB	integer (int32) minimum: 0	0	Tamanho do disco do SO em GB. Omita ou especifique 0 para usar o tamanho de disco padrão do sistema operacional do Azure.
userAssignedIdentities	string[]		Matriz opcional de IDs de recursos de identidades gerenciadas atribuídas pelo usuário a serem configuradas na VM de compilação e na VM de validação. Isso pode incluir a identidade do modelo de imagem.
vmSize	string		Tamanho da máquina virtual usada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_D1_v2 para imagens Gen1 e Standard_D2ds_v4 para imagens Gen2).
vnetConfig	VirtualNetworkConfig		Configuração opcional da rede virtual a ser usada para implantar a VM de compilação e a VM de validação. Omitir se nenhuma rede virtual específica precisar ser usada.

ImageTemplateWindowsUpdateCustomizer

Object

Instala as atualizações do Windows. Corresponde ao Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Name	Tipo	Default value	Description
filters	string[]		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.
name	string		Nome amigável para fornecer contexto sobre o que esta etapa de personalização faz
searchCriteria	string		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.
type	string: WindowsUpdate		O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell
updateLimit	integer (int32) minimum: 0	0	Número máximo de atualizações a aplicar de cada vez. Omitir ou especificar 0 para usar o padrão (1000)

Optimize

Object

Especifica a otimização a ser executada na imagem.

Name	Tipo	Description
vmBoot	VmBoot	A otimização é aplicada na imagem para uma inicialização mais rápida da VM.

PlatformImagePurchasePlan

Object

Configuração do plano de compra para imagem da plataforma.

Name	Tipo	Description
planName	string	Nome do plano de compra.
planProduct	string	Produto do plano de compra.
planPublisher	string	Editor do plano de compra.

ProvisioningError

Object

Descreve o erro ocorrido ao criar ou atualizar um modelo de imagem

Name	Tipo	Description
message	string	Mensagem de erro detalhada sobre a falha de provisionamento
provisioningErrorCode	ProvisioningErrorCode	Código de erro da falha de provisionamento

ProvisioningErrorCode

Enumeração

Código de erro da falha de provisionamento

Valor	Description
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Enumeração

Estado de provisionamento do recurso

Valor	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Enumeração

O tipo de identidade usado para o modelo de imagem. O tipo 'Nenhum' removerá todas as identidades do modelo de imagem.

Valor	Description
UserAssigned
None

RunState

Enumeração

Estado da última execução

Valor	Description
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Enumeração

Subestado da última execução

Valor	Description
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Enumeração

Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem da Galeria de Computação do Azure.

Valor	Description
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TargetRegion

Object

Descreve as informações da região de destino.

Name	Tipo	Default value	Description
name	string		O nome da região.
replicaCount	integer (int32) minimum: 1	1	O número de réplicas da versão da imagem a ser criada nesta região. Omitir o padrão (1).
storageAccountType	SharedImageStorageAccountType		Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem nessa região. Omitir o padrão (Standard_LRS).

UserAssignedIdentity

Object

Propriedades de identidade atribuídas pelo usuário

Name	Tipo	Description
clientId	string	O ID do cliente da identidade atribuída.
principalId	string	O ID principal da identidade atribuída.

Validate

Object

Opções de configuração e lista de validações a serem executadas na imagem resultante.

Name	Tipo	Default value	Description
continueDistributeOnFailure	boolean	False	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.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Lista de validações a serem realizadas.
sourceValidationOnly	boolean	False	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.

VirtualNetworkConfig

Object

Configuração de rede virtual.

Name	Tipo	Description
proxyVmSize	string	Tamanho da máquina virtual proxy usada para passar o tráfego para a VM de compilação e a VM de validação. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_A1_v2).
subnetId	string	ID do recurso de uma sub-rede pré-existente.

VmBoot

Object

A otimização é aplicada na imagem para uma inicialização mais rápida da VM.

Name	Tipo	Description
state	VMBootOptimizationState	Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída final da imagem personalizada.

VMBootOptimizationState

Enumeração

Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída final da imagem personalizada.

Valor	Description
Enabled
Disabled

Partilhar via

Virtual Machine Image Templates - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Retrieve an Image Template.

Pedido de amostra

Resposta da amostra

Definições

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState