Image Microsoft.VirtualMachineImagesTemplates 2021-10-01

Article
07/20/2023

Définition de ressource Bicep

Le type de ressource imageTemplates peut être déployé sur :

Groupes de ressources - Voir commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le Bicep suivant à votre modèle.

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'
      }
    }
  }
}

Objets ImageTemplateCustomizer

Définissez la propriété type pour spécifier le type d’objet.

Pour Fichier, utilisez :

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

Pour PowerShell, utilisez :

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

Pour Shell, utilisez :

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

Pour WindowsRestart, utilisez :

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

Pour WindowsUpdate, utilisez :

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

Objets ImageTemplateDistributor

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

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

Pour SharedImage, utilisez :

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

Pour le disque dur virtuel, utilisez :

  type: 'VHD'

Objets ImageTemplateSource

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

  type: 'ManagedImage'
  imageId: 'string'

Pour PlatformImage, utilisez :

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

Pour SharedImageVersion, utilisez :

  type: 'SharedImageVersion'
  imageVersionId: 'string'

Valeurs de propriétés

imageTemplates

Nom	Description	Valeur
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement géographique où réside la ressource	chaîne (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
properties	Propriétés du modèle d’image	ImageTemplateProperties

ImageTemplateIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.	'None' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées au modèle d’image. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	object

ImageTemplateProperties

Nom	Description	Valeur
buildTimeoutInMinutes	Durée maximale d’attente lors de la génération du modèle d’image. Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).	int
Personnalisation	Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source d’image, etc.	ImageTemplateCustomizer[]
distribuer	Cibles de distribution où la sortie de l’image doit aller.	ImageTemplateDistributor[] (obligatoire)
source	Spécifie les propriétés utilisées pour décrire l’image source.	ImageTemplateSource (obligatoire)
vmProfile	Décrit la configuration de la machine virtuelle pour générer des images	ImageTemplateVmProfile

ImageTemplateCustomizer

Nom	Description	Valeur
name	Nom convivial pour fournir un contexte sur l’action de cette étape de personnalisation	string
type	Définir le type d’objet	File PowerShell Shell WindowsRestart WindowsUpdate (obligatoire)

ImageTemplateFileCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'File' (obligatoire)
destination	Chemin absolu d’un fichier (avec des structures de répertoires imbriquées déjà créées) dans lequel le fichier (à partir de sourceUri) sera chargé dans la machine virtuelle	string
sha256Checksum	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus	string
sourceUri	URI du fichier à charger pour la personnalisation de la machine virtuelle. Il peut s’agir d’un lien github, d’UN URI SAS pour stockage Azure, etc.	string

ImageTemplatePowerShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'PowerShell' (obligatoire)
inline	Tableau de commandes PowerShell à exécuter	string[]
runAsSystem	S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur système local. Ne peut être true que lorsque le champ runElevated ci-dessus est défini sur true.	bool
runElevated	S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés	bool
scriptUri	URI du script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAS pour stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus	string
validExitCodes	Codes de sortie valides pour le script PowerShell. [Valeur par défaut : 0]	int[]

ImageTemplateShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'Shell' (obligatoire)
inline	Tableau de commandes de l’interpréteur de commandes à exécuter	string[]
scriptUri	URI du script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAS pour stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script d’interpréteur de commandes fourni dans le champ scriptUri	string

ImageTemplateRestartCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'WindowsRestart' (obligatoire)
restartCheckCommand	Commande à case activée si le redémarrage a réussi [Valeur par défaut : '']	string
restartCommand	Commande pour exécuter le redémarrage [Valeur par défaut : 'shutdown /r /f /t 0 /c « packer restart"']	string
restartTimeout	Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m »]	string

ImageTemplateWindowsUpdateCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'WindowsUpdate' (obligatoire)
filtres	Tableau de filtres à sélectionner les mises à jour à appliquer. Omettez ou spécifiez un tableau vide pour utiliser la valeur par défaut (aucun filtre). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string[]
searchCriteria	Critères pour rechercher les mises à jour. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (rechercher tout). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string
updateLimit	Nombre maximal de mises à jour à appliquer à la fois. Omettre ou spécifier 0 pour utiliser la valeur par défaut (1000)	int

ImageTemplateDistributor

Nom	Description	Valeur
artifactTags	Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.	object
runOutputName	Nom à utiliser pour le RunOutput associé.	chaîne (obligatoire)
type	Définir le type d’objet	ManagedImage SharedImage Disque dur virtuel (obligatoire)

ImageTemplateManagedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	'ManagedImage' (obligatoire)
imageId	ID de ressource de l’image de disque managé	chaîne (obligatoire)
location	L’emplacement Azure de l’image doit correspondre si l’image existe déjà	chaîne (obligatoire)

ImageTemplateSharedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	'SharedImage' (obligatoire)
excludeFromLatest	Indicateur qui indique si la version de l’image créée doit être exclue de la dernière version. Omettez d’utiliser la valeur par défaut (false).	bool
galleryImageId	ID de ressource de l’image Shared Image Gallery	chaîne (obligatoire)
replicationRegions	Liste des régions dans lesquelles l’image sera répliquée	string[] (obligatoire)
storageAccountType	Type de compte de stockage à utiliser pour stocker l’image partagée. Omettez d’utiliser la valeur par défaut (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'

ImageTemplateVhdDistributor

Nom	Description	Valeur
type	Type de distribution.	'VHD' (obligatoire)

ImageTemplateSource

Nom	Description	Valeur
type	Définir le type d’objet	ManagedImage PlatformImage SharedImageVersion (obligatoire)

ImageTemplateManagedImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source avec lequel vous souhaitez commencer.	'ManagedImage' (obligatoire)
imageId	ID de ressource ARM de l’image managée dans l’abonnement client	chaîne (obligatoire)

ImageTemplatePlatformImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source avec lequel vous souhaitez commencer.	'PlatformImage' (obligatoire)
offer	Offre d’images à partir d’Azure Gallery Images.	string
planInfo	Configuration facultative du plan d’achat pour l’image de plateforme.	PlatformImagePurchasePlan
publisher	Éditeur d’images dans Azure Gallery Images.	string
sku	Référence d’image à partir d’Azure Gallery Images.	string
version	Version de l’image à partir des images de la galerie Azure. Si « latest » est spécifié ici, la version est évaluée lors de la génération de l’image, et non lors de l’envoi du modèle.	string

PlatformImagePurchasePlan

Nom	Description	Valeur
planName	Nom du plan d’achat.	string (obligatoire)
planProduct	Produit du plan d’achat.	string (obligatoire)
planPublisher	Éditeur du plan d’achat.	string (obligatoire)

ImageTemplateSharedImageVersionSource

Nom	Description	Valeur
type	Spécifie le type d’image source que vous souhaitez commencer.	'SharedImageVersion' (obligatoire)
imageVersionId	ID de ressource ARM de la version de l’image dans la galerie d’images partagées	string (obligatoire)

ImageTemplateVmProfile

Nom	Description	Valeur
osDiskSizeGB	Taille du disque du système d’exploitation en Go. Omettez ou spécifiez 0 pour utiliser la taille de disque de système d’exploitation par défaut d’Azure.	int
userAssignedIdentities	Tableau facultatif d’ID de ressources d’identités managées affectées par l’utilisateur à configurer sur la machine virtuelle de build. Cela peut inclure l’identité du modèle d’image.	string[]
vmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_D2ds_v4).	string
vnetConfig	Configuration facultative du réseau virtuel à utiliser pour déployer la machine virtuelle de génération dans. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
proxyVmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez la chaîne vide pour utiliser la valeur par défaut (Standard_D1_v2 pour les images Gen1 et Standard_D2ds_v4 pour les images Gen2).	string
subnetId	ID de ressource d’un sous-réseau préexistant.	string

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Azure Image Builder avec base de référence Azure Windows	Crée un environnement Azure Image Builder et génère une image Windows Server avec la dernière version de Windows Mises à jour et la base de référence Azure Windows appliquées.
Configurer le service Dev Box	Ce modèle crée toutes les ressources d’administration Dev Box conformément au guide de démarrage rapide dev Box. Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première Dev Box.

Définition de ressources de modèle ARM

Le type de ressource imageTemplates peut être déployé sur :

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le code JSON suivant à votre modèle.

{
  "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"
      }
    }
  }
}

Objets ImageTemplateCustomizer

Définissez la propriété type pour spécifier le type d’objet.

Pour Fichier, utilisez :

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

Pour PowerShell, utilisez :

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

Pour Shell, utilisez :

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

Pour WindowsRestart, utilisez :

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

Pour WindowsUpdate, utilisez :

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

Objets ImageTemplateDistributor

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

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

Pour SharedImage, utilisez :

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

Pour le disque dur virtuel, utilisez :

  "type": "VHD"

Objets ImageTemplateSource

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

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

Pour PlatformImage, utilisez :

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

Pour SharedImageVersion, utilisez :

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

Valeurs de propriétés

imageTemplates

Nom	Description	Valeur
type	Type de ressource	'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion	Version de l’API de ressource	'2021-10-01'
name	Nom de la ressource	string (obligatoire)
location	Emplacement géographique où réside la ressource	string (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
properties	Propriétés du modèle d’image	ImageTemplateProperties

ImageTemplateIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.	'None' 'UserAssigned'
userAssignedIdentities	Liste des identités utilisateur associées au modèle d’image. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	object

ImageTemplateProperties

Nom	Description	Valeur
buildTimeoutInMinutes	Durée maximale d’attente lors de la génération du modèle d’image. Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).	int
Personnalisation	Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source de l’image, etc.	ImageTemplateCustomizer[]
distribuer	Cibles de distribution où la sortie de l’image doit aller.	ImageTemplateDistributor[] (obligatoire)
source	Spécifie les propriétés utilisées pour décrire l’image source.	ImageTemplateSource (obligatoire)
vmProfile	Décrit comment la machine virtuelle est configurée pour générer des images	ImageTemplateVmProfile

ImageTemplateCustomizer

Nom	Description	Valeur
name	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation	string
type	Définir le type d’objet	File PowerShell Shell WindowsRestart WindowsUpdate (obligatoire)

ImageTemplateFileCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'File' (obligatoire)
destination	Chemin absolu d’un fichier (avec des structures de répertoires imbriquées déjà créées) dans lequel le fichier (à partir de sourceUri) sera chargé dans la machine virtuelle	string
sha256Checksum	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus	string
sourceUri	URI du fichier à charger pour la personnalisation de la machine virtuelle. Il peut s’agir d’un lien github, d’UN URI SAS pour stockage Azure, etc.	string

ImageTemplatePowerShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	'PowerShell' (obligatoire)
inline	Tableau de commandes PowerShell à exécuter	string[]
runAsSystem	S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur système local. Ne peut être true que lorsque le champ runElevated ci-dessus est défini sur true.	bool
runElevated	S’il est spécifié, le script PowerShell sera exécuté avec des privilèges élevés	bool
scriptUri	URI du script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’un URI SAS pour Stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus	string
validExitCodes	Codes de sortie valides pour le script PowerShell. [Valeur par défaut : 0]	int[]

ImageTemplateShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	'Shell' (obligatoire)
inline	Tableau de commandes d’interpréteur de commandes à exécuter	string[]
scriptUri	URI du script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’un URI SAS pour Stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script shell fourni dans le champ scriptUri	string

ImageTemplateRestartCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	'WindowsRestart' (obligatoire)
restartCheckCommand	Commande pour case activée si le redémarrage a réussi [Valeur par défaut : '']	string
restartCommand	Commande permettant d’exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"']	string
restartTimeout	Délai de redémarrage spécifié sous forme de chaîne de magnitude et d’unité, par exemple « 5m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m »]	string

ImageTemplateWindowsUpdateCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	'WindowsUpdate' (obligatoire)
filtres	Tableau de filtres à sélectionner les mises à jour à appliquer. Omettez ou spécifiez un tableau vide pour utiliser la valeur par défaut (aucun filtre). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string[]
searchCriteria	Critères de recherche des mises à jour. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (rechercher tout). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string
updateLimit	Nombre maximal de mises à jour à appliquer à la fois. Omettre ou spécifier 0 pour utiliser la valeur par défaut (1000)	int

ImageTemplateDistributor

Nom	Description	Valeur
artifactTags	Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.	object
runOutputName	Nom à utiliser pour le RunOutput associé.	chaîne (obligatoire)
type	Définir le type d’objet	ManagedImage SharedImage Disque dur virtuel (obligatoire)

ImageTemplateManagedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	'ManagedImage' (obligatoire)
imageId	ID de ressource de l’image de disque managé	chaîne (obligatoire)
location	L’emplacement Azure de l’image doit correspondre si l’image existe déjà	chaîne (obligatoire)

ImageTemplateSharedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	'SharedImage' (obligatoire)
excludeFromLatest	Indicateur qui indique si la version de l’image créée doit être exclue de la dernière version. Omettez d’utiliser la valeur par défaut (false).	bool
galleryImageId	ID de ressource de l’image Shared Image Gallery	string (obligatoire)
replicationRegions	Liste des régions vers lesquelles l’image sera répliquée	string[] (obligatoire)
storageAccountType	Type de compte de stockage à utiliser pour stocker l’image partagée. Omettez d’utiliser la valeur par défaut (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'

ImageTemplateVhdDistributor

Nom	Description	Valeur
type	Type de distribution.	'VHD' (obligatoire)

ImageTemplateSource

Nom	Description	Valeur
type	Définir le type d’objet	ManagedImage PlatformImage SharedImageVersion (obligatoire)

ImageTemplateManagedImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source que vous souhaitez commencer.	'ManagedImage' (obligatoire)
imageId	ID de ressource ARM de l’image managée dans l’abonnement client	string (obligatoire)

ImageTemplatePlatformImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source que vous souhaitez commencer.	'PlatformImage' (obligatoire)
offer	Offre d’images de la galerie Azure Images.	string
planInfo	Configuration facultative du plan d’achat pour l’image de plateforme.	PlatformImagePurchasePlan
publisher	Éditeur d’images dans azure Gallery Images.	string
sku	Référence sku d’image de la galerie Azure Images.	string
version	Version de l’image à partir des images de la galerie Azure. Si « latest » est spécifié ici, la version est évaluée lors de la génération de l’image, et non lors de l’envoi du modèle.	string

PlatformImagePurchasePlan

Nom	Description	Valeur
planName	Nom du plan d’achat.	string (obligatoire)
planProduct	Produit du plan d’achat.	string (obligatoire)
planPublisher	Éditeur du plan d’achat.	string (obligatoire)

ImageTemplateSharedImageVersionSource

Nom	Description	Valeur
type	Spécifie le type d’image source que vous souhaitez commencer.	'SharedImageVersion' (obligatoire)
imageVersionId	ID de ressource ARM de la version de l’image dans la galerie d’images partagées	string (obligatoire)

ImageTemplateVmProfile

Nom	Description	Valeur
osDiskSizeGB	Taille du disque du système d’exploitation en Go. Omettez ou spécifiez 0 pour utiliser la taille de disque de système d’exploitation par défaut d’Azure.	int
userAssignedIdentities	Tableau facultatif d’ID de ressources d’identités managées affectées par l’utilisateur à configurer sur la machine virtuelle de build. Cela peut inclure l’identité du modèle d’image.	string[]
vmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_D2ds_v4).	string
vnetConfig	Configuration facultative du réseau virtuel à utiliser pour déployer la machine virtuelle de build dans. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
proxyVmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_D1_v2 pour les images Gen1 et Standard_D2ds_v4 pour les images Gen2).	string
subnetId	ID de ressource d’un sous-réseau préexistant.	string

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Azure Image Builder avec la base de référence Azure Windows	Crée un environnement Azure Image Builder et génère une image Windows Server avec la dernière version de Windows Mises à jour et la base de référence Azure Windows appliquées.
Configurer le service Dev Box	Ce modèle créerait toutes les ressources d’administration Dev Box conformément au guide de démarrage rapide Dev Box. Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première Dev Box.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource imageTemplates peut être déployé sur :

Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le Terraform suivant à votre modèle.

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"
        }
      }
    }
  })
}

Objets ImageTemplateCustomizer

Définissez la propriété type pour spécifier le type d’objet.

Pour Fichier, utilisez :

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

Pour PowerShell, utilisez :

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

Pour Shell, utilisez :

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

Pour WindowsRestart, utilisez :

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

Pour WindowsUpdate, utilisez :

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

Objets ImageTemplateDistributor

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

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

Pour SharedImage, utilisez :

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

Pour le disque dur virtuel, utilisez :

  type = "VHD"

Objets ImageTemplateSource

