Microsoft.VirtualMachineImages imageTemplates

Article
12/17/2024

Définition de ressource Bicep

Le type de ressource imageTemplates peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez 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 de ressource

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

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoRun: {
      state: 'string'
    }
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    errorHandling: {
      onCustomizerError: 'string'
      onValidationError: 'string'
    }
    managedResourceTags: {
      {customized property}: 'string'
    }
    optimize: {
      vmBoot: {
        state: 'string'
      }
    }
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    stagingResourceGroup: 'string'
    validate: {
      continueDistributeOnFailure: bool
      inVMValidations: [
        {
          name: 'string'
          type: 'string'
          // For remaining properties, see ImageTemplateInVMValidator objects
        }
      ]
      sourceValidationOnly: bool
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        containerInstanceSubnetId: 'string'
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets ImageTemplateDistributor

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

Pour ManagedImage, utilisez :

{
  imageId: 'string'
  location: 'string'
  type: 'ManagedImage'
}

Pour SharedImage, utilisez :

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  targetRegions: [
    {
      name: 'string'
      replicaCount: int
      storageAccountType: 'string'
    }
  ]
  type: 'SharedImage'
  versioning: {
    scheme: 'string'
    // For remaining properties, see DistributeVersioner objects
  }
}

Pour de disque dur virtuel, utilisez :

{
  type: 'VHD'
  uri: 'string'
}

Objets DistributeVersioner

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

Pour dernière, utilisez :

{
  major: int
  scheme: 'Latest'
}

Pour source, utilisez :

{
  scheme: 'Source'
}

Objets ImageTemplateCustomizer

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

Pour fichier, utilisez :

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

Pour PowerShell, utilisez :

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

Pour Shell, utilisez :

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

Pour windowsRestart, utilisez :

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

Pour WindowsUpdate, utilisez :

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

Objets ImageTemplateInVMValidator

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

Pour fichier, utilisez :

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

Pour PowerShell, utilisez :

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

Pour Shell, utilisez :

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

Objets ImageTemplateSource

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

Pour ManagedImage, utilisez :

{
  imageId: 'string'
  type: 'ManagedImage'
}

Pour PlatformImage, utilisez :

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

Pour SharedImageVersion, utilisez :

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

Valeurs de propriété

DistributeVersioner

Nom	Description	Valeur
schéma	Défini sur « Latest » pour le type DistributeVersionerLatest. Défini sur « Source » pour le type DistributeVersionerSource.	'Latest' 'Source' (obligatoire)

DistributeVersionerLatest

Nom	Description	Valeur
majeur	Version principale du numéro de version généré. Déterminez ce qui est « le plus récent » en fonction des versions avec cette valeur comme version principale. -1 équivaut à le laisser non défini.	Int Contraintes: Valeur minimale = -1
schéma	Schéma de numérotation de version à utiliser.	'Latest' (obligatoire)

DistributeVersionerSource

Nom	Description	Valeur
schéma	Schéma de numérotation de version à utiliser.	'Source' (obligatoire)

ImageTemplateAutoRun

Nom	Description	Valeur
état	L’activation de ce champ déclenche une génération automatique sur la création ou la mise à jour du modèle d’image.	'Désactivé' 'Activé'

ImageTemplateCustomizer

Nom	Description	Valeur
nom	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation	corde
type	Défini sur « File » pour le type ImageTemplateFileCustomizer. Défini sur « PowerShell » pour le type ImageTemplatePowerShellCustomizer. Défini sur « Shell » pour le type ImageTemplateShellCustomizer. Défini sur « WindowsRestart » pour le type ImageTemplateRestartCustomizer. Défini sur « WindowsUpdate » pour le type ImageTemplateWindowsUpdateCustomizer.	'Fichier' 'PowerShell' 'Shell' 'WindowsRestart' 'WindowsUpdate' (obligatoire)

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.	ImageTemplateDistributorArtifactTags
runOutputName	Nom à utiliser pour le RunOutput associé.	corde Contraintes: Modèle = `^[A-Za-z0-9-_.]{1,64}$` (obligatoire)
type	Défini sur « ManagedImage » pour le type ImageTemplateManagedImageDistributor. Défini sur « SharedImage » pour le type ImageTemplateSharedImageDistributor. Défini sur « VHD » pour le type ImageTemplateVhdDistributor.	'ManagedImage' 'SharedImage' 'VHD' (obligatoire)

ImageTemplateDistributorArtifactTags

Nom	Description	Valeur

ImageTemplateFileCustomizer

Nom	Description	Valeur
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	corde
sha256Checksum	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus	corde
sourceUri	URI du fichier à charger pour personnaliser la machine virtuelle. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc.	corde
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)

ImageTemplateFileValidator

Nom	Description	Valeur
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	corde
sha256Checksum	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus	corde
sourceUri	URI du fichier à charger sur la machine virtuelle pour validation. Il peut s’agir d’un lien github, d’UN URI de stockage Azure (autorisé ou SAP), etc.	corde
type	Type de validation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être la validation de l’interpréteur de commandes	'File' (obligatoire)

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	Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.	UserAssignedIdentities

ImageTemplateInVMValidator

Nom	Description	Valeur
nom	Nom convivial pour fournir un contexte sur ce que fait cette étape de validation	corde
type	Défini sur « File » pour le type ImageTemplateFileValidator. Défini sur « PowerShell » pour le type ImageTemplatePowerShellValidator. Défini sur « Shell » pour le type ImageTemplateShellValidator.	'Fichier' 'PowerShell' 'Shell' (obligatoire)

ImageTemplateManagedImageDistributor

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

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Nom	Description	Valeur
offrir	Offre d’image à partir des images de la galerie Azure .	corde
planInfo	Configuration facultative du plan d’achat pour l’image de plateforme.	PlatformImagePurchasePlan
éditeur	Éditeur d’images dans Azure Gallery Images.	corde
Sku	Référence sku d’image à partir des images de la galerie Azure .	corde
type	Spécifie le type d’image source à utiliser.	'PlatformImage' (obligatoire)
Version	Version d’image à partir des images de la galerie Azure . Si « latest » est spécifié ici, la version est évaluée lorsque la build de l’image a lieu, et non lorsque le modèle est envoyé.	corde

ImageTemplatePowerShellCustomizer

Nom	Description	Valeur
Inline	Tableau de commandes PowerShell à exécuter	string[]
runAsSystem	Si spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur du système local. Ne peut être vrai que lorsque le champ runElevated ci-dessus a la valeur true.	Bool
runElevated	Si 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 SAP pour stockage Azure, etc.	corde
sha256Checksum	Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus	corde
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)
validExitCodes	Codes de sortie valides pour le script PowerShell. [Par défaut : 0]	int[]

ImageTemplatePowerShellValidator

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

ImageTemplateProperties

Nom	Description	Valeur
autoRun	Indique si le modèle d’image doit être exécuté automatiquement lors de la création ou de la mise à jour du modèle.	ImageTemplateAutoRun
buildTimeoutInMinutes	Durée maximale d’attente lors de la création du modèle d’image (inclut toutes les personnalisations, l’optimisation, les validations et les distributions). Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).	Int Contraintes: Valeur minimale = 0 Valeur maximale = 960
Personnaliser	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	Cible de distribution vers laquelle la sortie de l’image doit être générée.	ImageTemplateDistributor[] (obligatoire)
errorHandling	Options de gestion des erreurs lors d’une défaillance de build	ImageTemplatePropertiesErrorHandling
managedResourceTags	Balises qui seront appliquées au groupe de ressources et/ou aux ressources créées par le service.	ImageTemplatePropertiesManagedResourceTags
optimiser	Spécifie l’optimisation à effectuer sur l’image.	ImageTemplatePropertiesOptimize
source	Spécifie les propriétés utilisées pour décrire l’image source.	ImageTemplateSource (obligatoire)
stagingResourceGroup	ID de groupe de ressources intermédiaires dans le même abonnement que le modèle d’image qui sera utilisé pour générer l’image. Si ce champ est vide, un groupe de ressources avec un nom aléatoire est créé. Si le groupe de ressources spécifié dans ce champ n’existe pas, il est créé avec le même nom. Si le groupe de ressources spécifié existe, il doit être vide et dans la même région que le modèle d’image. Le groupe de ressources créé est supprimé lors de la suppression du modèle si ce champ est vide ou si le groupe de ressources spécifié n’existe pas, mais si le groupe de ressources spécifié existe, les ressources créées dans le groupe de ressources sont supprimées pendant la suppression du modèle et le groupe de ressources lui-même reste.	corde
valider	Options de configuration et liste des validations à effectuer sur l’image résultante.	ImageTemplatePropertiesValidate
vmProfile	Décrit comment la machine virtuelle est configurée pour générer des images	ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Nom	Description	Valeur
onCustomizerError	S’il existe une erreur de personnalisateur et que ce champ est défini sur « nettoyage », la machine virtuelle de build et les ressources réseau associées sont nettoyées. Il s’agit du comportement par défaut. S’il existe une erreur de personnalisateur et que ce champ est défini sur « abandon », la machine virtuelle de build est conservée.	'abandon' 'cleanup'
onValidationError	S’il existe une erreur de validation et que ce champ est défini sur « nettoyage », la machine virtuelle de build et les ressources réseau associées sont nettoyées. Il s’agit du comportement par défaut. S’il existe une erreur de validation et que ce champ est défini sur « abandon », la machine virtuelle de build est conservée.	'abandon' 'cleanup'

ImageTemplatePropertiesManagedResourceTags

Nom	Description	Valeur

ImageTemplatePropertiesOptimize

