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 de URI

Nome	Em	Obrigató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. A 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

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Retrieve an Image Template.

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 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

Nome	Description
CloudError	Uma resposta de erro do serviço Construtor de Imagens da VM do Azure.
CloudErrorBody	Uma resposta de erro do serviço Construtor de Imagens da 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 de versão da imagem de origem
ImageTemplate	O modelo de imagem é um recurso do ARM gerenciado pelo provedor Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Carrega arquivos em 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 do modelo de imagem.
ImageTemplateLastRunStatus	Descreve o status mais recente da execução de um modelo de imagem
ImageTemplateManagedImageDistributor	Distribua como uma imagem de disco gerenciado.
ImageTemplateManagedImageSource	Descreve uma fonte de imagem que é uma imagem gerenciada na assinatura do cliente. Essa imagem deve residir na mesma assinatura e região que o modelo do Construtor de Imagens.
ImageTemplatePlatformImageSource	Descreve uma fonte de imagem do de Imagens da Galeria do Azure.
ImageTemplatePowerShellCustomizer	Executa o PowerShell especificado na VM (Windows). Corresponde ao provisionador do PowerShell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.
ImageTemplatePowerShellValidator	Executa o script do PowerShell especificado durante a fase de validação (Windows). Corresponde ao provisionador do PowerShell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.
ImageTemplateRestartCustomizer	Reinicializa uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao provisionador de reinicialização de janelas do Packer
ImageTemplateSharedImageDistributor	Distribua por meio 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 script de shell durante a fase de personalização (Linux). Corresponde ao provisionador de shell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.
ImageTemplateShellValidator	Executa o script de shell especificado durante a fase de validação (Linux). Corresponde ao provisionador de shell do Packer. Exatamente um de 'scriptUri' ou 'embutido' 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 o Windows Updates. Corresponde ao Provisionador do Windows Update do Packer (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 a 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 'None' removerá as identidades do modelo de imagem.
RunState	Estado da última execução
RunSubState	Sub-estado 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 relativos à 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 de VM mais rápida.
VMBootOptimizationState	Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída da imagem personalizada final.

CloudError

Objeto

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

Nome	Tipo	Description
error	CloudErrorBody	Detalhes sobre o erro.

CloudErrorBody

Objeto

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

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino 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

Objeto

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

Nome	Tipo	Valor padrão	Description
major	integer (int32) minimum: -1	-1	Versão principal do 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 é equivalente a deixá-lo não definido.
scheme	string: Latest		Esquema de numeração de versão a ser usado.

DistributeVersionerSource

Objeto

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

Nome	Tipo	Description
scheme	string: Source	Esquema de numeração de versão a ser usado.

ImageTemplate

Objeto

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

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		A identidade do modelo de imagem, se configurada.
location	string		A localização geográfica onde o recurso reside
name	string		O nome do recurso
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Duração máxima para aguardar durante a criação do modelo de imagem (inclui todas as personalizações, otimização, validações e distribuições). Omita ou especifique 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 de imagem etc.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		A distribuição é direcionada para onde a saída da imagem precisa ir.
properties.exactStagingResourceGroup	string		A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Esse campo somente leitura difere de "stagingResourceGroup" somente se o valor especificado no campo 'stagingResourceGroup' estiver vazio.
properties.lastRunStatus	ImageTemplateLastRunStatus		Estado de "run" que está 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		A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem. Se esse campo estiver vazio, um grupo de recursos com um nome aleatório será criado. 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 que o modelo de imagem. O grupo de recursos criado será excluído durante a exclusão do modelo se esse campo estiver vazio ou 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 que contêm informações createdBy e modifiedBy.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Objeto

Carrega arquivos em VMs (Linux, Windows). Corresponde ao provisionador de arquivos packer

Nome	Tipo	Description
destination	string	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) em que o arquivo (de sourceUri) será carregado na VM
name	string	Nome Amigável para fornecer contexto sobre o que essa 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 do 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 o personalizador de shell

ImageTemplateFileValidator

Objeto

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

Nome	Tipo	Description
destination	string	O caminho absoluto para um arquivo (com estruturas de diretório aninhadas já criadas) em que 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

Objeto

Identidade do modelo de imagem.

Nome	Tipo	Description
type	ResourceIdentityType	O tipo de identidade usado para o modelo de imagem. O tipo 'None' removerá as identidades do modelo de imagem.
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades de User-Assigned O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ImageTemplateLastRunStatus