Définissez la propriété type pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

  type = "ManagedImage"
  imageId = "string"

Pour PlatformImage, utilisez :

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

Pour SharedImageVersion, utilisez :

  type = "SharedImageVersion"
  imageVersionId = "string"

Valeurs de propriétés

imageTemplates

Nom	Description	Valeur
type	Type de ressource	« Microsoft.VirtualMachineImages/imageTemplates@2021-10-01 »
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement géographique où réside la ressource	chaîne (obligatoire)
parent_id	Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources.	chaîne (obligatoire)
tags	Balises de ressource.	Dictionnaire de noms et de valeurs d’étiquettes.
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
properties	Propriétés du modèle d’image	ImageTemplateProperties

ImageTemplateIdentity

Nom	Description	Valeur
type	Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.	« UserAssigned »
identity_ids	Liste des identités utilisateur associées au modèle d’image. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	Tableau d’ID d’identité utilisateur.

ImageTemplateProperties

Nom	Description	Valeur
buildTimeoutInMinutes	Durée maximale d’attente lors de la génération du modèle d’image. Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).	int
Personnalisation	Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source d’image, etc.	ImageTemplateCustomizer[]
distribuer	Cibles de distribution où la sortie de l’image doit aller.	ImageTemplateDistributor[] (obligatoire)
source	Spécifie les propriétés utilisées pour décrire l’image source.	ImageTemplateSource (obligatoire)
vmProfile	Décrit la configuration de la machine virtuelle pour générer des images	ImageTemplateVmProfile

ImageTemplateCustomizer

Nom	Description	Valeur
name	Nom convivial pour fournir un contexte sur l’action de cette étape de personnalisation	string
type	Définir le type d’objet	File PowerShell Shell WindowsRestart WindowsUpdate (obligatoire)

ImageTemplateFileCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	« File » (obligatoire)
destination	Chemin absolu d’un fichier (avec des structures de répertoires imbriquées déjà créées) dans lequel le fichier (à partir de sourceUri) sera chargé dans la machine virtuelle	string
sha256Checksum	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus	string
sourceUri	URI du fichier à charger pour la personnalisation de la machine virtuelle. Il peut s’agir d’un lien github, d’un URI SAS pour Stockage Azure, etc.	string

ImageTemplatePowerShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	« PowerShell » (obligatoire)
inline	Tableau de commandes PowerShell à exécuter	string[]
runAsSystem	S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur système local. Ne peut être true que lorsque le champ runElevated ci-dessus est défini sur true.	bool
runElevated	S’il est spécifié, le script PowerShell sera exécuté avec des privilèges élevés	bool
scriptUri	URI du script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’un URI SAS pour Stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus	string
validExitCodes	Codes de sortie valides pour le script PowerShell. [Valeur par défaut : 0]	int[]

ImageTemplateShellCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes	« Shell » (obligatoire)
inline	Tableau de commandes d’interpréteur de commandes à exécuter	string[]
scriptUri	URI du script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’un URI SAS pour Stockage Azure, etc.	string
sha256Checksum	Somme de contrôle SHA256 du script shell fourni dans le champ scriptUri	string

ImageTemplateRestartCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	« WindowsRestart » (obligatoire)
restartCheckCommand	Commande à case activée si le redémarrage a réussi [Valeur par défaut : '']	string
restartCommand	Commande pour exécuter le redémarrage [Valeur par défaut : 'shutdown /r /f /t 0 /c « packer restart"']	string
restartTimeout	Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m »]	string

ImageTemplateWindowsUpdateCustomizer

Nom	Description	Valeur
type	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes	« WindowsUpdate » (obligatoire)
filtres	Tableau de filtres à sélectionner les mises à jour à appliquer. Omettez ou spécifiez un tableau vide pour utiliser la valeur par défaut (aucun filtre). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string[]
searchCriteria	Critères pour rechercher les mises à jour. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (rechercher tout). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	string
updateLimit	Nombre maximal de mises à jour à appliquer à la fois. Omettre ou spécifier 0 pour utiliser la valeur par défaut (1000)	int

ImageTemplateDistributor

Nom	Description	Valeur
artifactTags	Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.	object
runOutputName	Nom à utiliser pour le RunOutput associé.	string (obligatoire)
type	Définir le type d’objet	ManagedImage SharedImage VHD (obligatoire)

ImageTemplateManagedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	« ManagedImage » (obligatoire)
imageId	ID de ressource de l’image de disque managé	string (obligatoire)
location	L’emplacement Azure de l’image doit correspondre si l’image existe déjà	string (obligatoire)

ImageTemplateSharedImageDistributor

Nom	Description	Valeur
type	Type de distribution.	« SharedImage » (obligatoire)
excludeFromLatest	Indicateur qui indique si la version de l’image créée doit être exclue de la dernière version. Omettez d’utiliser la valeur par défaut (false).	bool
galleryImageId	ID de ressource de l’image Shared Image Gallery	string (obligatoire)
replicationRegions	Liste des régions vers lesquelles l’image sera répliquée	string[] (obligatoire)
storageAccountType	Type de compte de stockage à utiliser pour stocker l’image partagée. Omettez d’utiliser la valeur par défaut (Standard_LRS).	« Standard_LRS » « Standard_ZRS »

ImageTemplateVhdDistributor

Nom	Description	Valeur
type	Type de distribution.	« VHD » (obligatoire)

ImageTemplateSource

Nom	Description	Valeur
type	Définir le type d’objet	ManagedImage PlatformImage SharedImageVersion (obligatoire)

ImageTemplateManagedImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source avec lequel vous souhaitez commencer.	« ManagedImage » (obligatoire)
imageId	ID de ressource ARM de l’image managée dans l’abonnement client	chaîne (obligatoire)

ImageTemplatePlatformImageSource

Nom	Description	Valeur
type	Spécifie le type d’image source avec lequel vous souhaitez commencer.	« PlatformImage » (obligatoire)
offer	Offre d’images à partir d’Azure Gallery Images.	string
planInfo	Configuration facultative du plan d’achat pour l’image de plateforme.	PlatformImagePurchasePlan
publisher	Éditeur d’images dans Azure Gallery Images.	string
sku	Référence d’image à partir d’Azure Gallery Images.	string
version	Version de l’image à partir d’Azure Gallery Images. Si « latest » est spécifié ici, la version est évaluée lors de la génération de l’image, et non lors de l’envoi du modèle.	string

PlatformImagePurchasePlan

Nom	Description	Valeur
planName	Nom du plan d’achat.	chaîne (obligatoire)
planProduct	Produit du plan d’achat.	chaîne (obligatoire)
planPublisher	Éditeur du plan d’achat.	chaîne (obligatoire)

ImageTemplateSharedImageVersionSource

Nom	Description	Valeur
type	Spécifie le type d’image source avec lequel vous souhaitez commencer.	« SharedImageVersion » (obligatoire)
imageVersionId	ID de ressource ARM de la version de l’image dans la galerie d’images partagées	chaîne (obligatoire)

ImageTemplateVmProfile

Nom	Description	Valeur
osDiskSizeGB	Taille du disque du système d’exploitation en Go. Omettez ou spécifiez 0 pour utiliser la taille de disque de système d’exploitation par défaut d’Azure.	int
userAssignedIdentities	Tableau facultatif d’ID de ressources d’identités managées affectées par l’utilisateur à configurer sur la machine virtuelle de build. Cela peut inclure l’identité du modèle d’image.	string[]
vmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_D2ds_v4).	string
vnetConfig	Configuration facultative du réseau virtuel à utiliser pour déployer la machine virtuelle de build dans. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
proxyVmSize	Taille de la machine virtuelle utilisée pour créer, personnaliser et capturer des images. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_D1_v2 pour les images Gen1 et Standard_D2ds_v4 pour les images Gen2).	string
subnetId	ID de ressource d’un sous-réseau préexistant.	string

Partager via

Image Microsoft.VirtualMachineImagesTemplates 2021-10-01

Définition de ressource Bicep

Format des ressources

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriétés

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

PlatformImagePurchasePlan

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

VirtualNetworkConfig

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriétés

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

PlatformImagePurchasePlan

ImageTemplateSharedImageVersionSource

ImageTemplateVmProfile

VirtualNetworkConfig

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriétés

imageTemplates

ImageTemplateIdentity

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor

ImageTemplateVhdDistributor

ImageTemplateSource

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

PlatformImagePurchasePlan

ImageTemplateSharedImageVersionSource