Compartir a través de

Microsoft.VirtualMachineImages imageTemplates 2021-10-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso imageTemplates se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.VirtualMachineImages/imageTemplates, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2021-10-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para archivo, use:

  type: 'File'
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'

Para powerShell, use:

  type: 'PowerShell'
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  validExitCodes: [
    int
  ]

Para shell, use:

  type: 'Shell'
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'

Para WindowsRestart, use:

  type: 'WindowsRestart'
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'

Para WindowsUpdate, use:

  type: 'WindowsUpdate'
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  updateLimit: int

Objetos ImageTemplateDistributor

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

Para SharedImage, use:

  type: 'SharedImage'
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'

Para VHD, use:

  type: 'VHD'

Objetos ImageTemplateSource

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  type: 'ManagedImage'
  imageId: 'string'

Para PlatformImage, use:

  type: 'PlatformImage'
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  version: 'string'

Para SharedImageVersion, use:

  type: 'SharedImageVersion'
  imageVersionId: 'string'

Valores de propiedad

imageTemplates

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
identidad Identidad de la plantilla de imagen, si está configurada. ImageTemplateIdentity (obligatorio)
Propiedades Las propiedades de la plantilla de imagen ImageTemplateProperties

ImageTemplateIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen. 'Ninguno'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas a la plantilla de imagen. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ImageTemplateProperties

Nombre Descripción Valor
buildTimeoutInMinutes Duración máxima para esperar durante la creación de la plantilla de imagen. Omita o especifique 0 para usar el valor predeterminado (4 horas). Int

Restricciones:
Valor mínimo = 0
Valor máximo = 960
Personalizar Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc. ImageTemplateCustomizer []
distribuir Los destinos de distribución a los que debe ir la salida de la imagen. ImageTemplateDistributor[] (obligatorio)
fuente Especifica las propiedades usadas para describir la imagen de origen. ImageTemplateSource (obligatorio)
vmProfile Describe cómo se configura la máquina virtual para compilar imágenes ImageTemplateVmProfile

ImageTemplateCustomizer

Nombre Descripción Valor
nombre Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización cuerda
tipo Establecimiento del tipo de objeto archivo de
powerShell
 de shell de
WindowsRestart
WindowsUpdate (obligatorio)

ImageTemplateFileCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'File' (obligatorio)
destino Ruta de acceso absoluta a un archivo (con estructuras de directorio anidadas ya creadas) donde el archivo (desde sourceUri) se cargará en en la máquina virtual. cuerda
sha256Checksum Suma de comprobación SHA256 del archivo proporcionado en el campo sourceUri anterior cuerda
sourceUri Identificador URI del archivo que se va a cargar para personalizar la máquina virtual. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda

ImageTemplatePowerShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'PowerShell' (obligatorio)
Inline Matriz de comandos de PowerShell que se van a ejecutar string[]
runAsSystem Si se especifica, el script de PowerShell se ejecutará con privilegios elevados mediante el usuario del sistema local. Solo puede ser true cuando el campo runElevated anterior está establecido en true. Bool
runElevated Si se especifica, el script de PowerShell se ejecutará con privilegios elevados. Bool
scriptUri URI del script de PowerShell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de Power Shell proporcionado en el campo scriptUri anterior cuerda
validExitCodes Códigos de salida válidos para el script de PowerShell. [Valor predeterminado: 0] int[]

ImageTemplateShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'Shell' (obligatorio)
Inline Matriz de comandos de shell que se van a ejecutar string[]
scriptUri URI del script de shell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de shell proporcionado en el campo scriptUri cuerda

ImageTemplateRestartCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'WindowsRestart' (obligatorio)
restartCheckCommand Comando para comprobar si el reinicio se realizó correctamente [Valor predeterminado: ''] cuerda
restartCommand Comando para ejecutar el reinicio [Valor predeterminado: 'shutdown /r /f /t 0 /c "packer restart"'] cuerda
restartTimeout Tiempo de espera de reinicio especificado como una cadena de magnitud y unidad, por ejemplo, '5m' (5 minutos) o '2h' (2 horas) [Valor predeterminado: '5m'] cuerda

ImageTemplateWindowsUpdateCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'WindowsUpdate' (obligatorio)
filtros Matriz de filtros para seleccionar las actualizaciones que se van a aplicar. Omita o especifique una matriz vacía para usar el valor predeterminado (sin filtro). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. string[]
searchCriteria Criterios para buscar actualizaciones. Omita o especifique una cadena vacía para usar el valor predeterminado (buscar todo). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. cuerda
updateLimit Número máximo de actualizaciones que se aplicarán a la vez. Omitir o especificar 0 para usar el valor predeterminado (1000) Int

Restricciones:
Valor mínimo = 0

ImageTemplateDistributor

Nombre Descripción Valor
artifactTags Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado. objeto
runOutputName Nombre que se va a usar para el RunOutput asociado. string (obligatorio)

Restricciones:
Patrón = ^[A-Za-z0-9-_.]{1,64}$
tipo Establecimiento del tipo de objeto ManagedImage
SharedImage
VHD (obligatorio)

ImageTemplateManagedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'ManagedImage' (obligatorio)
imageId Identificador de recurso de la imagen de disco administrado string (obligatorio)
ubicación La ubicación de Azure de la imagen debe coincidir si la imagen ya existe string (obligatorio)

ImageTemplateSharedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'SharedImage' (obligatorio)
excludeFromLatest Marca que indica si la versión de la imagen creada debe excluirse de la versión más reciente. Omitir para usar el valor predeterminado (false). Bool
galleryImageId Identificador de recurso de la imagen de Shared Image Gallery string (obligatorio)
replicationRegions Lista de regiones en las que se replicará la imagen string[] (obligatorio)
storageAccountType Tipo de cuenta de almacenamiento que se usará para almacenar la imagen compartida. Omita usar el valor predeterminado (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'VHD' (obligatorio)

ImageTemplateSource

Nombre Descripción Valor
tipo Establecimiento del tipo de objeto ManagedImage
PlatformImage
sharedImageVersion (obligatorio)

ImageTemplateManagedImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'ManagedImage' (obligatorio)
imageId Identificador de recurso de ARM de la imagen administrada en la suscripción de cliente string (obligatorio)

ImageTemplatePlatformImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'PlatformImage' (obligatorio)
ofrecer Oferta de imagen de la Imágenes de la Galería de Azure. cuerda
planInfo Configuración opcional del plan de compra para la imagen de plataforma. PlatformImagePurchasePlan
editor Image Publisher en Imágenes de la Galería de Azure. cuerda
Sku SKU de imagen de la Imágenes de la Galería de Azure. cuerda
Versión Versión de imagen de la Imágenes de La galería de Azure. Si se especifica 'latest' aquí, la versión se evalúa cuando tiene lugar la compilación de la imagen, no cuando se envía la plantilla. cuerda

PlatformImagePurchasePlan

Nombre Descripción Valor
planName Nombre del plan de compra. string (obligatorio)
planProduct Producto del plan de compra. string (obligatorio)
planPublisher Publicador del plan de compra. string (obligatorio)

ImageTemplateSharedImageVersionSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'SharedImageVersion' (obligatorio)
imageVersionId Identificador de recurso de ARM de la versión de la imagen en la galería de imágenes compartidas string (obligatorio)

ImageTemplateVmProfile

Nombre Descripción Valor
osDiskSizeGB Tamaño del disco del sistema operativo en GB. Omita o especifique 0 para usar el tamaño de disco del sistema operativo predeterminado de Azure. Int

Restricciones:
Valor mínimo = 0
userAssignedIdentities Matriz opcional de identificadores de recursos de identidades administradas asignadas por el usuario que se van a configurar en la máquina virtual de compilación. Esto puede incluir la identidad de la plantilla de imagen. string[]
vmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D2ds_v4). cuerda
vnetConfig Configuración opcional de la red virtual que se va a usar para implementar la máquina virtual de compilación en. Omita si no es necesario usar ninguna red virtual específica. virtualNetworkConfig

VirtualNetworkConfig

