Virtual Machine Image Templates - Get

Service:: Image Builder

Version d'API:: 2022-07-01

Obtenir des informations sur un modèle d’image de machine virtuelle

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nom du modèle d’image
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	ImageTemplate	D’ACCORD
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Retrieve an Image Template.

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service Générateur d’images de machine virtuelle Azure.
CloudErrorBody	Réponse d’erreur du service Générateur d’images de machine virtuelle Azure.
createdByType	Type d’identité qui a créé la ressource.
DistributeVersionerLatest	Génère le numéro de version qui sera le plus récent en fonction des numéros de version existants.
DistributeVersionerSource	Génère le numéro de version en fonction du numéro de version de l’image source
ImageTemplate	Le modèle d’image est une ressource ARM gérée par le fournisseur Microsoft.VirtualMachineImages
ImageTemplateFileCustomizer	Charge des fichiers sur des machines virtuelles (Linux, Windows). Correspond au provisionneur de fichiers Packer
ImageTemplateFileValidator	Charge les fichiers requis pour la validation sur les machines virtuelles (Linux, Windows). Correspond au provisionneur de fichiers Packer
ImageTemplateIdentity	Identité pour le modèle d’image.
ImageTemplateLastRunStatus	Décrit l’état le plus récent de l’exécution d’un modèle d’image
ImageTemplateManagedImageDistributor	Distribuer en tant qu’image de disque managé.
ImageTemplateManagedImageSource	Décrit une source d’image qui est une image managée dans l’abonnement client. Cette image doit résider dans le même abonnement et la même région que le modèle Générateur d’images.
ImageTemplatePlatformImageSource	Décrit une source d’image à partir de azure Gallery Images.
ImageTemplatePowerShellCustomizer	Exécute PowerShell spécifié sur la machine virtuelle (Windows). Correspond au provisionneur PowerShell Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».
ImageTemplatePowerShellValidator	Exécute le script PowerShell spécifié pendant la phase de validation (Windows). Correspond au provisionneur PowerShell Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».
ImageTemplateRestartCustomizer	Redémarre une machine virtuelle et attend qu’elle revienne en ligne (Windows). Correspond au provisionneur de redémarrage windows Packer
ImageTemplateSharedImageDistributor	Distribuer par le biais de la galerie de calcul Azure.
ImageTemplateSharedImageVersionSource	Décrit une source d’image qui est une version d’image dans une galerie de calcul Azure ou une galerie partagée directe.
ImageTemplateShellCustomizer	Exécute un script shell pendant la phase de personnalisation (Linux). Correspond au provisionneur d’interpréteur de commandes Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».
ImageTemplateShellValidator	Exécute le script shell spécifié pendant la phase de validation (Linux). Correspond au provisionneur d’interpréteur de commandes Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».
ImageTemplateVhdDistributor	Distribuer via un disque dur virtuel dans un compte de stockage.
ImageTemplateVmProfile	Décrit les machines virtuelles utilisées pour générer et valider des images
ImageTemplateWindowsUpdateCustomizer	Installe les mises à jour Windows. Correspond à Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Spécifie l’optimisation à effectuer sur l’image.
PlatformImagePurchasePlan	Configuration du plan d’achat pour l’image de plateforme.
ProvisioningError	Décrit l’erreur qui s’est produite lors de la création ou de la mise à jour d’un modèle d’image
ProvisioningErrorCode	Code d’erreur de l’échec d’approvisionnement
ProvisioningState	État d’approvisionnement de la ressource
ResourceIdentityType	Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.
RunState	État de la dernière exécution
RunSubState	Sous-état de la dernière exécution
SharedImageStorageAccountType	Spécifie le type de compte de stockage dans lequel stocker la version de l’image de la galerie de calcul Azure.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TargetRegion	Décrit les informations de région cible.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
Validate	Options de configuration et liste des validations à effectuer sur l’image résultante.
VirtualNetworkConfig	Configuration du réseau virtuel.
VmBoot	L’optimisation est appliquée à l’image pour un démarrage de machine virtuelle plus rapide.
VMBootOptimizationState	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.

CloudError

Object

Réponse d’erreur du service Générateur d’images de machine virtuelle Azure.

Nom	Type	Description
error	CloudErrorBody	Détails sur l’erreur.

CloudErrorBody

Object

Réponse d’erreur du service Générateur d’images de machine virtuelle Azure.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Object

Génère le numéro de version qui sera le plus récent en fonction des numéros de version existants.

Nom	Type	Valeur par défaut	Description
major	integer (int32) minimum: -1	-1	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.
scheme	string: Latest		Schéma de numérotation de version à utiliser.

DistributeVersionerSource

Object

Génère le numéro de version en fonction du numéro de version de l’image source

Nom	Type	Description
scheme	string: Source	Schéma de numérotation de version à utiliser.

ImageTemplate

Object

Le modèle d’image est une ressource ARM gérée par le fournisseur Microsoft.VirtualMachineImages

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Identité du modèle d’image, s’il est configuré.
location	string		Emplacement géographique où réside la ressource
name	string		Nom de la ressource
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	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).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		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.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Cible de distribution vers laquelle la sortie de l’image doit être générée.
properties.exactStagingResourceGroup	string		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. Ce champ en lecture seule diffère de « stagingResourceGroup » uniquement si la valeur spécifiée dans le champ « stagingResourceGroup » est vide.
properties.lastRunStatus	ImageTemplateLastRunStatus		État de « run » qui est en cours d’exécution ou a été exécuté pour la dernière fois.
properties.optimize	Optimize		Spécifie l’optimisation à effectuer sur l’image.
properties.provisioningError	ProvisioningError		Erreur d’approvisionnement, le cas échéant
properties.provisioningState	ProvisioningState		État d’approvisionnement de la ressource
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Spécifie les propriétés utilisées pour décrire l’image source.
properties.stagingResourceGroup	string		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.
properties.validate	Validate		Options de configuration et liste des validations à effectuer sur l’image résultante.
properties.vmProfile	ImageTemplateVmProfile		Décrit comment la machine virtuelle est configurée pour générer des images
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object		Balises de ressource.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ImageTemplateFileCustomizer

Object

Charge des fichiers sur des machines virtuelles (Linux, Windows). Correspond au provisionneur de fichiers Packer

Nom	Type	Description
destination	string	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
name	string	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation
sha256Checksum	string	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus
sourceUri	string	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.
type	string: File	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes

ImageTemplateFileValidator

Object

Charge les fichiers requis pour la validation sur les machines virtuelles (Linux, Windows). Correspond au provisionneur de fichiers Packer

Nom	Type	Description
destination	string	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
name	string	Nom convivial pour fournir un contexte sur ce que fait cette étape de validation
sha256Checksum	string	Somme de contrôle SHA256 du fichier fourni dans le champ sourceUri ci-dessus
sourceUri	string	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.
type	string: File	Type de validation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être la validation de l’interpréteur de commandes

ImageTemplateIdentity

Object

Identité pour le modèle d’image.

Nom	Type	Description
type	ResourceIdentityType	Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.
userAssignedIdentities	<string, UserAssignedIdentity>	identités User-Assigned 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.

ImageTemplateLastRunStatus

Object

Décrit l’état le plus récent de l’exécution d’un modèle d’image

Nom	Type	Description
endTime	string (date-time)	Heure de fin de la dernière exécution (UTC)
message	string	Informations détaillées sur le dernier état d’exécution
runState	RunState	État de la dernière exécution
runSubState	RunSubState	Sous-état de la dernière exécution
startTime	string (date-time)	Heure de début de la dernière exécution (UTC)

ImageTemplateManagedImageDistributor

Object

Distribuer en tant qu’image de disque managé.

Nom	Type	Description
artifactTags	object	Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.
imageId	string	ID de ressource de l’image de disque managé
location	string	Emplacement Azure de l’image, doit correspondre si l’image existe déjà
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nom à utiliser pour le RunOutput associé.
type	string: ManagedImage	Type de distribution.

ImageTemplateManagedImageSource

Object

Décrit une source d’image qui est une image managée dans l’abonnement client. Cette image doit résider dans le même abonnement et la même région que le modèle Générateur d’images.

Nom	Type	Description
imageId	string	ID de ressource ARM de l’image managée dans l’abonnement client
type	string: ManagedImage	Spécifie le type d’image source à utiliser.

ImageTemplatePlatformImageSource

Object

Décrit une source d’image à partir de azure Gallery Images.

