@azure/arm-imagebuilder package

Classes

ImageBuilderClient

Interfaces

DataDisk	Propriétés du disque de données.
DistributeVersioner	Décrit comment générer un nouveau numéro de version x.y.z pour la distribution.
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
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué.
ImageBuilderClientOptionalParams	Paramètres facultatifs pour le client.
ImageTemplate	Le modèle d’image est une ressource ARM gérée par le fournisseur Microsoft.VirtualMachineImages
ImageTemplateAutoRun	Indique si le modèle d’image doit être créé/mis à jour
ImageTemplateCustomizer	Décrit une unité de personnalisation d’image
ImageTemplateDistributor	Objet de distribution générique
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.
ImageTemplateInVMValidator	Décrit une unité de validation in-VM de l’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 ».
ImageTemplateProperties	Décrit les propriétés d’un modèle d’image
ImageTemplatePropertiesErrorHandling	Options de gestion des erreurs lors d’une défaillance de build
ImageTemplatePropertiesOptimize	Spécifie l’optimisation à effectuer sur l’image.
ImageTemplatePropertiesOptimizeVmBoot	L’optimisation est appliquée à l’image pour un démarrage de machine virtuelle plus rapide.
ImageTemplatePropertiesOptimizeWorkload	L’optimisation est appliquée à l’image pour des charges de travail spécifiques.
ImageTemplatePropertiesValidate	Options de configuration et liste des validations à effectuer sur l’image résultante.
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 ».
ImageTemplateSource	Décrit une source d’image de machine virtuelle pour la création, la personnalisation et la distribution
ImageTemplateUpdateParameters	Paramètres de mise à jour d’un modèle d’image.
ImageTemplateUpdateParametersProperties	Paramètres de mise à jour d’un modèle d’image.
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)
Operation	Une opération d’API REST
OperationDisplay	Objet qui décrit l’opération.
OperationsListOptionalParams	Paramètres facultatifs.
OperationsOperations	Interface représentant une opération d’opérations.
PageSettings	Options de la méthode byPage
PagedAsyncIterableIterator	Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.
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
ProxyResource	Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement
Resource	Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager
RestorePollerOptions
RunOutput	Représente une sortie créée en exécutant un modèle d’image.
RunOutputProperties	Décrit les propriétés d’une sortie exécutée
SimplePollerLike	Un polleur simple qui peut être utilisé pour interroger une opération de longue durée.
SourceImageTriggerProperties	Propriétés du type SourceImage du déclencheur
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.
TrackedResource	Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »
Trigger	Représente un déclencheur qui peut appeler une build de modèle d’image.
TriggerProperties	Décrit les propriétés d’un déclencheur
TriggerStatus	Décrit l’état d’un déclencheur
TriggersCreateOrUpdateOptionalParams	Paramètres facultatifs.
TriggersDeleteOptionalParams	Paramètres facultatifs.
TriggersGetOptionalParams	Paramètres facultatifs.
TriggersListByImageTemplateOptionalParams	Paramètres facultatifs.
TriggersOperations	Interface représentant une opération de déclenchement.
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
VirtualMachineImageTemplatesCancelOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesDeleteOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesGetOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesGetRunOutputOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesListByResourceGroupOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesListOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesListRunOutputsOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesOperations	Interface représentant une opération VirtualMachineImageTemplates.
VirtualMachineImageTemplatesRunOptionalParams	Paramètres facultatifs.
VirtualMachineImageTemplatesUpdateOptionalParams	Paramètres facultatifs.
VirtualNetworkConfig	Configuration du réseau virtuel.

Alias de type