Nombre Descripción Valor
proxyVmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D1_v2 para imágenes gen1 y Standard_D2ds_v4 para imágenes de Gen2). cuerda
subnetId Identificador de recurso de una subred existente previamente. cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Azure Image Builder con azure Windows Baseline

Implementación en Azure 		Crea un entorno de Azure Image Builder y crea una imagen de Windows Server con las actualizaciones más recientes de Windows y la línea de base de Windows de Azure aplicadas.
configuración del servicio Dev Box

Implementación en Azure 		Esta plantilla crearía todos los recursos de administración de Dev Box según la guía de inicio rápido de Dev Box (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box). Puede ver todos los recursos creados o ir directamente a DevPortal.microsoft.com para crear su primer cuadro de desarrollo.

Definición de recursos de plantilla de ARM

El tipo de recurso imageTemplates se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.VirtualMachineImages/imageTemplates, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2021-10-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para archivo, use:

  "type": "File",
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string"

Para powerShell, use:

  "type": "PowerShell",
  "inline": [ "string" ],
  "runAsSystem": "bool",
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "validExitCodes": [ "int" ]

Para shell, use:

  "type": "Shell",
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string"

Para WindowsRestart, use:

  "type": "WindowsRestart",
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string"

Para WindowsUpdate, use:

  "type": "WindowsUpdate",
  "filters": [ "string" ],
  "searchCriteria": "string",
  "updateLimit": "int"

Objetos ImageTemplateDistributor

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  "type": "ManagedImage",
  "imageId": "string",
  "location": "string"

Para SharedImage, use:

  "type": "SharedImage",
  "excludeFromLatest": "bool",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "storageAccountType": "string"

Para VHD, use:

  "type": "VHD"

Objetos ImageTemplateSource

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  "type": "ManagedImage",
  "imageId": "string"

Para PlatformImage, use:

  "type": "PlatformImage",
  "offer": "string",
  "planInfo": {
    "planName": "string",
    "planProduct": "string",
    "planPublisher": "string"
  },
  "publisher": "string",
  "sku": "string",
  "version": "string"

Para SharedImageVersion, use:

  "type": "SharedImageVersion",
  "imageVersionId": "string"

Valores de propiedad

imageTemplates

Nombre Descripción Valor
tipo El tipo de recurso 'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion La versión de la API de recursos '2021-10-01'
nombre El nombre del recurso string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
identidad Identidad de la plantilla de imagen, si está configurada. ImageTemplateIdentity (obligatorio)
Propiedades Las propiedades de la plantilla de imagen ImageTemplateProperties

ImageTemplateIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen. 'Ninguno'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas a la plantilla de imagen. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ImageTemplateProperties

Nombre Descripción Valor
buildTimeoutInMinutes Duración máxima para esperar durante la creación de la plantilla de imagen. Omita o especifique 0 para usar el valor predeterminado (4 horas). Int

Restricciones:
Valor mínimo = 0
Valor máximo = 960
Personalizar Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc. ImageTemplateCustomizer []
distribuir Los destinos de distribución a los que debe ir la salida de la imagen. ImageTemplateDistributor[] (obligatorio)
fuente Especifica las propiedades usadas para describir la imagen de origen. ImageTemplateSource (obligatorio)
vmProfile Describe cómo se configura la máquina virtual para compilar imágenes ImageTemplateVmProfile

ImageTemplateCustomizer

Nombre Descripción Valor
nombre Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización cuerda
tipo Establecimiento del tipo de objeto archivo de
powerShell
 de shell de
WindowsRestart
WindowsUpdate (obligatorio)

ImageTemplateFileCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'File' (obligatorio)
destino Ruta de acceso absoluta a un archivo (con estructuras de directorio anidadas ya creadas) donde el archivo (desde sourceUri) se cargará en en la máquina virtual. cuerda
sha256Checksum Suma de comprobación SHA256 del archivo proporcionado en el campo sourceUri anterior cuerda
sourceUri Identificador URI del archivo que se va a cargar para personalizar la máquina virtual. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda

ImageTemplatePowerShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'PowerShell' (obligatorio)
Inline Matriz de comandos de PowerShell que se van a ejecutar string[]
runAsSystem Si se especifica, el script de PowerShell se ejecutará con privilegios elevados mediante el usuario del sistema local. Solo puede ser true cuando el campo runElevated anterior está establecido en true. Bool
runElevated Si se especifica, el script de PowerShell se ejecutará con privilegios elevados. Bool
scriptUri URI del script de PowerShell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de Power Shell proporcionado en el campo scriptUri anterior cuerda
validExitCodes Códigos de salida válidos para el script de PowerShell. [Valor predeterminado: 0] int[]

ImageTemplateShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'Shell' (obligatorio)
Inline Matriz de comandos de shell que se van a ejecutar string[]
scriptUri URI del script de shell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de shell proporcionado en el campo scriptUri cuerda

ImageTemplateRestartCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'WindowsRestart' (obligatorio)
restartCheckCommand Comando para comprobar si el reinicio se realizó correctamente [Valor predeterminado: ''] cuerda
restartCommand Comando para ejecutar el reinicio [Valor predeterminado: 'shutdown /r /f /t 0 /c "packer restart"'] cuerda
restartTimeout Tiempo de espera de reinicio especificado como una cadena de magnitud y unidad, por ejemplo, '5m' (5 minutos) o '2h' (2 horas) [Valor predeterminado: '5m'] cuerda

ImageTemplateWindowsUpdateCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. 'WindowsUpdate' (obligatorio)
filtros Matriz de filtros para seleccionar las actualizaciones que se van a aplicar. Omita o especifique una matriz vacía para usar el valor predeterminado (sin filtro). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. string[]
searchCriteria Criterios para buscar actualizaciones. Omita o especifique una cadena vacía para usar el valor predeterminado (buscar todo). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. cuerda
updateLimit Número máximo de actualizaciones que se aplicarán a la vez. Omitir o especificar 0 para usar el valor predeterminado (1000) Int

Restricciones:
Valor mínimo = 0

ImageTemplateDistributor

Nombre Descripción Valor
artifactTags Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado. objeto
runOutputName Nombre que se va a usar para el RunOutput asociado. string (obligatorio)

Restricciones:
Patrón = ^[A-Za-z0-9-_.]{1,64}$
tipo Establecimiento del tipo de objeto ManagedImage
SharedImage
VHD (obligatorio)

ImageTemplateManagedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'ManagedImage' (obligatorio)
imageId Identificador de recurso de la imagen de disco administrado string (obligatorio)
ubicación La ubicación de Azure de la imagen debe coincidir si la imagen ya existe string (obligatorio)

ImageTemplateSharedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'SharedImage' (obligatorio)
excludeFromLatest Marca que indica si la versión de la imagen creada debe excluirse de la versión más reciente. Omitir para usar el valor predeterminado (false). Bool
galleryImageId Identificador de recurso de la imagen de Shared Image Gallery string (obligatorio)
replicationRegions Lista de regiones en las que se replicará la imagen string[] (obligatorio)
storageAccountType Tipo de cuenta de almacenamiento que se usará para almacenar la imagen compartida. Omita usar el valor predeterminado (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Nombre Descripción Valor
tipo Tipo de distribución. 'VHD' (obligatorio)

ImageTemplateSource

Nombre Descripción Valor
tipo Establecimiento del tipo de objeto ManagedImage
PlatformImage
sharedImageVersion (obligatorio)

ImageTemplateManagedImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'ManagedImage' (obligatorio)
imageId Identificador de recurso de ARM de la imagen administrada en la suscripción de cliente string (obligatorio)

ImageTemplatePlatformImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'PlatformImage' (obligatorio)
ofrecer Oferta de imagen de la Imágenes de la Galería de Azure. cuerda
planInfo Configuración opcional del plan de compra para la imagen de plataforma. PlatformImagePurchasePlan
editor Image Publisher en Imágenes de la Galería de Azure. cuerda
Sku SKU de imagen de la Imágenes de la Galería de Azure. cuerda
Versión Versión de imagen de la Imágenes de La galería de Azure. Si se especifica 'latest' aquí, la versión se evalúa cuando tiene lugar la compilación de la imagen, no cuando se envía la plantilla. cuerda

PlatformImagePurchasePlan

Nombre Descripción Valor
planName Nombre del plan de compra. string (obligatorio)
planProduct Producto del plan de compra. string (obligatorio)
planPublisher Publicador del plan de compra. string (obligatorio)

ImageTemplateSharedImageVersionSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. 'SharedImageVersion' (obligatorio)
imageVersionId Identificador de recurso de ARM de la versión de la imagen en la galería de imágenes compartidas string (obligatorio)

ImageTemplateVmProfile

Nombre Descripción Valor
osDiskSizeGB Tamaño del disco del sistema operativo en GB. Omita o especifique 0 para usar el tamaño de disco del sistema operativo predeterminado de Azure. Int

Restricciones:
Valor mínimo = 0
userAssignedIdentities Matriz opcional de identificadores de recursos de identidades administradas asignadas por el usuario que se van a configurar en la máquina virtual de compilación. Esto puede incluir la identidad de la plantilla de imagen. string[]
vmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D2ds_v4). cuerda
vnetConfig Configuración opcional de la red virtual que se va a usar para implementar la máquina virtual de compilación en. Omita si no es necesario usar ninguna red virtual específica. virtualNetworkConfig

