Freigeben über


@azure/arm-imagebuilder package

Klassen

ImageBuilderClient

Schnittstellen

DistributeVersioner

Beschreibt, wie eine neue x.y.z-Versionsnummer für die Verteilung generiert wird.

DistributeVersionerLatest

Generiert versionsnummer, die auf der Grundlage vorhandener Versionsnummern die neueste ist.

DistributeVersionerSource

Generiert die Versionsnummer basierend auf der Versionsnummer des Quellimages.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.).

ImageBuilderClientOptionalParams

Optionale Parameter.

ImageTemplate

Bildvorlage ist eine ARM-Ressource, die vom Microsoft.VirtualMachineImages-Anbieter verwaltet wird

ImageTemplateCustomizer

Beschreibt eine Einheit der Bildanpassung

ImageTemplateDistributor

Generisches Verteilungsobjekt

ImageTemplateFileCustomizer

Lädt Dateien auf virtuelle Computer (Linux, Windows) hoch. Entspricht Packer-Dateibereitstellung

ImageTemplateFileValidator

Lädt Dateien, die für die Validierung erforderlich sind, auf virtuelle Computer (Linux, Windows) hoch. Entspricht Packer-Dateibereitstellung

ImageTemplateIdentity

Identität für die Bildvorlage.

ImageTemplateInVMValidator

Beschreibt eine Einheit der VM-Überprüfung des Images

ImageTemplateLastRunStatus

Beschreibt den neuesten status der Ausführung einer Bildvorlage

ImageTemplateListResult

Das Ergebnis des Vorgangs Listenbildvorlagen

ImageTemplateManagedImageDistributor

Verteilen sie als verwaltetes Datenträgerimage.

ImageTemplateManagedImageSource

Beschreibt eine Bildquelle, bei der es sich um ein verwaltetes Image im Kundenabonnement handelt. Dieses Image muss sich in demselben Abonnement und derselben Region wie die Image Builder-Vorlage befinden.

ImageTemplatePlatformImageSource

Beschreibt eine Bildquelle aus Azure Gallery Images.

ImageTemplatePowerShellCustomizer

Führt die angegebene PowerShell auf dem virtuellen Computer (Windows) aus. Entspricht der Packer PowerShell-Bereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplatePowerShellValidator

Führt das angegebene PowerShell-Skript während der Überprüfungsphase (Windows) aus. Entspricht der Packer PowerShell-Bereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplatePropertiesErrorHandling

Fehlerbehandlungsoptionen bei einem Buildfehler

ImageTemplatePropertiesOptimize

Gibt die Optimierung an, die für das Image ausgeführt werden soll.

ImageTemplatePropertiesOptimizeVmBoot

Die Optimierung wird auf das Image angewendet, um einen schnelleren VM-Start zu ermöglichen.

ImageTemplatePropertiesValidate

Konfigurationsoptionen und Liste der Validierungen, die für das resultierende Image ausgeführt werden sollen.

ImageTemplateRestartCustomizer

Startet einen virtuellen Computer neu und wartet, bis er wieder online ist (Windows). Entspricht packer windows-restart provisioner

ImageTemplateSharedImageDistributor

Verteilen sie über den Azure Compute-Katalog.

ImageTemplateSharedImageVersionSource

Beschreibt eine Imagequelle, bei der es sich um eine Imageversion in einem Azure Compute-Katalog oder einem direct Shared Gallery handelt.

ImageTemplateShellCustomizer

Führt ein Shellskript während der Anpassungsphase (Linux) aus. Entspricht der Packer-Shellbereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplateShellValidator

Führt das angegebene Shellskript während der Validierungsphase (Linux) aus. Entspricht der Packer-Shellbereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplateSource

Beschreibt eine Vm-Imagequelle zum Erstellen, Anpassen und Verteilen

ImageTemplateUpdateParameters

Parameter zum Aktualisieren einer Bildvorlage.

ImageTemplateUpdateParametersProperties

Parameter zum Aktualisieren einer Bildvorlage.

ImageTemplateVhdDistributor

Verteilen sie über VHD in einem Speicherkonto.

ImageTemplateVmProfile

Beschreibt die virtuellen Computer, die zum Erstellen und Überprüfen von Images verwendet werden.

ImageTemplateWindowsUpdateCustomizer

Installiert Windows Updates. Entspricht Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Operation

Ein REST-API-Vorgang

OperationDisplay

Das Objekt, das den Vorgang beschreibt.

OperationListResult

Ergebnis der Anforderung, REST-API-Vorgänge aufzulisten. Sie enthält eine Liste der Vorgänge und eine URL nextLink, um den nächsten Satz von Ergebnissen abzurufen.

Operations

Schnittstelle, die einen Vorgang darstellt.

OperationsListNextOptionalParams

Optionale Parameter.

OperationsListOptionalParams

Optionale Parameter.

PlatformImagePurchasePlan

Kaufplankonfiguration für das Plattformimage.

ProvisioningError

Beschreibt den Fehler beim Erstellen oder Aktualisieren einer Bildvorlage.

ProxyResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es verfügt nicht über Tags und einen Speicherort.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden

RunOutput

Stellt eine Ausgabe dar, die durch Ausführen einer Imagevorlage erstellt wurde.

RunOutputCollection

Das Ergebnis des Listenausführungsausgabevorgangs

SourceImageTriggerProperties

Eigenschaften des SourceImage-Triggers

SystemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

TargetRegion