Objeto

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

Nome	Tipo	Description
endTime	string (date-time)	Hora de término da última execução (UTC)
message	string	Informações detalhadas sobre o último estado de execução
runState	RunState	Estado da última execução
runSubState	RunSubState	Sub-estado da última execução
startTime	string (date-time)	Hora de início da última execução (UTC)

ImageTemplateManagedImageDistributor

Objeto

Distribua como uma imagem de disco gerenciado.

Nome	Tipo	Description
artifactTags	object	Marcas que serão aplicadas ao artefato depois que ele tiver sido 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

Objeto

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

Nome	Tipo	Description
imageId	string	ID de recurso do 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

Objeto

Descreve uma fonte de imagem do de Imagens da Galeria do Azure.

Nome	Tipo	Description
exactVersion	string	Versão da imagem dode Imagens da Galeria do Azure . Esse campo readonly difere de 'version', somente se o valor especificado no campo 'version' for 'latest'.
offer	string	Oferta de imagem doImagens da Galeria do Azure.
planInfo	PlatformImagePurchasePlan	Configuração opcional do plano de compra para a imagem da plataforma.
publisher	string	Editor de Imagens no de Imagens da Galeria do Azure.
sku	string	SKU de imagem dode Imagens da Galeria do Azure .
type	string: PlatformImage	Especifica o tipo de imagem de origem com a qual você deseja começar.
version	string	Versão da imagem dode Imagens da Galeria do Azure . Se 'latest' for especificado aqui, a versão será avaliada quando o build de imagem ocorrer, não quando o modelo for enviado.

ImageTemplatePowerShellCustomizer

Objeto

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

Nome	Tipo	Valor padrão	Description
inline	string[]		Matriz de comandos do PowerShell a serem executados
name	string		Nome Amigável para fornecer contexto sobre o que essa 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 verdadeiro quando o campo runElevated acima é 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 do github, URI SAS para Armazenamento do Azure etc.
sha256Checksum	string		Soma de verificação SHA256 do script do 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 o personalizador de shell
validExitCodes	integer[] (int32)		Códigos de saída válidos para o script do PowerShell. [Padrão: 0]

ImageTemplatePowerShellValidator

Objeto

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

Nome	Tipo	Valor padrão	Description
inline	string[]		Matriz de comandos do PowerShell a serem executados
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 verdadeiro quando o campo runElevated acima é 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 do 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

Objeto

Reinicializa uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao provisionador de reinicialização de janelas do Packer

Nome	Tipo	Description
name	string	Nome Amigável para fornecer contexto sobre o que essa 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 caracteres 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 o personalizador de shell

ImageTemplateSharedImageDistributor

Objeto

Distribua por meio da Galeria de Computação do Azure.

Nome	Tipo	Valor padrão	Description
artifactTags	object		Marcas que serão aplicadas ao artefato depois que ele tiver sido 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. Omita para usar o padrão (false).
galleryImageId	string		ID de 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. Essa lista só poderá ser especificada se targetRegions não for especificado. Esse 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. Omita para usar o padrão (Standard_LRS). Esse campo só poderá ser especificado se replicationRegions for especificado. Esse campo foi preterido – use targetRegions em vez disso.
targetRegions	TargetRegion[]		As regiões de destino para as quais a versão da imagem distribuída será replicada. Esse objeto substitui replicationRegions e só pode ser especificado se replicationRegions não for especificada.
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

Objeto

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.

Nome	Tipo	Description
exactVersion	string	ID exata do recurso DO ARM da versão da imagem. Esse campo readonly difere da ID da versão da imagem em 'imageVersionId' somente se o nome da versão especificado no campo 'imageVersionId' for 'latest'.
imageVersionId	string	ID de recurso do ARM da versão da imagem. Quando o nome da versão da imagem é 'mais recente', a versão é avaliada quando o build de imagem ocorre.
type	string: SharedImageVersion	Especifica o tipo de imagem de origem com a qual você deseja começar.

ImageTemplateShellCustomizer

Objeto

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

Nome	Tipo	Description
inline	string[]	Matriz de comandos de shell a serem executados
name	string	Nome Amigável para fornecer contexto sobre o que essa etapa de personalização faz
scriptUri	string	URI do script de shell a ser executado para personalização. Pode ser um link do github, URI SAS para Armazenamento do Azure etc.
sha256Checksum	string	Soma de verificação SHA256 do script de shell 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 o personalizador de shell

