Microsoft.VirtualMachineImages imageTemplates 2021-10-01
Definição de recurso do Bicep
O tipo de recurso imageTemplates pode ser implementado em:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.VirtualMachineImages/imageTemplates, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2021-10-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
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
}
]
source: {
type: 'string'
// For remaining properties, see ImageTemplateSource objects
}
vmProfile: {
osDiskSizeGB: int
userAssignedIdentities: [
'string'
]
vmSize: 'string'
vnetConfig: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para Ficheiro, utilize:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Para o PowerShell, utilize:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Para Shell, utilize:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Para WindowsRestart, utilize:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Para WindowsUpdate, utilize:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Para SharedImage, utilize:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
Para VHD, utilize:
type: 'VHD'
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
type: 'ManagedImage'
imageId: 'string'
Para PlatformImage, utilize:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
Para SharedImageVersion, utilize:
type: 'SharedImageVersion'
imageVersionId: 'string'
Valores de propriedade
imageTemplates
| Nome | Descrição | Valor |
|---|---|---|
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
| propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
ImageTemplateIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade utilizado para o modelo de imagem. O tipo "Nenhum" removerá todas as identidades do modelo de imagem. | "Nenhum" "UserAssigned" |
| userAssignedIdentities | A lista de identidades de utilizador associadas ao modelo de imagem. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | objeto |
ImageTemplateProperties
| Nome | Descrição | Valor |
|---|---|---|
| buildTimeoutInMinutes | Duração máxima a aguardar durante a criação do modelo de imagem. Omita ou especifique 0 para utilizar a predefinição (4 horas). | int |
| personalizar | Especifica as propriedades utilizadas para descrever os passos de personalização da imagem, como a Origem da imagem, etc. | ImageTemplateCustomizer[] |
| distribuir | A distribuição destina-se ao local para onde a saída da imagem tem de ir. | ImageTemplateDistributor[] (obrigatório) |
| source | Especifica as propriedades utilizadas para descrever a imagem de origem. | ImageTemplateSource (obrigatório) |
| vmProfile | Descreve como a máquina virtual está configurada para criar imagens | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome Amigável para fornecer contexto sobre o que faz este passo de personalização | string |
| tipo | Definir o tipo de objeto | Ficheiro PowerShell Shell WindowsRestart WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Ficheiro" (obrigatório) |
| destino | O caminho absoluto para um ficheiro (com estruturas de diretório aninhadas já criadas) para o qual o ficheiro (de sourceUri) será carregado na VM | string |
| sha256Checksum | Soma de verificação SHA256 do ficheiro fornecido no campo sourceUri acima | string |
| sourceUri | O URI do ficheiro a carregar para personalizar a VM. Pode ser uma ligação do github, URI de SAS para o Armazenamento do Azure, etc. | string |
ImageTemplatePowerShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "PowerShell" (obrigatório) |
| inline | Matriz de comandos do PowerShell a executar | cadeia[] |
| runAsSystem | Se especificado, o script do PowerShell será executado com privilégios elevados com o utilizador do Sistema Local. Só pode ser verdade quando o campo runElevated acima estiver definido como verdadeiro. | bool |
| runElevated | Se especificado, o script do PowerShell será executado com privilégios elevados | bool |
| scriptUri | URI do script do PowerShell a ser executado para personalização. Pode ser uma ligação do github, URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script do power shell fornecido no campo scriptUri acima | string |
| validExitCodes | Códigos de saída válidos para o script do PowerShell. [Predefinição: 0] | int[] |
ImageTemplateShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Shell" (obrigatório) |
| inline | Matriz de comandos da shell a executar | cadeia[] |
| scriptUri | URI do script da shell a ser executado para personalização. Pode ser uma ligação do github, URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script de shell fornecido no campo scriptUri | string |
ImageTemplateRestartCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsRestart" (obrigatório) |
| restartCheckCommand | Comando para verificar se o reinício foi bem-sucedido [Predefinição: ''] | string |
| reiniciarComando | Comando para executar o reinício [Predefinição: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
| restartTimeout | Tempo limite de reinício especificado como uma cadeia de magnitude e unidade, por exemplo, "5 m" (5 minutos) ou "2h" (2 horas) [Predefinição: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsUpdate" (obrigatório) |
| filtros | Matriz de filtros para selecionar atualizações a aplicar. Omita ou especifique a matriz vazia para utilizar a predefinição (sem filtro). Veja a ligação acima para obter exemplos e descrição detalhada deste campo. | cadeia[] |
| searchCriteria | Critérios para procurar atualizações. Omita ou especifique a cadeia vazia para utilizar a predefinição (procurar em todos). Veja a ligação 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 utilizar a predefinição (1000) | int |
ImageTemplateDistributor
| Nome | Descrição | Valor |
|---|---|---|
| artifactTags | Etiquetas que serão aplicadas ao artefacto depois de serem criadas/atualizadas pelo distribuidor. | objeto |
| runOutputName | O nome a utilizar para o RunOutput associado. | cadeia (obrigatório) |
| tipo | Definir o tipo de objeto | ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "ManagedImage" (obrigatório) |
| imageId | ID do Recurso da Imagem do Disco Gerido | cadeia (obrigatório) |
| localização | A localização do Azure para a imagem deve corresponder se a imagem já existir | cadeia (obrigatório) |
ImageTemplateSharedImageDistributor
| Nome | 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 a utilização da predefinição (falso). | bool |
| galleryImageId | ID do recurso da imagem de Shared Image Gallery | cadeia (obrigatório) |
| replicationRegions | Uma lista de regiões para as quais a imagem será replicada | string[] (obrigatório) |
| storageAccountType | Tipo de conta de armazenamento a utilizar para armazenar a imagem partilhada. Omitir a utilização da predefinição (Standard_LRS). | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "VHD" (obrigatório) |
ImageTemplateSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Definir o tipo de objeto | ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "ManagedImage" (obrigatório) |
| imageId | ID do recurso arm da imagem gerida na subscrição do cliente | cadeia (obrigatório) |
ImageTemplatePlatformImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "PlatformImage" (obrigatório) |
| oferta | Oferta de imagem a partir das Imagens da Galeria do Azure. | string |
| planInfo | Configuração opcional do plano de compra para imagem de plataforma. | PlatformImagePurchasePlan |
| publicador | Image Publisher in Azure Gallery Images (Imagens da Galeria do Azure). | string |
| sku | SKU de imagem das Imagens da Galeria do Azure. | string |
| versão | Versão da imagem das Imagens da Galeria do Azure. Se "mais recente" for especificado aqui, a versão é avaliada quando a compilação da imagem ocorre, não quando o modelo é submetido. | string |
PlatformImagePurchasePlan
| Nome | Descrição | Valor |
|---|---|---|
| planName | Nome do plano de compra. | cadeia (obrigatório) |
| planProduct | Produto do plano de compra. | cadeia (obrigatório) |
| planPublisher | Publicador do plano de compra. | cadeia (obrigatório) |
ImageTemplateSharedImageVersionSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "SharedImageVersion" (obrigatório) |
| imageVersionId | ID do recurso arm da versão da imagem na galeria de imagens partilhadas | cadeia (obrigatório) |
ImageTemplateVmProfile
| Nome | Descrição | Valor |
|---|---|---|
| osDiskSizeGB | Tamanho do disco do SO em GB. Omita ou especifique 0 para utilizar o tamanho de disco do SO predefinido do Azure. | int |
| userAssignedIdentities | Matriz opcional de IDs de recursos de identidades geridas atribuídas pelo utilizador a configurar na VM de compilação. Isto pode incluir a identidade do modelo de imagem. | string[] |
| vmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia vazia para utilizar a predefinição (Standard_D2ds_v4). | string |
| vnetConfig | Configuração opcional da rede virtual a utilizar para implementar a máquina virtual de compilação. Omitir se não for necessário utilizar uma rede virtual específica. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nome | Descrição | Valor |
|---|---|---|
| proxyVmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique uma cadeia vazia para utilizar a predefinição (Standard_D1_v2 para imagens gen1 e Standard_D2ds_v4 para imagens Gen2). | string |
| subnetId | ID de recurso de uma sub-rede pré-existente. | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
Azure Image Builder with Azure Windows Baseline |
Cria um ambiente do Azure Image Builder e cria uma imagem do Windows Server com o Atualizações mais recente do Windows e a Linha de Base do Windows do Azure aplicadas. |
| Configurar o serviço Dev Box |
Este modelo criaria todos os recursos de administrador do Dev Box de acordo com o Guia de introdução do Dev Box. Pode ver todos os recursos criados ou aceder diretamente a DevPortal.microsoft.com para criar o seu primeiro Dev Box. |
Definição de recurso do modelo arm
O tipo de recurso imageTemplates pode ser implementado em:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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": "2021-10-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"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
}
],
"source": {
"type": "string"
// For remaining properties, see ImageTemplateSource objects
},
"vmProfile": {
"osDiskSizeGB": "int",
"userAssignedIdentities": [ "string" ],
"vmSize": "string",
"vnetConfig": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
}
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para Ficheiro, utilize:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Para o PowerShell, utilize:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Para Shell, utilize:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Para WindowsRestart, utilize:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Para WindowsUpdate, utilize:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Para SharedImage, utilize:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
Para VHD, utilize:
"type": "VHD"
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
"type": "ManagedImage",
"imageId": "string"
Para PlatformImage, utilize:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
Para SharedImageVersion, utilize:
"type": "SharedImageVersion",
"imageVersionId": "string"
Valores de propriedade
imageTemplates
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | A versão da API de recursos | '2021-10-01' |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
| identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
| propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
ImageTemplateIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade utilizado para o modelo de imagem. O tipo "Nenhum" removerá todas as identidades do modelo de imagem. | "Nenhum" "UserAssigned" |
| userAssignedIdentities | A lista de identidades de utilizador associadas ao modelo de imagem. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | objeto |
ImageTemplateProperties
| Nome | Descrição | Valor |
|---|---|---|
| buildTimeoutInMinutes | Duração máxima a aguardar durante a criação do modelo de imagem. Omita ou especifique 0 para utilizar a predefinição (4 horas). | int |
| personalizar | Especifica as propriedades utilizadas para descrever os passos de personalização da imagem, como a Origem da imagem, etc. | ImageTemplateCustomizer[] |
| distribuir | A distribuição destina-se ao local para onde a saída da imagem tem de ir. | ImageTemplateDistributor[] (obrigatório) |
| source | Especifica as propriedades utilizadas para descrever a imagem de origem. | ImageTemplateSource (obrigatório) |
| vmProfile | Descreve como a máquina virtual está configurada para criar imagens | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome Amigável para fornecer contexto sobre o que faz este passo de personalização | string |
| tipo | Definir o tipo de objeto | Ficheiro PowerShell Shell WindowsRestart WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Ficheiro" (obrigatório) |
| destino | O caminho absoluto para um ficheiro (com estruturas de diretório aninhadas já criadas) para o qual o ficheiro (de sourceUri) será carregado na VM | string |
| sha256Checksum | Soma de verificação SHA256 do ficheiro fornecido no campo sourceUri acima | string |
| sourceUri | O URI do ficheiro a carregar para personalizar a VM. Pode ser uma ligação do github, um URI de SAS para o Armazenamento do Azure, etc. | string |
ImageTemplatePowerShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "PowerShell" (obrigatório) |
| inline | Matriz de comandos do PowerShell a executar | string[] |
| runAsSystem | Se for especificado, o script do PowerShell será executado com privilégios elevados com o utilizador do Sistema Local. Só pode ser verdadeiro quando o campo runElevated acima está definido como verdadeiro. | bool |
| runElevated | Se especificado, o script do PowerShell será executado com privilégios elevados | bool |
| scriptUri | URI do script do PowerShell a ser executado para personalização. Pode ser uma ligação do github, URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script do power shell fornecido no campo scriptUri acima | string |
| validExitCodes | Códigos de saída válidos para o script do PowerShell. [Predefinição: 0] | int[] |
ImageTemplateShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Shell" (obrigatório) |
| inline | Matriz de comandos da shell a executar | cadeia[] |
| scriptUri | URI do script da shell a ser executado para personalização. Pode ser uma ligação do github, URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script de shell fornecido no campo scriptUri | string |
ImageTemplateRestartCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsRestart" (obrigatório) |
| restartCheckCommand | Comando para verificar se o reinício foi bem-sucedido [Predefinição: ''] | string |
| reiniciarComando | Comando para executar o reinício [Predefinição: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
| restartTimeout | Tempo limite de reinício especificado como uma cadeia de magnitude e unidade, por exemplo, "5 m" (5 minutos) ou "2h" (2 horas) [Predefinição: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsUpdate" (obrigatório) |
| filtros | Matriz de filtros para selecionar atualizações a aplicar. Omita ou especifique a matriz vazia para utilizar a predefinição (sem filtro). Veja a ligação acima para obter exemplos e descrição detalhada deste campo. | cadeia[] |
| searchCriteria | Critérios para procurar atualizações. Omita ou especifique a cadeia vazia para utilizar a predefinição (procurar em todos). Veja a ligação acima para obter exemplos e descrição detalhada deste campo. | string |
| updateLimit | Número máximo de atualizações a aplicar de cada vez. Omitir ou especificar 0 para utilizar a predefinição (1000) | int |
ImageTemplateDistributor
| Nome | Descrição | Valor |
|---|---|---|
| artifactTags | Etiquetas que serão aplicadas ao artefacto depois de serem criadas/atualizadas pelo distribuidor. | objeto |
| runOutputName | O nome a utilizar para o RunOutput associado. | cadeia (obrigatório) |
| tipo | Definir o tipo de objeto | ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "ManagedImage" (obrigatório) |
| imageId | ID do Recurso da Imagem de Disco Gerido | cadeia (obrigatório) |
| localização | A localização do Azure para a imagem deve corresponder se a imagem já existir | cadeia (obrigatório) |
ImageTemplateSharedImageDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "SharedImage" (obrigatório) |
| excludeFromLatest | Sinalizador que indica se a versão de imagem criada deve ser excluída da versão mais recente. Omitir para utilizar a predefinição (falso). | bool |
| galleryImageId | ID de recurso da imagem de Shared Image Gallery | cadeia (obrigatório) |
| replicationRegions | Uma lista de regiões para as quais a imagem será replicada | string[] (obrigatório) |
| storageAccountType | Tipo de conta de armazenamento a ser utilizado para armazenar a imagem partilhada. Omitir para utilizar a predefinição (Standard_LRS). | 'Standard_LRS' 'Standard_ZRS' |
ImageTemplateVhdDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "VHD" (obrigatório) |
ImageTemplateSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Definir o tipo de objeto | ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "ManagedImage" (obrigatório) |
| imageId | ID de recurso do ARM da imagem gerida na subscrição do cliente | cadeia (obrigatório) |
ImageTemplatePlatformImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "PlatformImage" (obrigatório) |
| oferta | Oferta de imagem a partir das Imagens da Galeria do Azure. | string |
| planInfo | Configuração opcional do plano de compra para imagem de plataforma. | PlatformImagePurchasePlan |
| publicador | Image Publisher in Azure Gallery Images (Imagens da Galeria do Azure). | string |
| sku | SKU da imagem a partir das Imagens da Galeria do Azure. | string |
| versão | Versão da imagem das Imagens da Galeria do Azure. Se "mais recente" for especificado aqui, a versão é avaliada quando a compilação da imagem ocorre e não quando o modelo é submetido. | string |
PlatformImagePurchasePlan
| Nome | Descrição | Valor |
|---|---|---|
| planName | Nome do plano de compra. | cadeia (obrigatório) |
| planProduct | Produto do plano de compra. | cadeia (obrigatório) |
| planPublisher | Publicador do plano de compra. | cadeia (obrigatório) |
ImageTemplateSharedImageVersionSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "SharedImageVersion" (obrigatório) |
| imageVersionId | ID de recurso do ARM da versão da imagem na galeria de imagens partilhadas | cadeia (obrigatório) |
ImageTemplateVmProfile
| Nome | Descrição | Valor |
|---|---|---|
| osDiskSizeGB | Tamanho do disco do SO em GB. Omita ou especifique 0 para utilizar o tamanho predefinido do disco do SO do Azure. | int |
| userAssignedIdentities | Matriz opcional de IDs de recursos de identidades geridas atribuídas pelo utilizador a configurar na VM de compilação. Isto pode incluir a identidade do modelo de imagem. | string[] |
| vmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia vazia para utilizar a predefinição (Standard_D2ds_v4). | string |
| vnetConfig | Configuração opcional da rede virtual a utilizar para implementar a máquina virtual de compilação. Omitir se não for necessário utilizar uma rede virtual específica. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nome | Descrição | Valor |
|---|---|---|
| proxyVmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique uma cadeia vazia para utilizar a predefinição (Standard_D1_v2 para imagens gen1 e Standard_D2ds_v4 para imagens Gen2). | string |
| subnetId | ID de recurso de uma sub-rede pré-existente. | string |
Modelos de início rápido
Os seguintes modelos de início rápido implementam este tipo de recurso.
| Modelo | Description |
|---|---|
| Azure Image Builder with Azure Windows Baseline |
Cria um ambiente do Azure Image Builder e cria uma imagem do Windows Server com o Atualizações mais recente do Windows e a Linha de Base do Windows do Azure aplicadas. |
| Configurar o serviço Dev Box |
Este modelo criaria todos os recursos de administrador do Dev Box de acordo com o Guia de introdução do Dev Box. Pode ver todos os recursos criados ou aceder diretamente a DevPortal.microsoft.com para criar o seu primeiro Dev Box. |
Definição de recurso terraform (fornecedor AzAPI)
O tipo de recurso imageTemplates pode ser implementado em:
- Grupos de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2021-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
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
}
]
source = {
type = "string"
// For remaining properties, see ImageTemplateSource objects
}
vmProfile = {
osDiskSizeGB = int
userAssignedIdentities = [
"string"
]
vmSize = "string"
vnetConfig = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
Objetos ImageTemplateCustomizer
Defina a propriedade type para especificar o tipo de objeto.
Para Ficheiro, utilize:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Para o PowerShell, utilize:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Para Shell, utilize:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Para WindowsRestart, utilize:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Para WindowsUpdate, utilize:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
Objetos ImageTemplateDistributor
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
type = "ManagedImage"
imageId = "string"
location = "string"
Para SharedImage, utilize:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
Para VHD, utilize:
type = "VHD"
Objetos ImageTemplateSource
Defina a propriedade type para especificar o tipo de objeto.
Para ManagedImage, utilize:
type = "ManagedImage"
imageId = "string"
Para PlatformImage, utilize:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
Para SharedImageVersion, utilize:
type = "SharedImageVersion"
imageVersionId = "string"
Valores de propriedade
imageTemplates
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01" |
| name | O nome do recurso | cadeia (obrigatório) |
| localização | A localização geográfica onde reside o recurso | cadeia (obrigatório) |
| parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
| etiquetas | Etiquetas de recursos. | Dicionário de nomes e valores de etiquetas. |
| identidade | A identidade do modelo de imagem, se configurado. | ImageTemplateIdentity (obrigatório) |
| propriedades | As propriedades do modelo de imagem | ImageTemplateProperties |
ImageTemplateIdentity
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de identidade utilizado para o modelo de imagem. O tipo "Nenhum" removerá todas as identidades do modelo de imagem. | "UserAssigned" |
| identity_ids | A lista de identidades de utilizador associadas ao modelo de imagem. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Matriz de IDs de identidade do utilizador. |
ImageTemplateProperties
| Nome | Descrição | Valor |
|---|---|---|
| buildTimeoutInMinutes | Duração máxima a aguardar durante a criação do modelo de imagem. Omita ou especifique 0 para utilizar a predefinição (4 horas). | int |
| personalizar | Especifica as propriedades utilizadas para descrever os passos de personalização da imagem, como a Origem da imagem, etc. | ImageTemplateCustomizer[] |
| distribuir | A distribuição destina-se ao local para onde a saída da imagem tem de ir. | ImageTemplateDistributor[] (obrigatório) |
| source | Especifica as propriedades utilizadas para descrever a imagem de origem. | ImageTemplateSource (obrigatório) |
| vmProfile | Descreve como a máquina virtual está configurada para criar imagens | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| name | Nome Amigável para fornecer contexto sobre o que faz este passo de personalização | string |
| tipo | Definir o tipo de objeto | Ficheiro PowerShell Shell WindowsRestart WindowsUpdate (obrigatório) |
ImageTemplateFileCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Ficheiro" (obrigatório) |
| destino | O caminho absoluto para um ficheiro (com estruturas de diretório aninhadas já criadas) para o qual o ficheiro (de sourceUri) será carregado na VM | string |
| sha256Checksum | Soma de verificação SHA256 do ficheiro fornecido no campo sourceUri acima | string |
| sourceUri | O URI do ficheiro a carregar para personalizar a VM. Pode ser uma ligação do github, um URI de SAS para o Armazenamento do Azure, etc. | string |
ImageTemplatePowerShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "PowerShell" (obrigatório) |
| inline | Matriz de comandos do PowerShell a executar | string[] |
| runAsSystem | Se for especificado, o script do PowerShell será executado com privilégios elevados com o utilizador do Sistema Local. Só pode ser verdadeiro quando o campo runElevated acima está definido como verdadeiro. | bool |
| runElevated | Se for 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 uma ligação do github, um URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script do Power Shell fornecido no campo scriptUri acima | string |
| validExitCodes | Códigos de saída válidos para o script do PowerShell. [Predefinição: 0] | int[] |
ImageTemplateShellCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "Shell" (obrigatório) |
| inline | Matriz de comandos da shell a executar | string[] |
| scriptUri | URI do script da shell a ser executado para personalização. Pode ser uma ligação do github, um URI de SAS para o Armazenamento do Azure, etc. | string |
| sha256Checksum | Soma de verificação SHA256 do script de shell fornecido no campo scriptUri | string |
ImageTemplateRestartCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsRestart" (obrigatório) |
| restartCheckCommand | Comando para verificar se o reinício foi reiniciado com êxito [Predefinição: ''] | string |
| reiniciarComando | Comando para executar o reinício [Predefinição: 'shutdown /r /f /t 0 /c "packer restart"'] | string |
| restartTimeout | Tempo limite de reinício especificado como uma cadeia de magnitude e unidade, por exemplo, "5 m" (5 minutos) ou "2h" (2 horas) [Predefinição: '5m'] | string |
ImageTemplateWindowsUpdateCustomizer
| Nome | Descrição | Valor |
|---|---|---|
| tipo | O tipo de ferramenta de personalização que pretende utilizar na Imagem. Por exemplo, "Shell" pode ser personalizador de shell | "WindowsUpdate" (obrigatório) |
| filtros | Matriz de filtros para selecionar atualizações a aplicar. Omita ou especifique uma matriz vazia para utilizar a predefinição (sem filtro). Veja a ligação acima para obter exemplos e uma descrição detalhada deste campo. | string[] |
| searchCriteria | Critérios para procurar atualizações. Omita ou especifique a cadeia vazia para utilizar a predefinição (procurar em todos). Veja a ligação 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 utilizar a predefinição (1000) | int |
ImageTemplateDistributor
| Nome | Descrição | Valor |
|---|---|---|
| artifactTags | Etiquetas que serão aplicadas ao artefacto depois de serem criadas/atualizadas pelo distribuidor. | objeto |
| runOutputName | O nome a utilizar para o RunOutput associado. | cadeia (obrigatório) |
| tipo | Definir o tipo de objeto | ManagedImage SharedImage VHD (obrigatório) |
ImageTemplateManagedImageDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "ManagedImage" (obrigatório) |
| imageId | ID do Recurso da Imagem do Disco Gerido | cadeia (obrigatório) |
| localização | A localização do Azure para a imagem deve corresponder se a imagem já existir | cadeia (obrigatório) |
ImageTemplateSharedImageDistributor
| Nome | 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 a utilização da predefinição (falso). | bool |
| galleryImageId | ID do recurso da imagem de Shared Image Gallery | cadeia (obrigatório) |
| replicationRegions | Uma lista de regiões para as quais a imagem será replicada | string[] (obrigatório) |
| storageAccountType | Tipo de conta de armazenamento a utilizar para armazenar a imagem partilhada. Omitir a utilização da predefinição (Standard_LRS). | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Tipo de distribuição. | "VHD" (obrigatório) |
ImageTemplateSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Definir o tipo de objeto | ManagedImage PlatformImage SharedImageVersion (obrigatório) |
ImageTemplateManagedImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "ManagedImage" (obrigatório) |
| imageId | ID do recurso arm da imagem gerida na subscrição do cliente | cadeia (obrigatório) |
ImageTemplatePlatformImageSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "PlatformImage" (obrigatório) |
| oferta | Oferta de imagem a partir das Imagens da Galeria do Azure. | string |
| planInfo | Configuração opcional do plano de compra para imagem de plataforma. | PlatformImagePurchasePlan |
| publicador | Image Publisher in Azure Gallery Images (Imagens da Galeria do Azure). | string |
| sku | SKU de imagem das Imagens da Galeria do Azure. | string |
| versão | Versão da imagem das Imagens da Galeria do Azure. Se "mais recente" for especificado aqui, a versão é avaliada quando a compilação da imagem ocorre, não quando o modelo é submetido. | string |
PlatformImagePurchasePlan
| Nome | Descrição | Valor |
|---|---|---|
| planName | Nome do plano de compra. | cadeia (obrigatório) |
| planProduct | Produto do plano de compra. | cadeia (obrigatório) |
| planPublisher | Publicador do plano de compra. | cadeia (obrigatório) |
ImageTemplateSharedImageVersionSource
| Nome | Descrição | Valor |
|---|---|---|
| tipo | Especifica o tipo de imagem de origem com que pretende começar. | "SharedImageVersion" (obrigatório) |
| imageVersionId | ID do recurso arm da versão da imagem na galeria de imagens partilhadas | cadeia (obrigatório) |
ImageTemplateVmProfile
| Nome | Descrição | Valor |
|---|---|---|
| osDiskSizeGB | Tamanho do disco do SO em GB. Omita ou especifique 0 para utilizar o tamanho de disco do SO predefinido do Azure. | int |
| userAssignedIdentities | Matriz opcional de IDs de recursos de identidades geridas atribuídas pelo utilizador a configurar na VM de compilação. Isto pode incluir a identidade do modelo de imagem. | string[] |
| vmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia vazia para utilizar a predefinição (Standard_D2ds_v4). | string |
| vnetConfig | Configuração opcional da rede virtual a utilizar para implementar a máquina virtual de compilação. Omitir se não for necessário utilizar uma rede virtual específica. | VirtualNetworkConfig |
VirtualNetworkConfig
| Nome | Descrição | Valor |
|---|---|---|
| proxyVmSize | Tamanho da máquina virtual utilizada para criar, personalizar e capturar imagens. Omita ou especifique uma cadeia vazia para utilizar a predefinição (Standard_D1_v2 para imagens gen1 e Standard_D2ds_v4 para imagens Gen2). | string |
| subnetId | ID de recurso de uma sub-rede pré-existente. | string |
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários