@azure/arm-imagebuilder package

Interfacce

DataDisk

Proprietà del disco dati.

DistributeVersioner

Viene descritto come generare il nuovo numero di versione x.y.z per la distribuzione.

DistributeVersionerLatest

Genera il numero di versione che verrà aggiornato in base ai numeri di versione esistenti.

DistributeVersionerSource

Genera il numero di versione in base al numero di versione dell'immagine di origine

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite.

ImageBuilderClientOptionalParams

Parametri facoltativi per il client.

ImageTemplate

Il modello di immagine è una risorsa arm gestita dal provider Microsoft.VirtualMachineImages

ImageTemplateAutoRun

Indica se il modello di immagine deve essere compilato in base alla creazione/aggiornamento

ImageTemplateCustomizer

Descrive un'unità di personalizzazione delle immagini

ImageTemplateDistributor

Oggetto di distribuzione generico

ImageTemplateFileCustomizer

Carica i file nelle macchine virtuali (Linux, Windows). Corrisponde al provisioner di file packer

ImageTemplateFileValidator

Carica i file necessari per la convalida nelle macchine virtuali (Linux, Windows). Corrisponde al provisioner di file packer

ImageTemplateIdentity

Identità per il modello di immagine.

ImageTemplateInVMValidator

Descrive un'unità di in-VM convalida dell'immagine

ImageTemplateLastRunStatus

Descrive lo stato più recente dell'esecuzione di un modello di immagine

ImageTemplateManagedImageDistributor

Distribuire come immagine del disco gestito.

ImageTemplateManagedImageSource

Descrive un'origine immagine che è un'immagine gestita nella sottoscrizione del cliente. Questa immagine deve trovarsi nella stessa sottoscrizione e nella stessa area del modello di Image Builder.

ImageTemplatePlatformImageSource

Descrive un'origine immagine da immagini della raccolta di Azure.

ImageTemplatePowerShellCustomizer

Esegue l'oggetto PowerShell specificato nella macchina virtuale (Windows). Corrisponde al provisioner powershell packer. È possibile specificare esattamente uno di "scriptUri" o "inline".

ImageTemplatePowerShellValidator

Esegue lo script di PowerShell specificato durante la fase di convalida (Windows). Corrisponde al provisioner powershell packer. È possibile specificare esattamente uno di "scriptUri" o "inline".

ImageTemplateProperties

Descrive le proprietà di un template di immagine

ImageTemplatePropertiesErrorHandling

Opzioni di gestione degli errori in caso di errore di compilazione

ImageTemplatePropertiesOptimize

Specifica l'ottimizzazione da eseguire sull'immagine.

ImageTemplatePropertiesOptimizeVmBoot

L'ottimizzazione viene applicata all'immagine per un avvio di macchina virtuale più veloce.

ImageTemplatePropertiesOptimizeWorkload

L'ottimizzazione viene applicata all'immagine per carichi di lavoro specifici.

ImageTemplatePropertiesValidate

Opzioni di configurazione e elenco di convalide da eseguire sull'immagine risultante.

ImageTemplateRestartCustomizer

Riavvia una macchina virtuale e attende che torni online (Windows). Corrisponde al provisioner windows-restart packer

ImageTemplateSharedImageDistributor

Distribuire tramite La raccolta di calcolo di Azure.

ImageTemplateSharedImageVersionSource

Descrive un'origine immagine che rappresenta una versione dell'immagine in una raccolta di calcolo di Azure o in una raccolta condivisa diretta.

ImageTemplateShellCustomizer

Esegue uno script della shell durante la fase di personalizzazione (Linux). Corrisponde al provisioner della shell Packer. È possibile specificare esattamente uno di "scriptUri" o "inline".

ImageTemplateShellValidator

Esegue lo script della shell specificato durante la fase di convalida (Linux). Corrisponde al provisioner della shell Packer. È possibile specificare esattamente uno di "scriptUri" o "inline".

ImageTemplateSource

Descrive un'origine immagine di macchina virtuale per la compilazione, la personalizzazione e la distribuzione

ImageTemplateUpdateParameters

Parametri per l'aggiornamento di un modello di immagine.

ImageTemplateUpdateParametersProperties

Parametri per l'aggiornamento di un modello di immagine.

ImageTemplateVhdDistributor

Distribuire tramite disco rigido virtuale in un account di archiviazione.

ImageTemplateVmProfile

Descrive le macchine virtuali usate per compilare e convalidare le immagini

ImageTemplateWindowsUpdateCustomizer

Installa gli aggiornamenti di Windows. Corrisponde a Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Operation

Operazione DELL'API REST

OperationDisplay

Oggetto che descrive l'operazione.

OperationsListOptionalParams

Parametri facoltativi.

OperationsOperations

Interfaccia che rappresenta un'operazione operativa.

PageSettings

Opzioni per il metodo byPage

PagedAsyncIterableIterator

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

PlatformImagePurchasePlan

Configurazione del piano di acquisto per l'immagine della piattaforma.

ProvisioningError

Descrive l'errore che si è verificato durante la creazione o l'aggiornamento di un modello di immagine

ProxyResource

Definizione del modello di risorse per una risorsa proxy di Azure Resource Manager. Non avrà tag e una posizione

Resource

Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager

RestorePollerOptions
RunOutput

Rappresenta un output creato eseguendo un modello di immagine.

RunOutputProperties

Descrive le proprietà di un'uscita di run

SimplePollerLike

Un semplice poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

SourceImageTriggerProperties

Proprietà del tipo di trigger SourceImage

SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TargetRegion

Descrive le informazioni sull'area di destinazione.

TrackedResource

La definizione del modello di risorsa per una risorsa di livello superiore di Azure Resource Manager con "tag" e "location"

Trigger

Rappresenta un trigger che può richiamare una compilazione di modelli di immagine.

TriggerProperties

Descrive le proprietà di un trigger

TriggerStatus

Descrive lo stato di un trigger

TriggersCreateOrUpdateOptionalParams

Parametri facoltativi.

TriggersDeleteOptionalParams

Parametri facoltativi.

TriggersGetOptionalParams

Parametri facoltativi.

TriggersListByImageTemplateOptionalParams

Parametri facoltativi.

TriggersOperations

Interfaccia che rappresenta un'operazione di Triggers.

UserAssignedIdentity

Proprietà di identità assegnate dall'utente

VirtualMachineImageTemplatesCancelOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesDeleteOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesGetOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesListOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesOperations

Interfaccia che rappresenta un'operazione VirtualMachineImageTemplates.

VirtualMachineImageTemplatesRunOptionalParams

Parametri facoltativi.

VirtualMachineImageTemplatesUpdateOptionalParams

Parametri facoltativi.

VirtualNetworkConfig

Configurazione della rete virtuale.

Alias tipo

AutoRunState

L'abilitazione di questo campo attiverà una compilazione automatica alla creazione o all'aggiornamento del modello di immagine.

AzureSupportedClouds

I valori supportati per l'impostazione cloud come tipo letterale stringa

ContinuablePage

Interfaccia che descrive una pagina di risultati.

CreatedByType

Tipo di entità che ha creato la risorsa.
KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

User: l'entità è stata creata da un utente.
'applicazione: l'entità è stata creata da un'applicazione.
ManagedIdentity: l'entità è stata creata da un'identità gestita.
Key: l'entità è stata creata da una chiave.

DistributeVersionerUnion

Alias per DistributeVersionerUnion

ImageTemplateCustomizerUnion

Alias per ImageTemplateCustomizerUnion

ImageTemplateDistributorUnion

Alias per ImageTemplateDistributorUnion

ImageTemplateInVMValidatorUnion

Alias for ImageTemplateInVMValidatorUnion

ImageTemplateSourceUnion

Alias per ImageTemplateSourceUnion

