Dela via


@azure/arm-imagebuilder package

Klasser

ImageBuilderClient

Gränssnitt

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. (Detta följer även formatet för OData-felsvar.).

ImageBuilderClientOptionalParams

Valfria parametrar.

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

ImageTemplateListResult

Resultatet av åtgärden List image templates (Lista bildmallar)

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.

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.

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.

OperationListResult

Resultatet av begäran om att lista REST API-åtgärder. Den innehåller en lista över åtgärder och en URL nextLink för att hämta nästa uppsättning resultat.

Operations

Gränssnitt som representerar en operation.

OperationsListNextOptionalParams

Valfria parametrar.

OperationsListOptionalParams

Valfria parametrar.

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

RunOutput

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

RunOutputCollection

Resultatet av listkörningens utdataå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.

TriggerCollection

Resultatet av åtgärden Listutlösare

TriggerProperties

Beskriver egenskaperna för en utlösare

TriggerStatus

Beskriver status för en utlösare

Triggers

Gränssnitt som representerar utlösare.

TriggersCreateOrUpdateOptionalParams

Valfria parametrar.

TriggersDeleteHeaders

Definierar rubriker för Triggers_delete åtgärd.

TriggersDeleteOptionalParams

Valfria parametrar.

TriggersGetOptionalParams

Valfria parametrar.

TriggersListByImageTemplateNextOptionalParams

Valfria parametrar.

TriggersListByImageTemplateOptionalParams

Valfria parametrar.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

VirtualMachineImageTemplates

Gränssnitt som representerar en VirtualMachineImageTemplates.

VirtualMachineImageTemplatesCancelOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesDeleteHeaders

Definierar rubriker för VirtualMachineImageTemplates_delete åtgärd.

VirtualMachineImageTemplatesDeleteOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesGetOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListNextOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesRunOptionalParams

Valfria parametrar.

VirtualMachineImageTemplatesUpdateOptionalParams

Valfria parametrar.

VirtualNetworkConfig

Konfiguration av virtuellt nätverk.

Typalias

AutoRunState

Definierar värden för AutoRunState.

CreatedByType

Definierar värden för CreatedByType.
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
Program
ManagedIdentity
nyckel

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

Definierar värden för OnBuildError.
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

rensning
avbryta

OperationsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

OperationsListResponse

Innehåller svarsdata för liståtgärden.

ProvisioningErrorCode

Definierar värden för ProvisioningErrorCode.
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

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
CustomizerType- som inte stöds
NoCustomizerScript
BadValidatorType
ValidatorType-
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Andra

ProvisioningState

Definierar värden för ProvisioningState.

ResourceIdentityType

Definierar värden för ResourceIdentityType.

RunState

Definierar värden för RunState.

RunSubState

Definierar värden för RunSubState.

SharedImageStorageAccountType

Definierar värden för SharedImageStorageAccountType.
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_ZRS
Premium_LRS

TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

TriggersDeleteResponse

Innehåller svarsdata för borttagningsåtgärden.

TriggersGetResponse

Innehåller svarsdata för get-åtgärden.

TriggersListByImageTemplateNextResponse

Innehåller svarsdata för åtgärden listByImageTemplateNext.

TriggersListByImageTemplateResponse

Innehåller svarsdata för åtgärden listByImageTemplate.

VMBootOptimizationState

Definierar värden för VMBootOptimizationState.

VirtualMachineImageTemplatesCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

VirtualMachineImageTemplatesDeleteResponse

Innehåller svarsdata för borttagningsåtgärden.

VirtualMachineImageTemplatesGetResponse

Innehåller svarsdata för get-åtgärden.

VirtualMachineImageTemplatesGetRunOutputResponse

Innehåller svarsdata för åtgärden getRunOutput.

VirtualMachineImageTemplatesListByResourceGroupNextResponse

Innehåller svarsdata för åtgärden listByResourceGroupNext.

VirtualMachineImageTemplatesListByResourceGroupResponse

Innehåller svarsdata för åtgärden listByResourceGroup.

VirtualMachineImageTemplatesListNextResponse

Innehåller svarsdata för listNästa åtgärden.

VirtualMachineImageTemplatesListResponse

Innehåller svarsdata för liståtgärden.

VirtualMachineImageTemplatesListRunOutputsNextResponse

Innehåller svarsdata för åtgärden listRunOutputsNext.

VirtualMachineImageTemplatesListRunOutputsResponse

Innehåller svarsdata för åtgärden listRunOutputs.

VirtualMachineImageTemplatesUpdateResponse

Innehåller svarsdata för uppdateringsåtgärden.

Uppräkningar

KnownCreatedByType

Kända värden för CreatedByType- som tjänsten accepterar.

KnownOnBuildError

Kända värden för OnBuildError som tjänsten accepterar.

KnownProvisioningErrorCode

Kända värden för ProvisioningErrorCode som tjänsten accepterar.

KnownSharedImageStorageAccountType

Kända värden för SharedImageStorageAccountType som tjänsten accepterar.

Funktioner

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

Funktionsinformation

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

Ett objekt från att komma åt value på IteratorResult från en byPage iterator.

Returer

string | undefined

Fortsättningstoken som kan skickas till byPage() under framtida anrop.