Partager via


Virtual Machine Image Templates - Get

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

Nom du modèle d’image

Modèle d’expression régulière: ^[A-Za-z0-9-_.]{1,64}$

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 pour chaque appel de service.

api-version
query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

ImageTemplate

Ok

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

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

Exemple de réponse

{
  "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 Azure VM Image Builder.

CloudErrorBody

Réponse d’erreur du service Azure VM Image Builder.

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é du modèle d’image.

ImageTemplateLastRunStatus

Décrit les dernières status d’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 Image Builder.

ImageTemplatePlatformImageSource

Décrit une source d’image à partir d’Images de la galerie Azure.

ImageTemplatePowerShellCustomizer

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

ImageTemplatePowerShellValidator

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

ImageTemplateRestartCustomizer

Redémarre une machine virtuelle et attend qu’elle revienne en ligne (Windows). Correspond au provisionneur packer windows-restart

ImageTemplateSharedImageDistributor

Distribuer via Azure Compute Gallery.

ImageTemplateSharedImageVersionSource

Décrit une source d’image qui est une version d’image dans azure Compute Gallery ou une galerie partagée directe.

ImageTemplateShellCustomizer

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

ImageTemplateShellValidator

Exécute le script d’interpréteur de commandes spécifié pendant la phase de validation (Linux). Correspond au provisionneur de l’interpréteur de commandes Packer. Vous pouvez spécifier exactement l’un des éléments « 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 Windows Mises à jour. 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 à utiliser pour stocker la version de l’image Azure Compute Gallery dans.

systemData

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

TargetRegion

Décrit les informations sur la région cible.

UserAssignedIdentity

Propriétés de l’identité affectée par l’utilisateur

Validate

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

VirtualNetworkConfig

Réseau virtuel configuration.

VmBoot

L’optimisation est appliquée à l’image pour accélérer le démarrage de la machine virtuelle.

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

Réponse d’erreur du service Azure VM Image Builder.

Nom Type Description
error

CloudErrorBody

Détails sur l’erreur.

CloudErrorBody

Réponse d’erreur du service Azure VM Image Builder.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

CloudErrorBody[]

Liste des détails supplémentaires sur l’erreur.

message

string

Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété dans l’erreur.

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DistributeVersionerLatest

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

-1

Version principale pour le 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

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

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

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

Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source de l’image, etc.

properties.distribute ImageTemplateDistributor[]:

Cibles de distribution où la sortie de l’image doit aller.

properties.exactStagingResourceGroup

string

ID de groupe de ressources intermédiaire 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 « run » qui est en cours d’exécution ou qui 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:

Spécifie les propriétés utilisées pour décrire l’image source.

properties.stagingResourceGroup

string

ID de groupe de ressources intermédiaire 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éé sera 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 seront supprimées lors de la suppression du modèle et le groupe de ressources lui-même restera.

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

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 la personnalisation de la machine virtuelle. Il peut s’agir d’un lien github, d’UN URI SAS pour stockage Azure, etc.

type string:

File

Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes

ImageTemplateFileValidator

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 les actions de 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 SAS), 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

Identité du 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 sont des ID de ressource ARM au format : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs du dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ImageTemplateLastRunStatus

Décrit les dernières status d’exécution d’un modèle d’image

Nom Type Description
endTime

string

Heure de fin de la dernière exécution (UTC)

message

string

Informations détaillées sur l’état de la dernière exécution

runState

RunState

État de la dernière exécution

runSubState

RunSubState

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

startTime

string

Heure de début de la dernière exécution (UTC)

ImageTemplateManagedImageDistributor

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

L’emplacement Azure de l’image doit correspondre si l’image existe déjà

runOutputName

string

Nom à utiliser pour le RunOutput associé.

type string:

ManagedImage

Type de distribution.

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 Image Builder.

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 que vous souhaitez commencer.

ImageTemplatePlatformImageSource

Décrit une source d’image à partir d’Images de la galerie Azure.

Nom Type Description
exactVersion

string

Version de l’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’images de la galerie Azure Images.

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 de la galerie Azure Images.

type string:

PlatformImage

Spécifie le type d’image source que vous souhaitez commencer.

version

string

Version de l’image à partir des images de la galerie Azure. Si « latest » est spécifié ici, la version est évaluée lors de la génération de l’image, et non lors de l’envoi du modèle.

ImageTemplatePowerShellCustomizer

Exécute le PowerShell spécifié sur la machine virtuelle (Windows). Correspond au provisionneur Packer PowerShell. Vous pouvez spécifier exactement l’un des éléments « 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

S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur système local. Ne peut être true que lorsque le champ runElevated ci-dessus est défini sur true.

runElevated

boolean

False

S’il est 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 SAS 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 un personnalisateur d’interpréteur de commandes

validExitCodes

integer[]

Codes de sortie valides pour le script PowerShell. [Valeur par défaut : 0]

ImageTemplatePowerShellValidator

Exécute le script PowerShell spécifié pendant la phase de validation (Windows). Correspond au provisionneur Packer PowerShell. Vous pouvez spécifier exactement l’un des éléments « 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 les actions de cette étape de validation

runAsSystem

boolean

False

S’il est spécifié, le script PowerShell est exécuté avec des privilèges élevés à l’aide de l’utilisateur système local. Ne peut être true que lorsque le champ runElevated ci-dessus est défini sur true.

runElevated

boolean

False

S’il est 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[]

Codes de sortie valides pour le script PowerShell. [Valeur par défaut : 0]

ImageTemplateRestartCustomizer

Redémarre une machine virtuelle et attend qu’elle revienne en ligne (Windows). Correspond au provisionneur packer windows-restart