OnBuildError

Comportamento di gestione degli errori in caso di fallimento della compilazione
KnownOnBuildError può essere usato in modo intercambiabile con OnBuildError, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Pulizia: Pulizia
Annulla: annulla

ProvisioningErrorCode

Codice di errore del fallimento del provisioning
KnownProvisioningErrorCode può essere usato in modo intercambiabile con ProvisioningErrorCode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

TipoFonteMale: Tipo Sorgente Scorretta
Pessimi PIRSource: BadPIRSource
BadManagedImageSource: BadManagedImageSource
MaleCondivisaImmagineVersionFonte: BruttaImmagineCondivisaSorgente
Tipo di personalizzatore sbagliato: Tipo di personalizzatore scorrevole
Tipo di personalizzatore non supportato: Tipo di personalizzatore non supportato
NoCustomizerScript: NoCustomizerScript
BadValidatorType: BadValidatorType
UnsupportedValidatorType: UnsupportedValidatorType
NoValidatorScript: NoValidatorScript
TipoDistribuzioneCattiva: TipoDistribuzione Cattiva
BadSharedImageDistribute: BadSharedImageDistribute
Gruppo RisorseDifficoltà: Gruppo RisorseDifficoltàStagione
ServerError: ServerError
Altro: Altro

ProvisioningState

Stato di provisioning della risorsa

ReplicationMode

Descrive la modalità di replicazione per la distribuzione in Azure Compute Gallery. Ometti di usare il predefinito (Full).
KnownReplicationMode può essere usato in modo intercambiabile con ReplicationMode, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Completa: modalità replicazione completa
Superficiale: modalità di replicazione superficiale

ResourceIdentityType

Tipo di identità usata per il modello di immagine. Il tipo 'None' rimuoverà le identità dal modello di immagine.

RunState

Stato dell'ultima corsa

RunSubState

Sotto-stato dell'ultima corsa

SharedImageStorageAccountType

Specifica il tipo di account di archiviazione da utilizzare per memorizzare la versione dell'immagine Azure Compute Gallery.
KnownSharedImageStorageAccountType può essere usato in modo intercambiabile con SharedImageStorageAccountType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Standard_LRS: Standard_LRS
Standard_ZRS: Standard_ZRS
Premium_LRS: Premium_LRS

TriggerPropertiesUnion

Alias per TriggerPropertiesUnion

VMBootOptimizationState

L'abilitazione di questo campo migliorerà il tempo di avvio della macchina virtuale ottimizzando l'output finale dell'immagine personalizzata.

WorkloadOptimizationState

Abilitando questo campo, le immagini VM si ottimizzano per carichi di lavoro specifici.

Enumerazioni

AzureClouds

Un enum per descrivere gli ambienti Azure Cloud.

KnownCreatedByType

Tipo di entità che ha creato la risorsa.

KnownOnBuildError

Comportamento di gestione degli errori in caso di fallimento della compilazione

KnownProvisioningErrorCode

Codice di errore del fallimento del provisioning

KnownReplicationMode

Descrive la modalità di replicazione per la distribuzione in Azure Compute Gallery. Ometti di usare il predefinito (Full).

KnownSharedImageStorageAccountType

Specifica il tipo di account di archiviazione da utilizzare per memorizzare la versione dell'immagine Azure Compute Gallery.

KnownVersions

Versioni dell'API disponibili.

Funzioni

isRestError(unknown)

Typeguard per RestError

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

Crea un poller dallo stato serializzato di un altro poller. Ciò può essere utile quando si desidera creare poller su un host diverso o quando è necessario creare un poller dopo che quello originale non è incluso nell'ambito.

Variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e

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

Crea un poller dallo stato serializzato di un altro poller. Ciò può essere utile quando si desidera creare poller su un host diverso o quando è necessario creare un poller dopo che quello originale non è incluso nell'ambito.

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

Parametri

serializedState

string

sourceOperation

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

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo