Microsoft.VirtualMachineImages imageTemplates 2021-10-01

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@2021-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    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
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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'
  type: 'SharedImage'
}

Pour de disque dur virtuel, utilisez :

{
  type: 'VHD'
}

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
}

Valeurs de propriété

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom	Description	Valeur

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)

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

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

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

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 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'
type	Type de distribution.	'SharedImage' (obligatoire)

ImageTemplateSharedImageVersionSource

Nom	Description	Valeur
imageVersionId	ID de ressource ARM de la version de l’image dans la galerie d’images partagées	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)

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)

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. 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_D2ds_v4).	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

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