Nom Type Description
name

string

Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation

restartCheckCommand

string

Commande à case activée si le redémarrage a réussi [Valeur par défaut : '']

restartCommand

string

Commande pour exécuter le redémarrage [Valeur 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 « 5m » (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 un personnalisateur d’interpréteur de commandes

ImageTemplateSharedImageDistributor

Distribuer via Azure Compute Gallery.

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 Azure Compute Gallery

replicationRegions

string[]

[Déconseillé] Liste des régions vers lesquelles 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

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 dans lesquelles la version d’image distribuée va être répliquée. Cet objet remplace replicationRegions et ne peut être spécifié que si replicationRegions n’est pas spécifié.

type string:

SharedImage

Type de distribution.

versioning DistributeVersioner:

Décrit comment générer un nouveau numéro de version x.y.z pour la distribution.

ImageTemplateSharedImageVersionSource

Décrit une source d’image qui est une version d’image dans azure Compute Gallery 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. Quand le nom de la version de l’image est « latest », la version est évaluée lors de la génération de l’image.

type string:

SharedImageVersion

Spécifie le type d’image source que vous souhaitez commencer.

ImageTemplateShellCustomizer

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

Nom Type Description
inline

string[]

Tableau de commandes de l’interpréteur de commandes à 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 SAS pour stockage Azure, etc.

sha256Checksum

string

Somme de contrôle SHA256 du script d’interpréteur de commandes fourni dans le champ scriptUri

type string:

Shell

Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes

ImageTemplateShellValidator

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

Nom Type Description
inline

string[]

Tableau de commandes de l’interpréteur de commandes à exécuter

name

string

Nom convivial pour fournir un contexte sur les actions de 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 d’interpréteur de commandes fourni 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

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

Nom à utiliser pour le RunOutput associé.

type string:

VHD

Type de distribution.

uri

string

URI de stockage Azure facultatif pour l’objet blob VHD distribué. À omettre pour utiliser la valeur par défaut (chaîne vide), auquel cas le VHD est publié sur le compte de stockage dans le groupe de ressources intermédiaires.

ImageTemplateVmProfile

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

Nom Type Valeur par défaut Description
osDiskSizeGB

integer

0

Taille du disque du système d’exploitation en Go. Omettez ou spécifiez 0 pour utiliser la taille de disque de système d’exploitation par défaut d’Azure.

userAssignedIdentities

string[]

Tableau facultatif d’ID de ressources d’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 créer, personnaliser et capturer des images. Omettez ou spécifiez la chaîne vide pour utiliser la valeur par défaut (Standard_D1_v2 pour les images Gen1 et Standard_D2ds_v4 pour les images Gen2).

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

Installe Windows Mises à jour. 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 à 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 pour rechercher les mises à jour. Omettez ou spécifiez une chaîne vide pour utiliser la valeur par défaut (rechercher tout). Reportez-vous au lien ci-dessus pour obtenir des exemples et une description détaillée de ce champ.

type string:

WindowsUpdate

Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être un personnalisateur d’interpréteur de commandes

updateLimit

integer

0

Nombre maximal de mises à jour à appliquer à la fois. Omettre ou spécifier 0 pour utiliser la valeur par défaut (1000)

Optimize

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

Nom Type Description
vmBoot

VmBoot

L’optimisation est appliquée à l’image pour accélérer le démarrage de la machine virtuelle.

PlatformImagePurchasePlan

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

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é concernant l’échec de l’approvisionnement

provisioningErrorCode

ProvisioningErrorCode

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

ProvisioningErrorCode

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

Nom Type Description
BadCustomizerType

string

BadDistributeType

string

BadManagedImageSource

string

BadPIRSource

string

BadSharedImageDistribute

string

BadSharedImageVersionSource

string

BadSourceType

string

BadStagingResourceGroup

string

BadValidatorType

string

NoCustomizerScript

string

NoValidatorScript

string

Other

string

ServerError

string

UnsupportedCustomizerType

string

UnsupportedValidatorType

string

ProvisioningState

État d’approvisionnement de la ressource

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

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

Nom Type Description
None

string

UserAssigned

string

RunState

État de la dernière exécution

Nom Type Description
Canceled

string

Canceling

string

Failed

string

PartiallySucceeded

string

Running

string

Succeeded

string

RunSubState

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

Nom Type Description
Building

string

Customizing

string

Distributing

string

Optimizing

string

Queued

string

Validating

string

SharedImageStorageAccountType

Spécifie le type de compte de stockage à utiliser pour stocker la version de l’image Azure Compute Gallery dans.

Nom Type Description
Premium_LRS

string

Standard_LRS

string

Standard_ZRS

string

systemData

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

Nom Type Description
createdAt

string

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

Horodatage de la dernière modification de la 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

Décrit les informations sur la région cible.

Nom Type Valeur par défaut Description
name

string

Nom de la région.

replicaCount

integer

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

Propriétés de l’identité affectée 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

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 est défini sur 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, la ou les images de sortie sont toujours distribuées. Utilisez cette option avec précaution, car elle peut entraîner la distribution d’images incorrectes pour une utilisation. Dans les deux cas (true ou false), l’exécution d’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[]:

Liste des validations à effectuer.

sourceValidationOnly

boolean

False

Si ce champ a la valeur 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

Réseau virtuel configuration.

Nom Type Description
proxyVmSize

string

Taille de la machine virtuelle proxy utilisée pour transmettre le trafic à 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

L’optimisation est appliquée à l’image pour accélérer le démarrage de la machine virtuelle.

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

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.

Nom Type Description
Disabled

string

Enabled

string