Virtual Machine Image Templates - Get

Servicio:: Image Builder

Versión de la API:: 2022-07-01

Obtención de información sobre una plantilla de imagen 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 identificador URI

Nombre	En	Requerido	Tipo	Description
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nombre de la plantilla de imagen
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	ImageTemplate	De acuerdo
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Retrieve an Image Template.

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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
    }
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio Azure VM Image Builder.
CloudErrorBody	Respuesta de error del servicio Azure VM Image Builder.
createdByType	Tipo de identidad que creó el recurso.
DistributeVersionerLatest	Genera el número de versión más reciente en función de los números de versión existentes.
DistributeVersionerSource	Genera un número de versión basado en el número de versión de la imagen de origen.
ImageTemplate	La plantilla de imagen es un recurso de ARM administrado por el proveedor Microsoft.VirtualMachineImages.
ImageTemplateFileCustomizer	Carga archivos en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer.
ImageTemplateFileValidator	Carga los archivos necesarios para la validación en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer.
ImageTemplateIdentity	Identidad de la plantilla de imagen.
ImageTemplateLastRunStatus	Describe el estado más reciente de ejecutar una plantilla de imagen.
ImageTemplateManagedImageDistributor	Distribuir como una imagen de disco administrado.
ImageTemplateManagedImageSource	Describe un origen de imagen que es una imagen administrada en la suscripción del cliente. Esta imagen debe residir en la misma suscripción y región que la plantilla de Image Builder.
ImageTemplatePlatformImageSource	Describe un origen de imagen de Imágenes de la Galería de Azure.
ImageTemplatePowerShellCustomizer	Ejecuta powerShell especificado en la máquina virtual (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".
ImageTemplatePowerShellValidator	Ejecuta el script de PowerShell especificado durante la fase de validación (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".
ImageTemplateRestartCustomizer	Reinicia una máquina virtual y espera a que vuelva a estar en línea (Windows). Corresponde al aprovisionamiento de reinicio de Windows Packer.
ImageTemplateSharedImageDistributor	Distribuir a través de Azure Compute Gallery.
ImageTemplateSharedImageVersionSource	Describe un origen de imagen que es una versión de imagen en una instancia de Azure Compute Gallery o una galería compartida directa.
ImageTemplateShellCustomizer	Ejecuta un script de shell durante la fase de personalización (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".
ImageTemplateShellValidator	Ejecuta el script de shell especificado durante la fase de validación (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".
ImageTemplateVhdDistributor	Distribuir a través de VHD en una cuenta de almacenamiento.
ImageTemplateVmProfile	Describe las máquinas virtuales que se usan para compilar y validar imágenes.
ImageTemplateWindowsUpdateCustomizer	Instala actualizaciones de Windows. Corresponde al aprovisionamiento de Windows Update packer (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Especifica la optimización que se va a realizar en la imagen.
PlatformImagePurchasePlan	Configuración del plan de compra para la imagen de plataforma.
ProvisioningError	Describe el error que se produjo al crear o actualizar una plantilla de imagen
ProvisioningErrorCode	Código de error del error de aprovisionamiento
ProvisioningState	Estado de aprovisionamiento del recurso
ResourceIdentityType	Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen.
RunState	Estado de la última ejecución
RunSubState	Subes state of the last run (Subes state of the last run)
SharedImageStorageAccountType	Especifica el tipo de cuenta de almacenamiento en el que se va a usar para almacenar la versión de la imagen de Azure Compute Gallery.
systemData	Metadatos relativos a la creación y última modificación del recurso.
TargetRegion	Describe la información de la región de destino.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
Validate	Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante.
VirtualNetworkConfig	Configuración de red virtual.
VmBoot	La optimización se aplica en la imagen para un arranque de máquina virtual más rápido.
VMBootOptimizationState	La habilitación de este campo mejorará el tiempo de arranque de la máquina virtual mediante la optimización de la salida final de la imagen personalizada.

CloudError

Object

Respuesta de error del servicio Azure VM Image Builder.

Nombre	Tipo	Description
error	CloudErrorBody	Detalles sobre el error.

CloudErrorBody

Object

Respuesta de error del servicio Azure VM Image Builder.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Object

Genera el número de versión más reciente en función de los números de versión existentes.

Nombre	Tipo	Valor predeterminado	Description
major	integer (int32) minimum: -1	-1	Versión principal del número de versión generado. Determine qué es "latest" en función de las versiones con este valor como la versión principal. -1 es equivalente a dejar sin establecer.
scheme	string: Latest		Esquema de numeración de versión que se va a usar.

DistributeVersionerSource

Object

Genera un número de versión basado en el número de versión de la imagen de origen.

Nombre	Tipo	Description
scheme	string: Source	Esquema de numeración de versión que se va a usar.

ImageTemplate

Object

La plantilla de imagen es un recurso de ARM administrado por el proveedor Microsoft.VirtualMachineImages.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Identidad de la plantilla de imagen, si está configurada.
location	string		Ubicación geográfica donde reside el recurso
name	string		Nombre del recurso
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Duración máxima para esperar al compilar la plantilla de imagen (incluye todas las personalizaciones, optimización, validaciones y distribuciones). Omita o especifique 0 para usar el valor predeterminado (4 horas).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Especifica las propiedades usadas para describir los pasos de personalización de la imagen, como el origen de la imagen, etc.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Los destinos de distribución a los que debe ir la salida de la imagen.
properties.exactStagingResourceGroup	string		Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Este campo de solo lectura difiere de "stagingResourceGroup" solo si el valor especificado en el campo "stagingResourceGroup" está vacío.
properties.lastRunStatus	ImageTemplateLastRunStatus		Estado de "run" que se está ejecutando actualmente o que se ejecutó por última vez.
properties.optimize	Optimize		Especifica la optimización que se va a realizar en la imagen.
properties.provisioningError	ProvisioningError		Error de aprovisionamiento, si existe
properties.provisioningState	ProvisioningState		Estado de aprovisionamiento del recurso
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Especifica las propiedades usadas para describir la imagen de origen.
properties.stagingResourceGroup	string		Identificador del grupo de recursos de almacenamiento provisional en la misma suscripción que la plantilla de imagen que se usará para compilar la imagen. Si este campo está vacío, se creará un grupo de recursos con un nombre aleatorio. Si el grupo de recursos especificado en este campo no existe, se creará con el mismo nombre. Si el grupo de recursos especificado existe, debe estar vacío y en la misma región que la plantilla de imagen. El grupo de recursos creado se eliminará durante la eliminación de la plantilla si este campo está vacío o el grupo de recursos especificado no existe, pero si el grupo de recursos especificado existe los recursos creados en el grupo de recursos se eliminarán durante la eliminación de la plantilla y el propio grupo de recursos permanecerá.
properties.validate	Validate		Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante.
properties.vmProfile	ImageTemplateVmProfile		Describe cómo se configura la máquina virtual para compilar imágenes
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object		Etiquetas de recursos.
type	string		Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Object

Carga archivos en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer.

Nombre	Tipo	Description
destination	string	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.
name	string	Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización
sha256Checksum	string	Suma de comprobación SHA256 del archivo proporcionado en el campo sourceUri anterior
sourceUri	string	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.
type	string: File	Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell.

ImageTemplateFileValidator

Object

Carga los archivos necesarios para la validación en máquinas virtuales (Linux, Windows). Corresponde al aprovisionamiento de archivos Packer.

Nombre	Tipo	Description
destination	string	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.
name	string	Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de validación
sha256Checksum	string	Suma de comprobación SHA256 del archivo proporcionado en el campo sourceUri anterior
sourceUri	string	URI del archivo que se va a cargar en la máquina virtual para la validación. Puede ser un vínculo de GitHub, un URI de Azure Storage (autorizado o SAS), etc.
type	string: File	Tipo de validación que desea usar en la imagen. Por ejemplo, "Shell" puede ser validación del shell.

ImageTemplateIdentity

Object

Identidad de la plantilla de imagen.

Nombre	Tipo	Description
type	ResourceIdentityType	Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen.
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ImageTemplateLastRunStatus

Object

Describe el estado más reciente de ejecutar una plantilla de imagen.

Nombre	Tipo	Description
endTime	string (date-time)	Hora de finalización de la última ejecución (UTC)
message	string	Información detallada sobre el último estado de ejecución
runState	RunState	Estado de la última ejecución
runSubState	RunSubState	Subes state of the last run (Subes state of the last run)
startTime	string (date-time)	Hora de inicio de la última ejecución (UTC)

ImageTemplateManagedImageDistributor

Object

Distribuir como una imagen de disco administrado.

Nombre	Tipo	Description
artifactTags	object	Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado.
imageId	string	Identificador de recurso de la imagen de disco administrado
location	string	La ubicación de Azure de la imagen debe coincidir si la imagen ya existe
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nombre que se va a usar para el RunOutput asociado.
type	string: ManagedImage	Tipo de distribución.

ImageTemplateManagedImageSource

Object

Describe un origen de imagen que es una imagen administrada en la suscripción del cliente. Esta imagen debe residir en la misma suscripción y región que la plantilla de Image Builder.

Nombre	Tipo	Description
imageId	string	Identificador de recurso de ARM de la imagen administrada en la suscripción de cliente
type	string: ManagedImage	Especifica el tipo de imagen de origen con el que desea empezar.

ImageTemplatePlatformImageSource

Object

Describe un origen de imagen de Imágenes de la Galería de Azure.

Nombre	Tipo	Description
exactVersion	string	Versión de imagen de la Imágenes de La galería de Azure. Este campo de solo lectura difiere de "version", solo si el valor especificado en el campo "version" es "latest".
offer	string	Oferta de imagen de la Imágenes de la Galería de Azure.
planInfo	PlatformImagePurchasePlan	Configuración opcional del plan de compra para la imagen de plataforma.
publisher	string	Image Publisher en Imágenes de la Galería de Azure.
sku	string	SKU de imagen de la Imágenes de la Galería de Azure.
type	string: PlatformImage	Especifica el tipo de imagen de origen con el que desea empezar.
version	string	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.

ImageTemplatePowerShellCustomizer

Object

Ejecuta powerShell especificado en la máquina virtual (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".

Nombre	Tipo	Valor predeterminado	Description
inline	string[]		Matriz de comandos de PowerShell que se van a ejecutar
name	string		Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización
runAsSystem	boolean	False	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.
runElevated	boolean	False	Si se especifica, el script de PowerShell se ejecutará con privilegios elevados.
scriptUri	string		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.
sha256Checksum	string		Suma de comprobación SHA256 del script de Power Shell proporcionado en el campo scriptUri anterior
type	string: PowerShell		Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell.
validExitCodes	integer[] (int32)		Códigos de salida válidos para el script de PowerShell. [Valor predeterminado: 0]

ImageTemplatePowerShellValidator

Object

Ejecuta el script de PowerShell especificado durante la fase de validación (Windows). Corresponde al aprovisionamiento de PowerShell packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".

Nombre	Tipo	Valor predeterminado	Description
inline	string[]		Matriz de comandos de PowerShell que se van a ejecutar
name	string		Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de validación
runAsSystem	boolean	False	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.
runElevated	boolean	False	Si se especifica, el script de PowerShell se ejecutará con privilegios elevados.
scriptUri	string		URI del script de PowerShell que se va a ejecutar para la validación. Puede ser un vínculo de GitHub, un URI de Azure Storage, etc.
sha256Checksum	string		Suma de comprobación SHA256 del script de Power Shell proporcionado en el campo scriptUri anterior
type	string: PowerShell		Tipo de validación que desea usar en la imagen. Por ejemplo, "Shell" puede ser validación del shell.
validExitCodes	integer[] (int32)		Códigos de salida válidos para el script de PowerShell. [Valor predeterminado: 0]

ImageTemplateRestartCustomizer

Object

Reinicia una máquina virtual y espera a que vuelva a estar en línea (Windows). Corresponde al aprovisionamiento de reinicio de Windows Packer.

Nombre	Tipo	Description
name	string	Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización
restartCheckCommand	string	Comando para comprobar si el reinicio se realizó correctamente [Valor predeterminado: '']
restartCommand	string	Comando para ejecutar el reinicio [Valor predeterminado: 'shutdown /r /f /t 0 /c "packer restart"']
restartTimeout	string	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']
type	string: WindowsRestart	Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell.

ImageTemplateSharedImageDistributor

Object

Distribuir a través de Azure Compute Gallery.

Nombre	Tipo	Valor predeterminado	Description
artifactTags	object		Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado.
excludeFromLatest	boolean	False	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).
galleryImageId	string		Identificador de recurso de la imagen de Azure Compute Gallery
replicationRegions	string[]		[En desuso] Lista de regiones en las que se replicará la imagen. Esta lista solo se puede especificar si no se especifica targetRegions. Este campo está en desuso: use targetRegions en su lugar.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Nombre que se va a usar para el RunOutput asociado.
storageAccountType	SharedImageStorageAccountType		[En desuso] Tipo de cuenta de almacenamiento que se usará para almacenar la imagen compartida. Omita usar el valor predeterminado (Standard_LRS). Este campo solo se puede especificar si se especifica replicationRegions. Este campo está en desuso: use targetRegions en su lugar.
targetRegions	TargetRegion[]		Las regiones de destino en las que se va a replicar la versión de imagen distribuida. Este objeto reemplaza replicationRegions y solo se puede especificar si no se especifica replicationRegions.
type	string: SharedImage		Tipo de distribución.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Describe cómo generar un nuevo número de versión x.y.z para la distribución.

ImageTemplateSharedImageVersionSource

Object

Describe un origen de imagen que es una versión de imagen en una instancia de Azure Compute Gallery o una galería compartida directa.

Nombre	Tipo	Description
exactVersion	string	Identificador exacto del recurso arm de la versión de la imagen. Este campo de solo lectura difiere del identificador de versión de la imagen en "imageVersionId" solo si el nombre de versión especificado en el campo "imageVersionId" es "latest".
imageVersionId	string	Identificador de recurso de ARM de la versión de la imagen. Cuando el nombre de la versión de la imagen es "latest", la versión se evalúa cuando se realiza la compilación de la imagen.
type	string: SharedImageVersion	Especifica el tipo de imagen de origen con el que desea empezar.

ImageTemplateShellCustomizer

Object

Ejecuta un script de shell durante la fase de personalización (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".

Nombre	Tipo	Description
inline	string[]	Matriz de comandos de shell que se van a ejecutar
name	string	Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización
scriptUri	string	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.
sha256Checksum	string	Suma de comprobación SHA256 del script de shell proporcionado en el campo scriptUri
type	string: Shell	Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell.

ImageTemplateShellValidator

Object

Ejecuta el script de shell especificado durante la fase de validación (Linux). Corresponde al aprovisionamiento de shell de Packer. Se puede especificar exactamente uno de "scriptUri" o "insertado".

Nombre	Tipo	Description
inline	string[]	Matriz de comandos de shell que se van a ejecutar
name	string	Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de validación
scriptUri	string	URI del script de shell que se va a ejecutar para la validación. Puede ser un vínculo de GitHub, un URI de Azure Storage, etc.
sha256Checksum	string	Suma de comprobación SHA256 del script de shell proporcionado en el campo scriptUri
type	string: Shell	Tipo de validación que desea usar en la imagen. Por ejemplo, "Shell" puede ser validación del shell.

ImageTemplateVhdDistributor

Object

Distribuir a través de VHD en una cuenta de almacenamiento.

Nombre	Tipo	Description
artifactTags	object	Etiquetas que se aplicarán al artefacto una vez que el distribuidor haya creado o actualizado.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nombre que se va a usar para el RunOutput asociado.
type	string: VHD	Tipo de distribución.
uri	string	URI opcional de Azure Storage para el blob de disco duro virtual distribuido. Omita usar el valor predeterminado (cadena vacía) en cuyo caso el disco duro virtual se publicaría en la cuenta de almacenamiento del grupo de recursos de almacenamiento provisional.

ImageTemplateVmProfile

Object

Describe las máquinas virtuales que se usan para compilar y validar imágenes.

Nombre	Tipo	Valor predeterminado	Description
osDiskSizeGB	integer (int32) minimum: 0	0	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.
userAssignedIdentities	string[]		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 y la máquina virtual de validación. Esto puede incluir la identidad de la plantilla de imagen.
vmSize	string		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).
vnetConfig	VirtualNetworkConfig		Configuración opcional de la red virtual que se va a usar para implementar la máquina virtual de compilación y la máquina virtual de validación en. Omita si no es necesario usar ninguna red virtual específica.

ImageTemplateWindowsUpdateCustomizer

Object

Instala actualizaciones de Windows. Corresponde al aprovisionamiento de Windows Update packer (https://github.com/rgl/packer-provisioner-windows-update)

Nombre	Tipo	Valor predeterminado	Description
filters	string[]		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.
name	string		Nombre descriptivo para proporcionar contexto sobre lo que hace este paso de personalización
searchCriteria	string		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.
type	string: WindowsUpdate		Tipo de herramienta de personalización que desea usar en la imagen. Por ejemplo, "Shell" puede ser personalizador de shell.
updateLimit	integer (int32) minimum: 0	0	Número máximo de actualizaciones que se aplicarán a la vez. Omitir o especificar 0 para usar el valor predeterminado (1000)

Optimize

Object

Especifica la optimización que se va a realizar en la imagen.

Nombre	Tipo	Description
vmBoot	VmBoot	La optimización se aplica en la imagen para un arranque de máquina virtual más rápido.

PlatformImagePurchasePlan

Object

Configuración del plan de compra para la imagen de plataforma.

Nombre	Tipo	Description
planName	string	Nombre del plan de compra.
planProduct	string	Producto del plan de compra.
planPublisher	string	Publicador del plan de compra.

ProvisioningError

Object

Describe el error que se produjo al crear o actualizar una plantilla de imagen

Nombre	Tipo	Description
message	string	Mensaje de error detallado sobre el error de aprovisionamiento
provisioningErrorCode	ProvisioningErrorCode	Código de error del error de aprovisionamiento

ProvisioningErrorCode

Enumeración

Código de error del error de aprovisionamiento

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

ProvisioningState

Enumeración

Estado de aprovisionamiento del recurso

Valor	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Enumeración

Tipo de identidad que se usa para la plantilla de imagen. El tipo "None" quitará las identidades de la plantilla de imagen.

Valor	Description
UserAssigned
None

RunState

Enumeración

Estado de la última ejecución

Valor	Description
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Enumeración

Subes state of the last run (Subes state of the last run)

Valor	Description
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Enumeración

Especifica el tipo de cuenta de almacenamiento en el que se va a usar para almacenar la versión de la imagen de Azure Compute Gallery.

Valor	Description
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TargetRegion

Object

Describe la información de la región de destino.

Nombre	Tipo	Valor predeterminado	Description
name	string		Nombre de la región.
replicaCount	integer (int32) minimum: 1	1	Número de réplicas de la versión de imagen que se va a crear en esta región. Omitir para usar el valor predeterminado (1).
storageAccountType	SharedImageStorageAccountType		Especifica el tipo de cuenta de almacenamiento que se va a usar para almacenar la imagen en esta región. Omita usar el valor predeterminado (Standard_LRS).

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada.
principalId	string	Identificador de entidad de seguridad de la identidad asignada.

Validate

Object

Opciones de configuración y lista de validaciones que se van a realizar en la imagen resultante.

Nombre	Tipo	Valor predeterminado	Description
continueDistributeOnFailure	boolean	False	Si se produce un error en la validación y este campo se establece en false, las imágenes de salida no se distribuirán. Este es el comportamiento predeterminado. Si se produce un error en la validación y este campo se establece en true, las imágenes de salida se seguirán distribuyendo. Use esta opción con precaución, ya que puede dar lugar a que se distribuyan imágenes incorrectas para su uso. En cualquier caso (true o false), la ejecución de la imagen de un extremo a otro se notificará como con errores en caso de error de validación. [Nota: Este campo no tiene ningún efecto si la validación se realiza correctamente].]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Lista de validaciones que se van a realizar.
sourceValidationOnly	boolean	False	Si este campo se establece en true, la imagen especificada en la sección "source" se validará directamente. No se ejecutará ninguna compilación independiente para generar y, a continuación, validar una imagen personalizada.

VirtualNetworkConfig

Object

Configuración de red virtual.

Nombre	Tipo	Description
proxyVmSize	string	Tamaño de la máquina virtual proxy que se usa para pasar tráfico a la máquina virtual de compilación y a la máquina virtual de validación. Omita o especifique una cadena vacía para usar el valor predeterminado (Standard_A1_v2).
subnetId	string	Identificador de recurso de una subred existente previamente.

VmBoot

Object

La optimización se aplica en la imagen para un arranque de máquina virtual más rápido.

Nombre	Tipo	Description
state	VMBootOptimizationState	La habilitación de este campo mejorará el tiempo de arranque de la máquina virtual mediante la optimización de la salida final de la imagen personalizada.

VMBootOptimizationState

Enumeración

La habilitación de este campo mejorará el tiempo de arranque de la máquina virtual mediante la optimización de la salida final de la imagen personalizada.

Valor	Description
Enabled
Disabled

Compartir a través de

Virtual Machine Image Templates - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Retrieve an Image Template.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

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