Beschreibt die Informationen zur Zielregion.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure-Resource Manager nachverfolgte Ressource der obersten Ebene mit "Tags" und einem "Standort"

Trigger

Stellt einen Trigger dar, der einen Imagevorlagenbuild aufrufen kann.

TriggerCollection

Das Ergebnis des Vorgangs "Listentrigger"

TriggerProperties

Beschreibt die Eigenschaften eines Triggers

TriggerStatus

Beschreibt die status eines Triggers.

Triggers

Schnittstelle, die einen Trigger darstellt.

TriggersCreateOrUpdateOptionalParams

Optionale Parameter.

TriggersDeleteHeaders

Definiert Header für Triggers_delete Vorgang.

TriggersDeleteOptionalParams

Optionale Parameter.

TriggersGetOptionalParams

Optionale Parameter.

TriggersListByImageTemplateNextOptionalParams

Optionale Parameter.

TriggersListByImageTemplateOptionalParams

Optionale Parameter.

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

VirtualMachineImageTemplates

Schnittstelle, die eine VirtualMachineImageTemplates darstellt.

VirtualMachineImageTemplatesCancelOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesDeleteHeaders

Definiert Header für VirtualMachineImageTemplates_delete Vorgang.

VirtualMachineImageTemplatesDeleteOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesGetOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListNextOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesRunOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesUpdateOptionalParams

Optionale Parameter.

VirtualNetworkConfig

Virtual Network Konfiguration.

Typaliase

CreatedByType

Definiert Werte für CreatedByType.
KnownCreatedByType kann austauschbar mit CreatedByType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Benutzer
Anwendung
ManagedIdentity
Schlüssel

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

Definiert Werte für OnBuildError.
KnownOnBuildError kann austauschbar mit OnBuildError verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Bereinigung
Abbrechen

OperationsListNextResponse

Enthält Antwortdaten für den ListNext-Vorgang.

OperationsListResponse

Enthält Antwortdaten für den Listenvorgang.

ProvisioningErrorCode

Definiert Werte für ProvisioningErrorCode.
KnownProvisioningErrorCode kann austauschbar mit ProvisioningErrorCode verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
Nicht unterstütztCustomizerType
NoCustomizerScript
BadValidatorType
Nicht unterstütztValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Andere

ProvisioningState

Definiert Werte für ProvisioningState.

ResourceIdentityType

Definiert Werte für ResourceIdentityType.

RunState

Definiert Werte für RunState.

RunSubState

Definiert Werte für RunSubState.

SharedImageStorageAccountType

Definiert Werte für SharedImageStorageAccountType.
KnownSharedImageStorageAccountType kann austauschbar mit SharedImageStorageAccountType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Vom Dienst unterstützte bekannte Werte

Standard_LRS
Standard_ZRS
Premium_LRS

TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

TriggersDeleteResponse

Enthält Antwortdaten für den Löschvorgang.

TriggersGetResponse

Enthält Antwortdaten für den Get-Vorgang.

TriggersListByImageTemplateNextResponse

Enthält Antwortdaten für den ListByImageTemplateNext-Vorgang.

TriggersListByImageTemplateResponse

Enthält Antwortdaten für den ListByImageTemplate-Vorgang.

VMBootOptimizationState

Definiert Werte für VMBootOptimizationState.

VirtualMachineImageTemplatesCreateOrUpdateResponse

Enthält Antwortdaten für den CreateOrUpdate-Vorgang.

VirtualMachineImageTemplatesDeleteResponse

Enthält Antwortdaten für den Löschvorgang.

VirtualMachineImageTemplatesGetResponse

Enthält Antwortdaten für den Get-Vorgang.

VirtualMachineImageTemplatesGetRunOutputResponse

Enthält Antwortdaten für den getRunOutput-Vorgang.

VirtualMachineImageTemplatesListByResourceGroupNextResponse

Enthält Antwortdaten für den ListByResourceGroupNext-Vorgang.

VirtualMachineImageTemplatesListByResourceGroupResponse

Enthält Antwortdaten für den ListByResourceGroup-Vorgang.

VirtualMachineImageTemplatesListNextResponse

Enthält Antwortdaten für den ListNext-Vorgang.

VirtualMachineImageTemplatesListResponse

Enthält Antwortdaten für den Listenvorgang.

VirtualMachineImageTemplatesListRunOutputsNextResponse

Enthält Antwortdaten für den ListRunOutputsNext-Vorgang.

VirtualMachineImageTemplatesListRunOutputsResponse

Enthält Antwortdaten für den ListRunOutputs-Vorgang.

VirtualMachineImageTemplatesUpdateResponse

Enthält Antwortdaten für den Aktualisierungsvorgang.

Enumerationen

KnownCreatedByType

Bekannte Werte von CreatedByType , die der Dienst akzeptiert.

KnownOnBuildError

Bekannte Werte von OnBuildError , die der Dienst akzeptiert.

KnownProvisioningErrorCode

Bekannte Werte von ProvisioningErrorCode , die der Dienst akzeptiert.

KnownSharedImageStorageAccountType

Bekannte Werte von SharedImageStorageAccountType , die der Dienst akzeptiert.

Functions

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Bei der letzten .value , die byPage vom Iterator erzeugt wurde, gibt ein Fortsetzungstoken zurück, das verwendet werden kann, um die Paging von diesem Punkt später zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt, das von einem byPage Iterator auf iteratorResult zugreiftvalue.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das bei zukünftigen Aufrufen an byPage() übergeben werden kann.