Nom	Description	Valeur
vmBoot	L’optimisation est appliquée à l’image pour un démarrage de machine virtuelle plus rapide.	ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Nom	Description	Valeur
état	L’activation de ce champ améliore le temps de démarrage de la machine virtuelle en optimisant la sortie finale de l’image personnalisée.	'Désactivé' 'Activé'

ImageTemplatePropertiesValidate

Nom	Description	Valeur
continueDistributeOnFailure	Si la validation échoue et que ce champ a la valeur false, les images de sortie ne sont pas distribuées. Il s’agit du comportement par défaut. Si la validation échoue et que ce champ est défini sur true, les images de sortie sont toujours distribuées. Utilisez cette option avec précaution, car cela peut entraîner la distribution d’images incorrectes pour une utilisation. Dans les deux cas (true ou false), l’exécution de l’image de bout en bout est signalée comme ayant échoué en cas d’échec de validation. [Remarque : Ce champ n’a aucun effet si la validation réussit.]	Bool
inVMValidations	Liste des validations à effectuer.	ImageTemplateInVMValidator[]
sourceValidationOnly	Si ce champ est défini sur true, l’image spécifiée dans la section « source » est directement validée. Aucune build distincte n’est exécutée pour générer, puis valider une image personnalisée.	Bool

ImageTemplateRestartCustomizer

Nom	Description	Valeur
restartCheckCommand	Commande pour vérifier si le redémarrage a réussi [Valeur par défaut : '']	corde
restartCommand	Commande pour exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"']	corde
restartTimeout	Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5 m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m » ]	corde
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)

ImageTemplateSharedImageDistributor

Nom	Description	Valeur
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 de la galerie de calcul Azure	chaîne (obligatoire)
replicationRegions	[Déconseillé] Liste des régions vers laquelle l’image sera répliquée. Cette liste ne peut être spécifiée que si targetRegions n’est pas spécifié. Ce champ est déconseillé : utilisez plutôt targetRegions.	string[]
storageAccountType	[Déconseillé] Type de compte de stockage à utiliser pour stocker l’image partagée. Omettez d’utiliser la valeur par défaut (Standard_LRS). Ce champ ne peut être spécifié que si replicationRegions est spécifié. Ce champ est déconseillé : utilisez plutôt targetRegions.	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'
targetRegions	Régions cibles vers lesquelles la version d’image distribuée sera répliquée. Cet objet remplace replicationRegions et peut être spécifié uniquement si replicationRegions n’est pas spécifié.	TargetRegion[]
type	Type de distribution.	'SharedImage' (obligatoire)
contrôle de version	Décrit comment générer un nouveau numéro de version x.y.z pour la distribution.	DistributeVersioner

ImageTemplateSharedImageVersionSource

Nom	Description	Valeur
imageVersionId	ID de ressource ARM de la version de l’image. Lorsque le nom de la version de l’image est « le plus récent », la version est évaluée lorsque la build de l’image a lieu.	chaîne (obligatoire)
type	Spécifie le type d’image source à utiliser.	'SharedImageVersion' (obligatoire)

ImageTemplateShellCustomizer

Nom	Description	Valeur
Inline	Tableau de commandes shell à exécuter	string[]
scriptUri	URI du script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc.	corde
sha256Checksum	Somme de contrôle SHA256 du script shell fournie dans le champ scriptUri	corde
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)

ImageTemplateShellValidator

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

ImageTemplateSource

Nom	Description	Valeur
type	Défini sur « ManagedImage » pour le type ImageTemplateManagedImageSource. Défini sur « PlatformImage » pour le type ImageTemplatePlatformImageSource. Défini sur « SharedImageVersion » pour le type ImageTemplateSharedImageVersionSource.	'ManagedImage' 'PlatformImage' 'SharedImageVersion' (obligatoire)

ImageTemplateVhdDistributor

Nom	Description	Valeur
type	Type de distribution.	'VHD' (obligatoire)
URI	URI de stockage Azure facultatif pour l’objet blob de disque dur virtuel distribué. Omettez d’utiliser la chaîne par défaut (chaîne vide) dans laquelle le disque dur virtuel serait publié sur le compte de stockage dans le groupe de ressources intermédiaire.	corde

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 du système d’exploitation par défaut d’Azure.	Int Contraintes: Valeur minimale = 0
userAssignedIdentities	Tableau facultatif d’ID de ressources des identités managées affectées par l’utilisateur à configurer sur la machine virtuelle de build et la machine virtuelle de validation. Cela peut inclure l’identité du modèle d’image.	string[]
vmSize	Taille de la machine virtuelle utilisée pour générer, 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).	corde
vnetConfig	Configuration facultative du réseau virtuel à utiliser pour déployer la machine virtuelle de build et la machine virtuelle de validation dans. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Nom	Description	Valeur
Filtres	Tableau de filtres pour 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 (recherche tout). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.	corde
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)
updateLimit	Nombre maximal de mises à jour à appliquer à la fois. Omettez ou spécifiez 0 pour utiliser la valeur par défaut (1000)	Int Contraintes: Valeur minimale = 0