Freigeben über


@azure/arm-imagebuilder package

Klassen

ImageBuilderClient

Schnittstellen

DistributeVersioner

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

DistributeVersionerLatest

Generiert versionsnummer, die auf vorhandenen Versionsnummern basiert.

DistributeVersionerSource

Generiert Versionsnummer basierend auf der Versionsnummer des Quellbilds

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

ImageBuilderClientOptionalParams

Optionale Parameter.

ImageTemplate

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

ImageTemplateAutoRun

Gibt an, ob die Bildvorlage auf "Erstellen/Aktualisieren" erstellt/aktualisiert werden muss.

ImageTemplateCustomizer

Beschreibt eine Einheit der Bildanpassung

ImageTemplateDistributor

Generisches Verteilungsobjekt

ImageTemplateFileCustomizer

Lädt Dateien auf VMs hoch (Linux, Windows). Entspricht dem Packer-Dateibereitstellungsprogramm

ImageTemplateFileValidator

Lädt Dateien hoch, die für die Überprüfung auf VMs (Linux, Windows) erforderlich sind. Entspricht dem Packer-Dateibereitstellungsprogramm

ImageTemplateIdentity

Identität für die Bildvorlage.

ImageTemplateInVMValidator

Beschreibt eine Einheit der in-VM Überprüfung des Bilds

ImageTemplateLastRunStatus

Beschreibt den neuesten Status der Ausführung einer Bildvorlage.

ImageTemplateListResult

Das Ergebnis des Vorgangs "Listenbildvorlagen"

ImageTemplateManagedImageDistributor

Als verwaltetes Datenträgerimage verteilen.

ImageTemplateManagedImageSource

Beschreibt eine Bildquelle, die ein verwaltetes Bild im Kundenabonnement ist. Dieses Bild 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 der VM (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

ImageTemplatePowerShellValidator

Führt das angegebene PowerShell-Skript während der Überprüfungsphase (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

ImageTemplatePropertiesErrorHandling

Fehlerbehandlungsoptionen bei Einem Buildfehler

ImageTemplatePropertiesOptimize

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

ImageTemplatePropertiesOptimizeVmBoot

Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet.

ImageTemplatePropertiesValidate

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

ImageTemplateRestartCustomizer

Startet einen virtuellen Computer neu und wartet darauf, dass er wieder online (Windows) zurückkommt. Entspricht packer windows-restart provisioner

ImageTemplateSharedImageDistributor

Verteilen über den Azure Compute Gallery.

ImageTemplateSharedImageVersionSource

Beschreibt eine Bildquelle, die eine Bildversion in einem Azure Compute Gallery oder einem direkten freigegebenen Katalog ist.

ImageTemplateShellCustomizer

Führt während der Anpassungsphase (Linux) ein Shellskript aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

ImageTemplateShellValidator

Führt das angegebene Shellskript während der Validierungsphase (Linux) aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

ImageTemplateSource

Beschreibt eine Imagequelle für virtuelle Computer 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

Rest-API-Vorgang

OperationDisplay

Das Objekt, das den Vorgang beschreibt.

OperationListResult

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

Operations

Schnittstelle, die eine Operation darstellt.

OperationsListNextOptionalParams

Optionale Parameter.

OperationsListOptionalParams

Optionale Parameter.

PlatformImagePurchasePlan

Kaufplankonfiguration für Plattformimages.

ProvisioningError

Beschreibt den Fehler beim Erstellen oder Aktualisieren einer Bildvorlage.

ProxyResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine 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 Bildvorlage erstellt wurde.

RunOutputCollection

Das Ergebnis des Ausgabevorgangs "List run"

SourceImageTriggerProperties

Eigenschaften des Triggertyps "SourceImage"

SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

TargetRegion

Beschreibt die Zielregioneninformationen.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"

Trigger

Stellt einen Trigger dar, der einen Imagevorlagenbuild aufrufen kann.

TriggerCollection

Das Ergebnis des Listenauslöservorgangs

TriggerProperties

Beschreibt die Eigenschaften eines Triggers.

TriggerStatus

Beschreibt den Status eines Triggers.

Triggers

Schnittstelle, die einen Trigger darstellt.

TriggersCreateOrUpdateOptionalParams

Optionale Parameter.

TriggersDeleteHeaders

Definiert Kopfzeilen für Triggers_delete Vorgang.

TriggersDeleteOptionalParams

Optionale Parameter.

TriggersGetOptionalParams

Optionale Parameter.

TriggersListByImageTemplateNextOptionalParams

Optionale Parameter.

TriggersListByImageTemplateOptionalParams

Optionale Parameter.

UserAssignedIdentity

Benutzer zugewiesene Identitätseigenschaften

VirtualMachineImageTemplates

Schnittstelle, die eine VirtualMachineImageTemplates darstellt.

VirtualMachineImageTemplatesCancelOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Optionale Parameter.

VirtualMachineImageTemplatesDeleteHeaders

Definiert Kopfzeilen 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

Konfiguration des virtuellen Netzwerks.

Typaliase

AutoRunState

Definiert Werte für AutoRunState.

CreatedByType

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

Bekannte Werte, die vom Dienst unterstützt werden


Application
ManagedIdentity-
Key-

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

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

Bekannte Werte, die vom Dienst unterstützt werden

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 austauschbar mit ProvisioningErrorCode verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

BadSourceType-
BadPIRSource-
BadManagedImageSource-
BadSharedImageVersionSource-
BadCustomizerType-
Nicht unterstützteCustomizerType-
NoCustomizerScript-
BadValidatorType-
UnsupportedValidatorType-
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 austauschbar mit SharedImageStorageAccountType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

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)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

Details zur Funktion

getContinuationToken(unknown)

Gibt aufgrund der letzten .value, die vom byPage Iterator erstellt wurde, ein Fortsetzungstoken zurück, das verwendet werden kann, um mit dem Paging ab diesem Zeitpunkt zu beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameter

page

unknown

Ein Objekt vom Zugriff auf value im IteratorResult aus einem byPage Iterator.

Gibt zurück

string | undefined

Das Fortsetzungstoken, das während zukünftiger Aufrufe an byPage() übergeben werden kann.