Nom	Type	Description
exactVersion	string	Version d’image à partir des images de la galerie Azure . Ce champ en lecture seule diffère de « version », uniquement si la valeur spécifiée dans le champ « version » est « latest ».
offer	string	Offre d’image à partir des images de la galerie Azure .
planInfo	PlatformImagePurchasePlan	Configuration facultative du plan d’achat pour l’image de plateforme.
publisher	string	Éditeur d’images dans Azure Gallery Images.
sku	string	Référence sku d’image à partir des images de la galerie Azure .
type	string: PlatformImage	Spécifie le type d’image source à utiliser.
version	string	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é.

ImageTemplatePowerShellCustomizer

Object

Exécute PowerShell spécifié sur la machine virtuelle (Windows). Correspond au provisionneur PowerShell Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».

Nom	Type	Valeur par défaut	Description
inline	string[]		Tableau de commandes PowerShell à exécuter
name	string		Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation
runAsSystem	boolean	False	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.
runElevated	boolean	False	Si spécifié, le script PowerShell est exécuté avec des privilèges élevés
scriptUri	string		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.
sha256Checksum	string		Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus
type	string: PowerShell		Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes
validExitCodes	integer[] (int32)		Codes de sortie valides pour le script PowerShell. [Par défaut : 0]

ImageTemplatePowerShellValidator

Object

Exécute le script PowerShell spécifié pendant la phase de validation (Windows). Correspond au provisionneur PowerShell Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».

Nom	Type	Valeur par défaut	Description
inline	string[]		Tableau de commandes PowerShell à exécuter
name	string		Nom convivial pour fournir un contexte sur ce que fait cette étape de validation
runAsSystem	boolean	False	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.
runElevated	boolean	False	Si spécifié, le script PowerShell est exécuté avec des privilèges élevés
scriptUri	string		URI du script PowerShell à exécuter pour la validation. Il peut s’agir d’un lien github, d’UN URI de stockage Azure, etc.
sha256Checksum	string		Somme de contrôle SHA256 du script Power Shell fourni dans le champ scriptUri ci-dessus
type	string: PowerShell		Type de validation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être la validation de l’interpréteur de commandes
validExitCodes	integer[] (int32)		Codes de sortie valides pour le script PowerShell. [Par défaut : 0]

ImageTemplateRestartCustomizer

Object

Redémarre une machine virtuelle et attend qu’elle revienne en ligne (Windows). Correspond au provisionneur de redémarrage windows Packer

Nom	Type	Description
name	string	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation
restartCheckCommand	string	Commande pour vérifier si le redémarrage a réussi [Valeur par défaut : '']
restartCommand	string	Commande pour exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"']
restartTimeout	string	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 » ]
type	string: WindowsRestart	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes

ImageTemplateSharedImageDistributor

Object

Distribuer par le biais de la galerie de calcul Azure.