ImageTemplateShellValidator

Objeto

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

Nome	Tipo	Description
inline	string[]	Matriz de comandos de shell a serem executados
name	string	Nome Amigável para fornecer contexto sobre o que esta etapa de validação faz
scriptUri	string	URI do script de shell 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 de shell 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

Objeto

Distribua via VHD em uma conta de armazenamento.

Nome	Tipo	Description
artifactTags	object	Marcas que serão aplicadas ao artefato depois que ele tiver sido 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 opcional do Armazenamento do Azure para o blob de VHD distribuído. Omita usar o padrão (cadeia de caracteres vazia) nesse caso, o VHD seria publicado na conta de armazenamento no grupo de recursos de preparo.

ImageTemplateVmProfile

Objeto

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

Nome	Tipo	Valor padrão	Description
osDiskSizeGB	integer (int32) minimum: 0	0	Tamanho do disco do sistema operacional em GB. Omita ou especifique 0 para usar o tamanho padrão do disco do sistema operacional do Azure.
userAssignedIdentities	string[]		Matriz opcional de IDs de recurso de identidades gerenciadas atribuídas pelo usuário a serem configuradas na VM de build 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 build e a VM de validação. Omita se nenhuma rede virtual específica precisar ser usada.

ImageTemplateWindowsUpdateCustomizer

Objeto

Instala o Windows Updates. Corresponde ao Provisionador do Windows Update do Packer (https://github.com/rgl/packer-provisioner-windows-update)

Nome	Tipo	Valor padrão	Description
filters	string[]		Matriz de filtros para selecionar atualizações a serem aplicadas. Omita ou especifique a matriz vazia para usar o padrão (sem filtro). Consulte o link acima para obter exemplos e descrição detalhada desse campo.
name	string		Nome Amigável para fornecer contexto sobre o que essa 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 (pesquise tudo). Consulte o link acima para obter exemplos e descrição detalhada desse campo.
type	string: WindowsUpdate		O tipo de ferramenta de personalização que você deseja usar na Imagem. Por exemplo, "Shell" pode ser o personalizador de shell
updateLimit	integer (int32) minimum: 0	0	Número máximo de atualizações a serem aplicadas por vez. Omita ou especifique 0 para usar o padrão (1000)

Optimize

Objeto

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

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

PlatformImagePurchasePlan

Objeto

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

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

ProvisioningError

Objeto

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

Nome	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 'None' removerá 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

Sub-estado 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

Objeto

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

Nome	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

Objeto

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

Nome	Tipo	Valor padrão	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 nessa região. Omita para usar o padrão (1).
storageAccountType	SharedImageStorageAccountType		Especifica o tipo de conta de armazenamento a ser usado para armazenar a imagem nessa região. Omita para usar o padrão (Standard_LRS).

UserAssignedIdentity

Objeto

Propriedades de identidade atribuídas pelo usuário

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída.
principalId	string	A ID da entidade de segurança da identidade atribuída.

Validate

Objeto

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

Nome	Tipo	Valor padrão	Description
continueDistributeOnFailure	boolean	False	Se a validação falhar e esse campo for definido como false, as imagens de saída não serão distribuídas. Esse é o comportamento padrão. Se a validação falhar e esse campo for definido como true, as imagens de saída ainda serão distribuídas. Use essa opção com cuidado, pois pode resultar em imagens incorretas sendo distribuídas para uso. Em ambos os casos (true ou false), a execução de imagem de ponta a ponta será relatada como tendo falhado em caso de falha de validação. [Observação: este campo não terá efeito se a validação for bem-sucedida.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Lista de validações a serem executadas.
sourceValidationOnly	boolean	False	Se esse campo for definido como true, a imagem especificada na seção 'source' será validada diretamente. Nenhum build separado será executado para gerar e validar uma imagem personalizada.

VirtualNetworkConfig

Objeto

Configuração de Rede Virtual.

Nome	Tipo	Description
proxyVmSize	string	Tamanho da máquina virtual proxy usada para passar o tráfego para a VM de build 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 de recurso de uma sub-rede pré-existente.

VmBoot

Objeto

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

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

VMBootOptimizationState

Enumeração

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

Valor	Description
Enabled
Disabled

Compartilhar via

Virtual Machine Image Templates - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Retrieve an Image Template.

Solicitação de exemplo

Resposta de exemplo

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