VirtualNetworkConfig

Nombre Descripción Valor
proxyVmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D1_v2 para imágenes gen1 y Standard_D2ds_v4 para imágenes de Gen2). cuerda
subnetId Identificador de recurso de una subred existente previamente. cuerda

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Azure Image Builder con azure Windows Baseline

Implementación en Azure 		Crea un entorno de Azure Image Builder y crea una imagen de Windows Server con las actualizaciones más recientes de Windows y la línea de base de Windows de Azure aplicadas.
configuración del servicio Dev Box

Implementación en Azure 		Esta plantilla crearía todos los recursos de administración de Dev Box según la guía de inicio rápido de Dev Box (https://learn.microsoft.com/azure/dev-box/quickstart-create-dev-box). Puede ver todos los recursos creados o ir directamente a DevPortal.microsoft.com para crear su primer cuadro de desarrollo.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso imageTemplates se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.VirtualMachineImages/imageTemplates, agregue el siguiente Terraform a la plantilla.

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

Establezca el tipo propiedad para especificar el tipo de objeto.

Para archivo, use:

  type = "File"
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"

Para powerShell, use:

  type = "PowerShell"
  inline = [
    "string"
  ]
  runAsSystem = bool
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  validExitCodes = [
    int
  ]

Para shell, use:

  type = "Shell"
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"

Para WindowsRestart, use:

  type = "WindowsRestart"
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"

Para WindowsUpdate, use:

  type = "WindowsUpdate"
  filters = [
    "string"
  ]
  searchCriteria = "string"
  updateLimit = int

Objetos ImageTemplateDistributor

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  type = "ManagedImage"
  imageId = "string"
  location = "string"

Para SharedImage, use:

  type = "SharedImage"
  excludeFromLatest = bool
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  storageAccountType = "string"

Para VHD, use:

  type = "VHD"

Objetos ImageTemplateSource

Establezca el tipo propiedad para especificar el tipo de objeto.

Para ManagedImage, use:

  type = "ManagedImage"
  imageId = "string"

Para PlatformImage, use:

  type = "PlatformImage"
  offer = "string"
  planInfo = {
    planName = "string"
    planProduct = "string"
    planPublisher = "string"
  }
  publisher = "string"
  sku = "string"
  version = "string"

Para SharedImageVersion, use:

  type = "SharedImageVersion"
  imageVersionId = "string"

Valores de propiedad

imageTemplates

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.VirtualMachineImages/imageTemplates@2021-10-01"
nombre El nombre del recurso string (obligatorio)
ubicación Ubicación geográfica donde reside el recurso string (obligatorio)
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
Etiquetas Etiquetas de recursos. Diccionario de nombres y valores de etiqueta.
identidad Identidad de la plantilla de imagen, si está configurada. ImageTemplateIdentity (obligatorio)
Propiedades Las propiedades de la plantilla de imagen ImageTemplateProperties

ImageTemplateIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen. "UserAssigned"
identity_ids Lista de identidades de usuario asociadas a la plantilla de imagen. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de identificadores de identidad de usuario.

ImageTemplateIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

ImageTemplateProperties

Nombre Descripción Valor
buildTimeoutInMinutes Duración máxima para esperar durante la creación de la plantilla de imagen. Omita o especifique 0 para usar el valor predeterminado (4 horas). Int

Restricciones:
Valor mínimo = 0
Valor máximo = 960
Personalizar Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc. ImageTemplateCustomizer []
distribuir Los destinos de distribución a los que debe ir la salida de la imagen. ImageTemplateDistributor[] (obligatorio)
fuente Especifica las propiedades usadas para describir la imagen de origen. ImageTemplateSource (obligatorio)
vmProfile Describe cómo se configura la máquina virtual para compilar imágenes ImageTemplateVmProfile

ImageTemplateCustomizer

Nombre Descripción Valor
nombre Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización cuerda
tipo Establecimiento del tipo de objeto archivo de
powerShell
 de shell de
WindowsRestart
WindowsUpdate (obligatorio)

ImageTemplateFileCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. "Archivo" (obligatorio)
destino Ruta de acceso absoluta a un archivo (con estructuras de directorio anidadas ya creadas) donde el archivo (desde sourceUri) se cargará en en la máquina virtual. cuerda
sha256Checksum Suma de comprobación SHA256 del archivo proporcionado en el campo sourceUri anterior cuerda
sourceUri Identificador URI del archivo que se va a cargar para personalizar la máquina virtual. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda

ImageTemplatePowerShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. "PowerShell" (obligatorio)
Inline Matriz de comandos de PowerShell que se van a ejecutar string[]
runAsSystem Si se especifica, el script de PowerShell se ejecutará con privilegios elevados mediante el usuario del sistema local. Solo puede ser true cuando el campo runElevated anterior está establecido en true. Bool
runElevated Si se especifica, el script de PowerShell se ejecutará con privilegios elevados. Bool
scriptUri URI del script de PowerShell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de Power Shell proporcionado en el campo scriptUri anterior cuerda
validExitCodes Códigos de salida válidos para el script de PowerShell. [Valor predeterminado: 0] int[]

ImageTemplateShellCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. "Shell" (obligatorio)
Inline Matriz de comandos de shell que se van a ejecutar string[]
scriptUri URI del script de shell que se va a ejecutar para personalizar. Puede ser un vínculo de GitHub, un URI de SAS para Azure Storage, etc. cuerda
sha256Checksum Suma de comprobación SHA256 del script de shell proporcionado en el campo scriptUri cuerda

ImageTemplateRestartCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. "WindowsRestart" (obligatorio)
restartCheckCommand Comando para comprobar si el reinicio se realizó correctamente [Valor predeterminado: ''] cuerda
restartCommand Comando para ejecutar el reinicio [Valor predeterminado: 'shutdown /r /f /t 0 /c "packer restart"'] cuerda
restartTimeout Tiempo de espera de reinicio especificado como una cadena de magnitud y unidad, por ejemplo, '5m' (5 minutos) o '2h' (2 horas) [Valor predeterminado: '5m'] cuerda

ImageTemplateWindowsUpdateCustomizer

Nombre Descripción Valor
tipo Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell. "WindowsUpdate" (obligatorio)
filtros Matriz de filtros para seleccionar las actualizaciones que se van a aplicar. Omita o especifique una matriz vacía para usar el valor predeterminado (sin filtro). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. string[]
searchCriteria Criterios para buscar actualizaciones. Omita o especifique una cadena vacía para usar el valor predeterminado (buscar todo). Consulte el vínculo anterior para obtener ejemplos y una descripción detallada de este campo. cuerda
updateLimit Número máximo de actualizaciones que se aplicarán a la vez. Omitir o especificar 0 para usar el valor predeterminado (1000) Int

Restricciones:
Valor mínimo = 0

ImageTemplateDistributor

Nombre Descripción Valor
artifactTags Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado. objeto
runOutputName Nombre que se va a usar para el RunOutput asociado. string (obligatorio)

Restricciones:
Patrón = ^[A-Za-z0-9-_.]{1,64}$
tipo Establecimiento del tipo de objeto ManagedImage
SharedImage
VHD (obligatorio)

ImageTemplateManagedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. "ManagedImage" (obligatorio)
imageId Identificador de recurso de la imagen de disco administrado string (obligatorio)
ubicación La ubicación de Azure de la imagen debe coincidir si la imagen ya existe string (obligatorio)

ImageTemplateSharedImageDistributor

Nombre Descripción Valor
tipo Tipo de distribución. "SharedImage" (obligatorio)
excludeFromLatest Marca que indica si la versión de la imagen creada debe excluirse de la versión más reciente. Omitir para usar el valor predeterminado (false). Bool
galleryImageId Identificador de recurso de la imagen de Shared Image Gallery string (obligatorio)
replicationRegions Lista de regiones en las que se replicará la imagen string[] (obligatorio)
storageAccountType Tipo de cuenta de almacenamiento que se usará para almacenar la imagen compartida. Omita usar el valor predeterminado (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Nombre Descripción Valor
tipo Tipo de distribución. "VHD" (obligatorio)

ImageTemplateSource

Nombre Descripción Valor
tipo Establecimiento del tipo de objeto ManagedImage
PlatformImage
sharedImageVersion (obligatorio)

ImageTemplateManagedImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. "ManagedImage" (obligatorio)
imageId Identificador de recurso de ARM de la imagen administrada en la suscripción de cliente string (obligatorio)

ImageTemplatePlatformImageSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. "PlatformImage" (obligatorio)
ofrecer Oferta de imagen de la Imágenes de la Galería de Azure. cuerda
planInfo Configuración opcional del plan de compra para la imagen de plataforma. PlatformImagePurchasePlan
editor Image Publisher en Imágenes de la Galería de Azure. cuerda
Sku SKU de imagen de la Imágenes de la Galería de Azure. cuerda
Versión Versión de imagen de la Imágenes de La galería de Azure. Si se especifica 'latest' aquí, la versión se evalúa cuando tiene lugar la compilación de la imagen, no cuando se envía la plantilla. cuerda

PlatformImagePurchasePlan

Nombre Descripción Valor
planName Nombre del plan de compra. string (obligatorio)
planProduct Producto del plan de compra. string (obligatorio)
planPublisher Publicador del plan de compra. string (obligatorio)

ImageTemplateSharedImageVersionSource

Nombre Descripción Valor
tipo Especifica el tipo de imagen de origen con el que desea empezar. "SharedImageVersion" (obligatorio)
imageVersionId Identificador de recurso de ARM de la versión de la imagen en la galería de imágenes compartidas string (obligatorio)

ImageTemplateVmProfile

Nombre Descripción Valor
osDiskSizeGB Tamaño del disco del sistema operativo en GB. Omita o especifique 0 para usar el tamaño de disco del sistema operativo predeterminado de Azure. Int

Restricciones:
Valor mínimo = 0
userAssignedIdentities Matriz opcional de identificadores de recursos de identidades administradas asignadas por el usuario que se van a configurar en la máquina virtual de compilación. Esto puede incluir la identidad de la plantilla de imagen. string[]
vmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D2ds_v4). cuerda
vnetConfig Configuración opcional de la red virtual que se va a usar para implementar la máquina virtual de compilación en. Omita si no es necesario usar ninguna red virtual específica. virtualNetworkConfig

VirtualNetworkConfig

Nombre Descripción Valor
proxyVmSize Tamaño de la máquina virtual que se usa para compilar, personalizar y capturar imágenes. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_D1_v2 para imágenes gen1 y Standard_D2ds_v4 para imágenes de Gen2). cuerda
subnetId Identificador de recurso de una subred existente previamente. cuerda