AutoRunState	L’activation de ce champ déclenche une génération automatique sur la création ou la mise à jour du modèle d’image.
AzureSupportedClouds	Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne
ContinuablePage	Interface qui décrit une page de résultats.
CreatedByType	Type d’entité qui a créé la ressource. KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service 'utilisateur: l’entité a été créée par un utilisateur. Application: l’entité a été créée par une application. ManagedIdentity: l’entité a été créée par une identité managée. Key: l’entité a été créée par une clé.
DistributeVersionerUnion	Alias pour DistributeVersionerUnion
ImageTemplateCustomizerUnion	Alias pour ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion	Alias pour ImageTemplateDistributeUnion
ImageTemplateInVMValidatorUnion	Alias for ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion	Alias pour ImageTemplateSourceUnion
OnBuildError	Comportement de gestion des erreurs en cas d’échec de la compilation KnownOnBuildError peut être utilisé de manière interchangeable avec OnBuildError, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service nettoyage : nettoyage Abandonner : annuler
ProvisioningErrorCode	Code d’erreur de l’échec de provisionnement KnownProvisioningErrorCode pouvez être utilisé de manière interchangeable avec ProvisioningErrorCode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service MauvaiseSourceType : MauvaiseSourceType Mauvais PIRSource : Mauvais PIRSource Mauvaise ImageSource : Mauvaise Gestion ImageSource Mauvaise ImagePartagéeVersionSource : MauvaiseImagePartagéeVersionSource MauvaisPersonnalisateurType : MauvaisPersonnalisateurType TypePersonnaliséInsupporté : Type PersonnaliséPas Supporté NoCustomizerScript : NoCustomizerScript Mauvais ValidatorType : Mauvais ValidatorType TypeValidatorType Non supporté : Type de Validateur Non supporté NoValidatorScript : NoValidatorScript TypeDistribueMauvais : Type DistributeMauvais ImageMéchantDistribuéPartagée : ImageMéchantDistribuéePartagée BadStagingResourceGroup : BadStagingResourceGroup ServerError : ServerError Autres : Autres
ProvisioningState	État d’approvisionnement de la ressource
ReplicationMode	Décrit le mode de réplication pour la distribution dans Azure Compute Gallery. Omettez d’utiliser le mode par défaut (Plein). KnownReplicationMode peut être utilisé de manière interchangeable avec ReplicationMode, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Complet : mode de réplication complet Peu profond : mode de réplication superficielle
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 série
RunSubState	Sous-état de la dernière série
SharedImageStorageAccountType	Spécifie le type de compte de stockage à utiliser pour stocker la version de l’image de la galerie de calcul Azure. KnownSharedImageStorageAccountType pouvez être utilisé de manière interchangeable avec SharedImageStorageAccountType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Standard_LRS : Standard_LRS Standard_ZRS : Standard_ZRS Premium_LRS : Premium_LRS
TriggerPropertiesUnion	Alias pour TriggerPropertiesUnion
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.
WorkloadOptimizationState	Activer ce champ optimisera les images VM pour des charges de travail spécifiques.

Énumérations

AzureClouds	Un enum pour décrire les environnements Azure Cloud.
KnownCreatedByType	Type d’entité qui a créé la ressource.
KnownOnBuildError	Comportement de gestion des erreurs en cas d’échec de la compilation
KnownProvisioningErrorCode	Code d’erreur de l’échec de provisionnement
KnownReplicationMode	Décrit le mode de réplication pour la distribution dans Azure Compute Gallery. Omettez d’utiliser le mode par défaut (Plein).
KnownSharedImageStorageAccountType	Spécifie le type de compte de stockage à utiliser pour stocker la version de l’image de la galerie de calcul Azure.
KnownVersions	Versions d’API disponibles.

Functions

isRestError(unknown)	Typeguard pour RestError
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Crée un collecteur à partir de l’état sérialisé d’un autre collecteur. Cela peut être utile lorsque vous souhaitez créer des collecteurs sur un autre hôte ou qu’un collecteur doit être construit après que l’analyseur d’origine n’est pas dans l’étendue.

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

Informations relatives à la fonction

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Crée un collecteur à partir de l’état sérialisé d’un autre collecteur. Cela peut être utile lorsque vous souhaitez créer des collecteurs sur un autre hôte ou qu’un collecteur doit être construit après que l’analyseur d’origine n’est pas dans l’étendue.

function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Paramètres

client

ImageBuilderClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Retours

PollerLike<OperationState<TResult>, TResult>

Détails de variable

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type

RestErrorConstructor