Nom	Type	Valeur par défaut	Description
artifactTags	object		Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.
excludeFromLatest	boolean	False	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).
galleryImageId	string		ID de ressource de l’image de la galerie de calcul Azure
replicationRegions	string[]		[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.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Nom à utiliser pour le RunOutput associé.
storageAccountType	SharedImageStorageAccountType		[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.
targetRegions	TargetRegion[]		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é.
type	string: SharedImage		Type de distribution.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Décrit comment générer un nouveau numéro de version x.y.z pour la distribution.

ImageTemplateSharedImageVersionSource

Object

Décrit une source d’image qui est une version d’image dans une galerie de calcul Azure ou une galerie partagée directe.

Nom	Type	Description
exactVersion	string	ID de ressource ARM exact de la version de l’image. Ce champ en lecture seule diffère de l’ID de version de l’image dans « imageVersionId » uniquement si le nom de version spécifié dans le champ « imageVersionId » est « latest ».
imageVersionId	string	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.
type	string: SharedImageVersion	Spécifie le type d’image source à utiliser.

ImageTemplateShellCustomizer

Object

Exécute un script shell pendant la phase de personnalisation (Linux). Correspond au provisionneur d’interpréteur de commandes Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».

Nom	Type	Description
inline	string[]	Tableau de commandes shell à exécuter
name	string	Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation
scriptUri	string	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.
sha256Checksum	string	Somme de contrôle SHA256 du script shell fournie dans le champ scriptUri
type	string: Shell	Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes

ImageTemplateShellValidator

Object

Exécute le script shell spécifié pendant la phase de validation (Linux). Correspond au provisionneur d’interpréteur de commandes Packer. Vous pouvez spécifier exactement l’un des « scriptUri » ou « inline ».

Nom	Type	Description
inline	string[]	Tableau de commandes shell à exécuter
name	string	Nom convivial pour fournir un contexte sur ce que fait cette étape de validation
scriptUri	string	URI du script shell à exécuter pour la validation. Il peut s’agir d’un lien github, d’UN URI de stockage Azure, etc.
sha256Checksum	string	Somme de contrôle SHA256 du script shell fournie dans le champ scriptUri
type	string: Shell	Type de validation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être la validation de l’interpréteur de commandes

ImageTemplateVhdDistributor

Object

Distribuer via un disque dur virtuel dans un compte de stockage.

Nom	Type	Description
artifactTags	object	Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Nom à utiliser pour le RunOutput associé.
type	string: VHD	Type de distribution.
uri	string	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.

ImageTemplateVmProfile

Object

Décrit les machines virtuelles utilisées pour générer et valider des images

Nom	Type	Valeur par défaut	Description
osDiskSizeGB	integer (int32) minimum: 0	0	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.
userAssignedIdentities	string[]		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.
vmSize	string		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).
vnetConfig	VirtualNetworkConfig		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é.

ImageTemplateWindowsUpdateCustomizer

Object

Installe les mises à jour Windows. Correspond à Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Nom	Type	Valeur par défaut	Description
filters	string[]		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.
name	string		Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation
searchCriteria	string		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.
type	string: WindowsUpdate		Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes
updateLimit	integer (int32) minimum: 0	0	Nombre maximal de mises à jour à appliquer à la fois. Omettez ou spécifiez 0 pour utiliser la valeur par défaut (1000)

Optimize

Object

Spécifie l’optimisation à effectuer sur l’image.

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

PlatformImagePurchasePlan

Object

Configuration du plan d’achat pour l’image de plateforme.

Nom	Type	Description
planName	string	Nom du plan d’achat.
planProduct	string	Produit du plan d’achat.
planPublisher	string	Éditeur du plan d’achat.

ProvisioningError

Object

Décrit l’erreur qui s’est produite lors de la création ou de la mise à jour d’un modèle d’image

Nom	Type	Description
message	string	Message d’erreur détaillé sur l’échec d’approvisionnement
provisioningErrorCode	ProvisioningErrorCode	Code d’erreur de l’échec d’approvisionnement

ProvisioningErrorCode

Énumération

Code d’erreur de l’échec d’approvisionnement

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

ProvisioningState

Énumération

État d’approvisionnement de la ressource

Valeur	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Énumération

Type d’identité utilisé pour le modèle d’image. Le type « None » supprime toutes les identités du modèle d’image.

Valeur	Description
UserAssigned
None

RunState

Énumération

État de la dernière exécution

Valeur	Description
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Énumération

Sous-état de la dernière exécution

Valeur	Description
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Énumération

Spécifie le type de compte de stockage dans lequel stocker la version de l’image de la galerie de calcul Azure.

Valeur	Description
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

TargetRegion

Object

Décrit les informations de région cible.

Nom	Type	Valeur par défaut	Description
name	string		Nom de la région.
replicaCount	integer (int32) minimum: 1	1	Nombre de réplicas de la version d’image à créer dans cette région. Omettez d’utiliser la valeur par défaut (1).
storageAccountType	SharedImageStorageAccountType		Spécifie le type de compte de stockage à utiliser pour stocker l’image dans cette région. Omettez d’utiliser la valeur par défaut (Standard_LRS).

UserAssignedIdentity

Object

Propriétés d’identité attribuées par l’utilisateur

Nom	Type	Description
clientId	string	ID client de l’identité affectée.
principalId	string	ID principal de l’identité affectée.

Validate

Object

Options de configuration et liste des validations à effectuer sur l’image résultante.

Nom	Type	Valeur par défaut	Description
continueDistributeOnFailure	boolean	False	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.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Liste des validations à effectuer.
sourceValidationOnly	boolean	False	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.

VirtualNetworkConfig

Object

Configuration du réseau virtuel.

Nom	Type	Description
proxyVmSize	string	Taille de la machine virtuelle proxy utilisée pour passer le trafic vers la machine virtuelle de build et la machine virtuelle de validation. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (Standard_A1_v2).
subnetId	string	ID de ressource d’un sous-réseau préexistant.

VmBoot

Object

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

Nom	Type	Description
state	VMBootOptimizationState	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.

VMBootOptimizationState

Énumération

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.

Valeur	Description
Enabled
Disabled

Partager via

Virtual Machine Image Templates - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Retrieve an Image Template.

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState