@azure/arm-imagebuilder package

Gränssnitt

DataDisk

Datadiskegenskaper.

DistributeVersioner

Beskriver hur du genererar nytt x.y.z-versionsnummer för distribution.

DistributeVersionerLatest

Genererar versionsnummer som ska vara senaste baserat på befintliga versionsnummer.

DistributeVersionerSource

Genererar versionsnummer baserat på versionsnumret för källbilden

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder.

ImageBuilderClientOptionalParams

Valfria parametrar för klienten.

ImageTemplate

Bildmall är en ARM-resurs som hanteras av Microsoft.VirtualMachineImages-providern

ImageTemplateAutoRun

Anger om avbildningsmallen måste byggas på skapa/uppdatera

ImageTemplateCustomizer

Beskriver en enhet för bildanpassning

ImageTemplateDistributor

Allmänt distributionsobjekt

ImageTemplateFileCustomizer

Laddar upp filer till virtuella datorer (Linux, Windows). Motsvarar Packer-filetableraren

ImageTemplateFileValidator

Laddar upp filer som krävs för validering till virtuella datorer (Linux, Windows). Motsvarar Packer-filetableraren

ImageTemplateIdentity

Identitet för bildmallen.

ImageTemplateInVMValidator

Beskriver en enhet med in-VM validering av avbildning

ImageTemplateLastRunStatus

Beskriver den senaste statusen för att köra en avbildningsmall

ImageTemplateManagedImageDistributor

Distribuera som en hanterad diskbild.

ImageTemplateManagedImageSource

Beskriver en bildkälla som är en hanterad avbildning i en kundprenumeration. Den här avbildningen måste finnas i samma prenumeration och region som image builder-mallen.

ImageTemplatePlatformImageSource

Beskriver en bildkälla från Azure Gallery Images.

ImageTemplatePowerShellCustomizer

Kör angiven PowerShell på den virtuella datorn (Windows). Motsvarar Packer powershell-provisioner. Exakt en av "scriptUri" eller "infogade" kan anges.

ImageTemplatePowerShellValidator

Kör det angivna PowerShell-skriptet under valideringsfasen (Windows). Motsvarar Packer powershell-provisioner. Exakt en av "scriptUri" eller "infogade" kan anges.

ImageTemplateProperties

Beskriver egenskaperna hos en bildmall

ImageTemplatePropertiesErrorHandling

Felhanteringsalternativ vid ett byggfel

ImageTemplatePropertiesOptimize

Anger optimering som ska utföras på bilden.

ImageTemplatePropertiesOptimizeVmBoot

Optimering tillämpas på avbildningen för en snabbare vm-start.

ImageTemplatePropertiesOptimizeWorkload

Optimering appliceras på bilden för specifika arbetsbelastningar.

ImageTemplatePropertiesValidate

Konfigurationsalternativ och lista över valideringar som ska utföras på den resulterande avbildningen.

ImageTemplateRestartCustomizer

Startar om en virtuell dator och väntar på att den ska komma tillbaka online (Windows). Motsvarar Packer windows-restart provisioner

ImageTemplateSharedImageDistributor

Distribuera via Azure Compute Gallery.

ImageTemplateSharedImageVersionSource

Beskriver en bildkälla som är en avbildningsversion i ett Azure Compute-galleri eller ett direkt delat galleri.

ImageTemplateShellCustomizer

Kör ett gränssnittsskript under anpassningsfasen (Linux). Motsvarar Packer shell provisioner. Exakt en av "scriptUri" eller "infogade" kan anges.

ImageTemplateShellValidator

Kör det angivna shell-skriptet under valideringsfasen (Linux). Motsvarar Packer shell provisioner. Exakt en av "scriptUri" eller "infogade" kan anges.

ImageTemplateSource

Beskriver en virtuell dators avbildningskälla för att skapa, anpassa och distribuera

ImageTemplateUpdateParameters

Parametrar för uppdatering av en bildmall.

ImageTemplateUpdateParametersProperties

Parametrar för uppdatering av en bildmall.

ImageTemplateVhdDistributor

Distribuera via virtuell hårddisk i ett lagringskonto.

ImageTemplateVmProfile

Beskriver de virtuella datorer som används för att skapa och verifiera avbildningar

ImageTemplateWindowsUpdateCustomizer

Installerar Windows-uppdateringar. Motsvarar Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Operation

En REST API-åtgärd

OperationDisplay

Objektet som beskriver åtgärden.

OperationsListOptionalParams

Valfria parametrar.

OperationsOperations

Gränssnitt som representerar en driftåtgärd.

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

PlatformImagePurchasePlan

Inköpsplanskonfiguration för plattformsbild.

ProvisioningError

Beskriver felet som uppstod när en avbildningsmall skapades eller uppdaterades

ProxyResource

Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

RestorePollerOptions
RunOutput

Representerar ett utdata som skapades genom att köra en avbildningsmall.

RunOutputProperties

Beskriver egenskaperna hos en körd utgång

SimplePollerLike

En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.

SourceImageTriggerProperties

Egenskaper för SourceImage-typ av utlösare

SystemData

Metadata som rör skapande och senaste ändring av resursen.

TargetRegion

Beskriver information om målregionen.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

Trigger

Representerar en utlösare som kan anropa en avbildningsmallsversion.

TriggerProperties

Beskriver egenskaperna för en utlösare

TriggerStatus

Beskriver status för en utlösare

TriggersCreateOrUpdateOptionalParams

Valfria parametrar.

TriggersDeleteOptionalParams

Valfria parametrar.

TriggersGetOptionalParams

Valfria parametrar.

TriggersListByImageTemplateOptionalParams

Valfria parametrar.

TriggersOperations

Gränssnittet representerar en triggers operationer.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

VirtualMachineImageTemplatesCancelOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesDeleteOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesGetOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesOperations

Gränssnitt som representerar VirtualMachineImageTemplates-operationer.

VirtualMachineImageTemplatesRunOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesUpdateOptionalParams

Valfria parametrar.

VirtualNetworkConfig

Konfiguration av virtuellt nätverk.

Typalias

AutoRunState

Om du aktiverar det här fältet utlöses en automatisk version av skapande eller uppdatering av avbildningsmallar.

AzureSupportedClouds

De värden som stöds för molninställningen som en strängliteraltyp

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CreatedByType

Den typ av entitet som skapade resursen.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.

DistributeVersionerUnion

Alias för DistributeVersionerUnion

ImageTemplateCustomizerUnion

Alias för ImageTemplateCustomizerUnion

ImageTemplateDistributorUnion

Alias för ImageTemplateDistributorUnion

ImageTemplateInVMValidatorUnion

Alias för ImageTemplateInVMValidatorUnion

ImageTemplateSourceUnion

Alias för ImageTemplateSourceUnion

OnBuildError

Felhanteringsbeteende vid byggfel
KnownOnBuildError- kan användas utbytbart med OnBuildError innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Städning: Städning
avbryt: avbryt

ProvisioningErrorCode

Felkod för provisioneringsfelet
KnownProvisioningErrorCode- kan användas omväxlande med ProvisioningErrorCode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

DåligKällaTyp: DåligKällaTyp
BadPIRSource: BadPIRSource
BadManagedImageSource: BadManagedImageSource
BadSharedImageVersionKälla: BadSharedImageVersionKälla
BadCustomizerType: BadCustomizerType
OstöddAnpassningstyp: Ej stöddAnpassningstyp.
NoCustomizerScript: NoCustomizerScript
DåligValiderareTyp: DåligValiderareTyp
UnsupportedValidatorType: UnsupportedValidatorType
NoValidatorScript: NoValidatorScript
BadDistributeType: BadDistributeType
DåligDeladeImageDistribuera: DåligDeladeImageDistribuera
BadStagingResourceGroup: BadStagingResourceGroup
ServerError: ServerError
Övrigt: Övrigt

ProvisioningState

Etableringstillstånd för resursen

ReplicationMode

Beskriver replikationsläge för distribution i Azure Compute Gallery. Utelämna att använda standarden (Full).
KnownReplicationMode kan användas utbytbart med ReplicationMode innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Full: Fullt replikationsläge
Grunt: Grunt replikationsläge

ResourceIdentityType

Den typ av identitet som används för bildmallen. Typen "Ingen" tar bort alla identiteter från bildmallen.

RunState

Tillstånd för senaste körningen

RunSubState

Delstat av senaste körningen

SharedImageStorageAccountType

Specificerar vilken lagringskontotyp som ska användas för att lagra Azure Compute Gallery-bildversionen i.
KnownSharedImageStorageAccountType kan användas utbytbart med SharedImageStorageAccountType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Standard_LRS: Standard_LRS
Standard_ZRS: Standard_ZRS
Premium_LRS: Premium_LRS

TriggerPropertiesUnion

Alias för TriggerPropertiesUnion

VMBootOptimizationState

Om du aktiverar det här fältet förbättras starttiden för virtuella datorer genom att optimera de slutliga anpassade avbildningsutdata.

WorkloadOptimizationState

Att aktivera detta fält optimerar VM-avbildningar för specifika arbetsbelastningar.

Uppräkningar

AzureClouds

Ett enum för att beskriva Azure Cloud-miljöer.

KnownCreatedByType

Den typ av entitet som skapade resursen.

KnownOnBuildError

Felhanteringsbeteende vid byggfel

KnownProvisioningErrorCode

Felkod för provisioneringsfelet

KnownReplicationMode

Beskriver replikationsläge för distribution i Azure Compute Gallery. Utelämna att använda standarden (Full).

KnownSharedImageStorageAccountType

Specificerar vilken lagringskontotyp som ska användas för att lagra Azure Compute Gallery-bildversionen i.

KnownVersions

Tillgängliga API-versioner.

Funktioner

isRestError(unknown)

Typeguard för RestError

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

Skapar en avsökare från det serialiserade tillståndet för en annan avsökning. Detta kan vara användbart när du vill skapa avsökare på en annan värd eller om en avsökning måste konstrueras efter att den ursprungliga inte omfattas.

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

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

Skapar en avsökare från det serialiserade tillståndet för en annan avsökning. Detta kan vara användbart när du vill skapa avsökare på en annan värd eller om en avsökning måste konstrueras efter att den ursprungliga inte omfattas.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