Partager via


@azure/arm-imagebuilder package

Classes

ImageBuilderClient

Interfaces

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é. (Cela suit également le format de réponse d’erreur OData.).

ImageBuilderClientOptionalParams

Paramètres facultatifs.

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

ImageTemplateListResult

Résultat de l’opération Répertorier les modèles 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 ».

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.

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.

OperationListResult

Résultat de la requête pour répertorier les opérations de l’API REST. Il contient une liste d’opérations et une URL nextLink pour obtenir le jeu de résultats suivant.

Operations

Interface représentant une opération.

OperationsListNextOptionalParams

Paramètres facultatifs.

OperationsListOptionalParams

Paramètres facultatifs.

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

RunOutput

Représente une sortie créée en exécutant un modèle d’image.

RunOutputCollection

Résultat de l’opération de sorties d’exécution de liste

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.

TriggerCollection

Résultat de l’opération des déclencheurs de liste

TriggerProperties

Décrit les propriétés d’un déclencheur

TriggerStatus

Décrit l’état d’un déclencheur

Triggers

Interface représentant un déclencheur.

TriggersCreateOrUpdateOptionalParams

Paramètres facultatifs.

TriggersDeleteHeaders

Définit des en-têtes pour l’opération Triggers_delete.

TriggersDeleteOptionalParams

Paramètres facultatifs.

TriggersGetOptionalParams

Paramètres facultatifs.

TriggersListByImageTemplateNextOptionalParams

Paramètres facultatifs.

TriggersListByImageTemplateOptionalParams

Paramètres facultatifs.

UserAssignedIdentity

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

VirtualMachineImageTemplates

Interface représentant un VirtualMachineImageTemplates.

VirtualMachineImageTemplatesCancelOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesDeleteHeaders

Définit des en-têtes pour l’opération de VirtualMachineImageTemplates_delete.

VirtualMachineImageTemplatesDeleteOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesGetOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListNextOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesRunOptionalParams

Paramètres facultatifs.

VirtualMachineImageTemplatesUpdateOptionalParams

Paramètres facultatifs.

VirtualNetworkConfig

Configuration du réseau virtuel.

Alias de type

AutoRunState

Définit des valeurs pour AutoRunState.

CreatedByType

Définit des valeurs pour CreatedByType.
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
Application
managedIdentity
clé

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

Définit des valeurs pour OnBuildError.
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

de nettoyage
abandonner

OperationsListNextResponse

Contient des données de réponse pour l’opération listNext.

OperationsListResponse

Contient des données de réponse pour l’opération de liste.

ProvisioningErrorCode

Définit des valeurs pour ProvisioningErrorCode.
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

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
badSharedImageDistribute
BadStagingResourceGroup
ServerError
Autres

ProvisioningState

Définit des valeurs pour ProvisioningState.

ResourceIdentityType

Définit des valeurs pour ResourceIdentityType.

RunState

Définit des valeurs pour RunState.

RunSubState

Définit des valeurs pour RunSubState.

SharedImageStorageAccountType

Définit des valeurs pour SharedImageStorageAccountType.
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_ZRS
Premium_LRS

TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

TriggersDeleteResponse

Contient des données de réponse pour l’opération de suppression.

TriggersGetResponse

Contient des données de réponse pour l’opération d’obtention.

TriggersListByImageTemplateNextResponse

Contient des données de réponse pour l’opération listByImageTemplateNext.

TriggersListByImageTemplateResponse

Contient des données de réponse pour l’opération listByImageTemplate.

VMBootOptimizationState

Définit des valeurs pour VMBootOptimizationState.

VirtualMachineImageTemplatesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

VirtualMachineImageTemplatesDeleteResponse

Contient des données de réponse pour l’opération de suppression.

VirtualMachineImageTemplatesGetResponse

Contient des données de réponse pour l’opération d’obtention.

VirtualMachineImageTemplatesGetRunOutputResponse

Contient des données de réponse pour l’opération getRunOutput.

VirtualMachineImageTemplatesListByResourceGroupNextResponse

Contient des données de réponse pour l’opération listByResourceGroupNext.

VirtualMachineImageTemplatesListByResourceGroupResponse

Contient des données de réponse pour l’opération listByResourceGroup.

VirtualMachineImageTemplatesListNextResponse

Contient des données de réponse pour l’opération listNext.

VirtualMachineImageTemplatesListResponse

Contient des données de réponse pour l’opération de liste.

VirtualMachineImageTemplatesListRunOutputsNextResponse

Contient des données de réponse pour l’opération listRunOutputsNext.

VirtualMachineImageTemplatesListRunOutputsResponse

Contient des données de réponse pour l’opération listRunOutputs.

VirtualMachineImageTemplatesUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

Énumérations

KnownCreatedByType

Valeurs connues de CreatedByType que le service accepte.

KnownOnBuildError

Valeurs connues de OnBuildError que le service accepte.

KnownProvisioningErrorCode

Valeurs connues de ProvisioningErrorCode que le service accepte.

KnownSharedImageStorageAccountType

Valeurs connues de SharedImageStorageAccountType que le service accepte.

Functions

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet qui accède à value sur IteratorResult à partir d’un itérateur byPage.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() pendant les appels futurs.