ImageTemplate interface

Paquet:

@azure/arm-imagebuilder

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

Extends

TrackedResource

Propriétés

autoRun	Indique si le modèle d’image doit être exécuté automatiquement lors de la création ou de la mise à jour du modèle.
buildTimeoutInMinutes	Durée maximale d’attente lors de la création du modèle d’image (inclut toutes les personnalisations, l’optimisation, les validations et les distributions). Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).
customize	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.
distribute	Cible de distribution vers laquelle la sortie de l’image doit être générée.
errorHandling	Options de gestion des erreurs lors d’une défaillance de build
exactStagingResourceGroup	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. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
identity	Identité du modèle d’image, s’il est configuré.
lastRunStatus	État de « run » qui est en cours d’exécution ou a été exécuté pour la dernière fois. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
managedResourceTags	Balises qui seront appliquées au groupe de ressources et/ou aux ressources créées par le service.
optimize	Spécifie l’optimisation à effectuer sur l’image.
provisioningError	Erreur d’approvisionnement, le cas échéant : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
provisioningState	État d’approvisionnement de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
source	Spécifie les propriétés utilisées pour décrire l’image source.
stagingResourceGroup	ID de groupe de ressources intermédiaires dans le même abonnement que le modèle d’image qui sera utilisé pour générer l’image. Si ce champ est vide, un groupe de ressources avec un nom aléatoire est créé. Si le groupe de ressources spécifié dans ce champ n’existe pas, il est créé avec le même nom. Si le groupe de ressources spécifié existe, il doit être vide et dans la même région que le modèle d’image. Le groupe de ressources créé est supprimé lors de la suppression du modèle si ce champ est vide ou si le groupe de ressources spécifié n’existe pas, mais si le groupe de ressources spécifié existe, les ressources créées dans le groupe de ressources sont supprimées pendant la suppression du modèle et le groupe de ressources lui-même reste.
validate	Options de configuration et liste des validations à effectuer sur l’image résultante.
vmProfile	Décrit comment la machine virtuelle est configurée pour générer des images

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
location	Emplacement géographique où réside la ressource
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
tags	Balises de ressource.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Détails de la propriété

autoRun

Indique si le modèle d’image doit être exécuté automatiquement lors de la création ou de la mise à jour du modèle.

autoRun?: ImageTemplateAutoRun

Valeur de propriété

ImageTemplateAutoRun

buildTimeoutInMinutes

Durée maximale d’attente lors de la création du modèle d’image (inclut toutes les personnalisations, l’optimisation, les validations et les distributions). Omettez ou spécifiez 0 pour utiliser la valeur par défaut (4 heures).

buildTimeoutInMinutes?: number

Valeur de propriété

number

customize

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.

customize?: ImageTemplateCustomizerUnion[]

Valeur de propriété

ImageTemplateCustomizerUnion[]

distribute

Cible de distribution vers laquelle la sortie de l’image doit être générée.

distribute?: ImageTemplateDistributorUnion[]

Valeur de propriété

ImageTemplateDistributorUnion[]

errorHandling

Options de gestion des erreurs lors d’une défaillance de build

errorHandling?: ImageTemplatePropertiesErrorHandling

Valeur de propriété

ImageTemplatePropertiesErrorHandling

exactStagingResourceGroup

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. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

exactStagingResourceGroup?: string

Valeur de propriété

string

identity

Identité du modèle d’image, s’il est configuré.

identity: ImageTemplateIdentity

Valeur de propriété

ImageTemplateIdentity

lastRunStatus

État de « run » qui est en cours d’exécution ou a été exécuté pour la dernière fois. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

lastRunStatus?: ImageTemplateLastRunStatus

Valeur de propriété

ImageTemplateLastRunStatus

managedResourceTags

Balises qui seront appliquées au groupe de ressources et/ou aux ressources créées par le service.

managedResourceTags?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

optimize

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

optimize?: ImageTemplatePropertiesOptimize

Valeur de propriété

ImageTemplatePropertiesOptimize

provisioningError

Erreur d’approvisionnement, le cas échéant : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

provisioningError?: ProvisioningError

Valeur de propriété

ProvisioningError

provisioningState

État d’approvisionnement de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

provisioningState?: ProvisioningState

Valeur de propriété

ProvisioningState

source

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

source?: ImageTemplateSourceUnion

Valeur de propriété

ImageTemplateSourceUnion

stagingResourceGroup

ID de groupe de ressources intermédiaires dans le même abonnement que le modèle d’image qui sera utilisé pour générer l’image. Si ce champ est vide, un groupe de ressources avec un nom aléatoire est créé. Si le groupe de ressources spécifié dans ce champ n’existe pas, il est créé avec le même nom. Si le groupe de ressources spécifié existe, il doit être vide et dans la même région que le modèle d’image. Le groupe de ressources créé est supprimé lors de la suppression du modèle si ce champ est vide ou si le groupe de ressources spécifié n’existe pas, mais si le groupe de ressources spécifié existe, les ressources créées dans le groupe de ressources sont supprimées pendant la suppression du modèle et le groupe de ressources lui-même reste.

stagingResourceGroup?: string

Valeur de propriété

string

validate

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

validate?: ImageTemplatePropertiesValidate

Valeur de propriété

ImageTemplatePropertiesValidate

vmProfile

Décrit comment la machine virtuelle est configurée pour générer des images

vmProfile?: ImageTemplateVmProfile

Valeur de propriété

ImageTemplateVmProfile

Détails de la propriété héritée

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

id?: string

Valeur de propriété

string

héritée deTrackedResource.id

location

Emplacement géographique où réside la ressource

location: string

Valeur de propriété

string

héritée deTrackedResource.location

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

name?: string

Valeur de propriété

string

héritée deTrackedResource.name

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

systemData?: SystemData

Valeur de propriété

SystemData

héritée deTrackedResource.systemData

tags

Balises de ressource.

tags?: {[propertyName: string]: string}

Valeur de propriété

{[propertyName: string]: string}

héritée deTrackedResource.tags

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

type?: string

Valeur de propriété

string

héritée deTrackedResource.type