Microsoft.VirtualMachineImages imageTemplates 2020-02-14

Article
10/19/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@2020-02-14' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {}
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      vmSize: 'string'
      vnetConfig: {
        subnetId: 'string'
      }
    }
  }
}

Objets ImageTemplateCustomizer

Définissez le type propriété 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 le type propriété 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 de disque dur virtuel, utilisez :

  type: 'VHD'

Objets ImageTemplateSource

Définissez le type propriété 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é

imageTemplates

Nom	Description	Valeur
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Emplacement des ressources	chaîne (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
Propriétés	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 seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

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 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)
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
nom	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation	corde
type	Définir le type d’objet	fichier 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	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

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	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
validExitCodes	Codes de sortie valides pour le script PowerShell. [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 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

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

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

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.	objet
runOutputName	Nom à utiliser pour le RunOutput associé.	chaîne (obligatoire) Contraintes: Modèle = `^[A-Za-z0-9-_.]{1,64}$`
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)
emplacement	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 de la galerie d’images partagées	chaîne (obligatoire)
replicationRegions	Liste des régions vers laquelle 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 à utiliser.	'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 à utiliser.	'PlatformImage' (obligatoire)
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
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é. La spécification de « latest » peut entraîner ROUNDTRIP_INCONSISTENT_PROPERTY problème qui sera résolu.	corde

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 à utiliser.	'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 du système d’exploitation par défaut d’Azure.	Int Contraintes: Valeur minimale = 0
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 génération. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
subnetId	ID de ressource d’un sous-réseau préexistant.	corde

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 azure Windows Baseline	Crée un environnement Azure Image Builder et génère une image Windows Server avec les dernières mises à jour Windows et la base de référence Azure Windows appliquée.
configurer le service Dev Box	Ce modèle créerait toutes les ressources d’administration Dev Box en fonction du guide de démarrage rapide de Dev Box (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première zone de développement.

Définition de ressource de modèle ARM

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 code JSON suivant à votre modèle.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2020-02-14",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "buildTimeoutInMinutes": "int",
    "customize": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ],
    "distribute": [
      {
        "artifactTags": {},
        "runOutputName": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    },
    "vmProfile": {
      "osDiskSizeGB": "int",
      "vmSize": "string",
      "vnetConfig": {
        "subnetId": "string"
      }
    }
  }
}

Objets ImageTemplateCustomizer

Définissez le type propriété 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 le type propriété 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 de disque dur virtuel, utilisez :

  "type": "VHD"

Objets ImageTemplateSource

Définissez le type propriété 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é

imageTemplates

Nom	Description	Valeur
type	Type de ressource	'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion	Version de l’API de ressource	'2020-02-14'
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Emplacement des ressources	chaîne (obligatoire)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
Propriétés	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 seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

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 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)
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
nom	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation	corde
type	Définir le type d’objet	fichier 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	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

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	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
validExitCodes	Codes de sortie valides pour le script PowerShell. [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 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

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

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

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.	objet
runOutputName	Nom à utiliser pour le RunOutput associé.	chaîne (obligatoire) Contraintes: Modèle = `^[A-Za-z0-9-_.]{1,64}$`
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)
emplacement	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 de la galerie d’images partagées	chaîne (obligatoire)
replicationRegions	Liste des régions vers laquelle 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 à utiliser.	'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 à utiliser.	'PlatformImage' (obligatoire)
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
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é. La spécification de « latest » peut entraîner ROUNDTRIP_INCONSISTENT_PROPERTY problème qui sera résolu.	corde

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 à utiliser.	'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 du système d’exploitation par défaut d’Azure.	Int Contraintes: Valeur minimale = 0
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 génération. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
subnetId	ID de ressource d’un sous-réseau préexistant.	corde

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 azure Windows Baseline	Crée un environnement Azure Image Builder et génère une image Windows Server avec les dernières mises à jour Windows et la base de référence Azure Windows appliquée.
configurer le service Dev Box	Ce modèle créerait toutes les ressources d’administration Dev Box en fonction du guide de démarrage rapide de Dev Box (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première zone de développement.

Définition de ressource Terraform (fournisseur AzAPI)

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

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 terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2020-02-14"
  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
        vmSize = "string"
        vnetConfig = {
          subnetId = "string"
        }
      }
    }
  })
}

Objets ImageTemplateCustomizer

Définissez le type propriété 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 le type propriété 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 de disque dur virtuel, utilisez :

  type = "VHD"

Objets ImageTemplateSource

Définissez le type propriété 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é

imageTemplates

Nom	Description	Valeur
type	Type de ressource	« Microsoft.VirtualMachineImages/imageTemplates@2020-02-14 »
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Emplacement des ressources	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)
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
identité	Identité du modèle d’image, s’il est configuré.	ImageTemplateIdentity (obligatoire)
Propriétés	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 seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».	Tableau d’ID d’identité utilisateur.

ImageTemplateIdentityUserAssignedIdentities

Nom	Description	Valeur
{propriété personnalisée}		ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.

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 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)
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
nom	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation	corde
type	Définir le type d’objet	fichier 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	« Fichier » (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	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

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	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
validExitCodes	Codes de sortie valides pour le script PowerShell. [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 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

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

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

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.	objet
runOutputName	Nom à utiliser pour le RunOutput associé.	chaîne (obligatoire) Contraintes: Modèle = `^[A-Za-z0-9-_.]{1,64}$`
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)
emplacement	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 de la galerie d’images partagées	chaîne (obligatoire)
replicationRegions	Liste des régions vers laquelle 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 à utiliser.	« 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 à utiliser.	« PlatformImage » (obligatoire)
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
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é. La spécification de « latest » peut entraîner ROUNDTRIP_INCONSISTENT_PROPERTY problème qui sera résolu.	corde

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 à utiliser.	« 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 du système d’exploitation par défaut d’Azure.	Int Contraintes: Valeur minimale = 0
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 génération. Omettez si aucun réseau virtuel spécifique ne doit être utilisé.	VirtualNetworkConfig

VirtualNetworkConfig

Nom	Description	Valeur
subnetId	ID de ressource d’un sous-réseau préexistant.	corde

Partager via

Microsoft.VirtualMachineImages imageTemplates 2020-02-14

Définition de ressource Bicep

Format de ressource

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriété

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

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 de modèle ARM

Format de ressource

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriété

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

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 de ressource

Objets ImageTemplateCustomizer

Objets ImageTemplateDistributor

Objets ImageTemplateSource

Valeurs de propriété

imageTemplates

ImageTemplateIdentity

ImageTemplateIdentityUserAssignedIdentities

ComponentsVrq145SchemasImagetemplateidentityProperti...

ImageTemplateProperties

ImageTemplateCustomizer

ImageTemplateFileCustomizer

ImageTemplatePowerShellCustomizer

ImageTemplateShellCustomizer

ImageTemplateRestartCustomizer

ImageTemplateWindowsUpdateCustomizer

ImageTemplateDistributor

ImageTemplateManagedImageDistributor

ImageTemplateSharedImageDistributor