@azure/arm-imagebuilder package

Interfejsy

DataDisk

Właściwości dysku danych.

DistributeVersioner

Opisuje sposób generowania nowego numeru wersji x.y.z dla dystrybucji.

DistributeVersionerLatest

Generuje numer wersji, który będzie najnowszy na podstawie istniejących numerów wersji.

DistributeVersionerSource

Generuje numer wersji na podstawie numeru wersji obrazu źródłowego

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.

ImageBuilderClientOptionalParams

Parametry opcjonalne dla klienta.

ImageTemplate

Szablon obrazu to zasób arm zarządzany przez dostawcę Microsoft.VirtualMachineImages

ImageTemplateAutoRun

Wskazuje, czy szablon obrazu musi być oparty na tworzeniu/aktualizowaniu

ImageTemplateCustomizer

Opisuje jednostkę dostosowywania obrazu

ImageTemplateDistributor

Obiekt rozkładu ogólnego

ImageTemplateFileCustomizer

Przekazuje pliki do maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików packer

ImageTemplateFileValidator

Przekazuje pliki wymagane do weryfikacji maszyn wirtualnych (Linux, Windows). Odpowiada aprowizatorowi plików packer

ImageTemplateIdentity

Tożsamość szablonu obrazu.

ImageTemplateInVMValidator

Opisuje jednostkę in-VM weryfikacji obrazu

ImageTemplateLastRunStatus

Opisuje najnowszy stan uruchamiania szablonu obrazu

ImageTemplateManagedImageDistributor

Dystrybuuj jako obraz dysku zarządzanego.

ImageTemplateManagedImageSource

Opisuje źródło obrazu, które jest obrazem zarządzanym w subskrypcji klienta. Ten obraz musi znajdować się w tej samej subskrypcji i regionie co szablon konstruktora obrazów.

ImageTemplatePlatformImageSource

Opisuje źródło obrazu z usługi Azure Gallery Images.

ImageTemplatePowerShellCustomizer

Uruchamia określony program PowerShell na maszynie wirtualnej (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

ImageTemplatePowerShellValidator

Uruchamia określony skrypt programu PowerShell w fazie walidacji (Windows). Odpowiada aprowizatorowi programu PowerShell Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

ImageTemplateProperties

Opisuje właściwości szablonu obrazu

ImageTemplatePropertiesErrorHandling

Opcje obsługi błędów po niepowodzeniu kompilacji

ImageTemplatePropertiesOptimize

Określa optymalizację do wykonania na obrazie.

ImageTemplatePropertiesOptimizeVmBoot

Optymalizacja jest stosowana na obrazie w celu szybszego rozruchu maszyny wirtualnej.

ImageTemplatePropertiesOptimizeWorkload

Optymalizacja jest stosowana na obrazie dla konkretnych obciążeń.

ImageTemplatePropertiesValidate

Opcje konfiguracji i lista weryfikacji, które mają zostać wykonane na obrazie wynikowym.

ImageTemplateRestartCustomizer

Uruchamia ponownie maszynę wirtualną i czeka na powrót do trybu online (Windows). Odpowiada aprowizatorowi ponownego uruchamiania systemu Windows Packer

ImageTemplateSharedImageDistributor

Dystrybucja za pośrednictwem galerii usługi Azure Compute.

ImageTemplateSharedImageVersionSource

Opisuje źródło obrazu, które jest wersją obrazu w galerii obliczeniowej platformy Azure lub w bezpośredniej galerii udostępnionej.

ImageTemplateShellCustomizer

Uruchamia skrypt powłoki w fazie dostosowywania (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

ImageTemplateShellValidator

Uruchamia określony skrypt powłoki w fazie walidacji (Linux). Odpowiada aprowizatorowi powłoki Packer. Można określić dokładnie jeden z parametrów "scriptUri" lub "inline".

ImageTemplateSource

Opisuje źródło obrazu maszyny wirtualnej do kompilowania, dostosowywania i dystrybucji

ImageTemplateUpdateParameters

Parametry służące do aktualizowania szablonu obrazu.

ImageTemplateUpdateParametersProperties

Parametry służące do aktualizowania szablonu obrazu.

ImageTemplateVhdDistributor

Dystrybuowanie za pośrednictwem wirtualnego dysku twardego na koncie magazynu.

ImageTemplateVmProfile

Opisuje maszyny wirtualne używane do kompilowania i weryfikowania obrazów

ImageTemplateWindowsUpdateCustomizer

Instaluje aktualizacje systemu Windows. Odpowiada usłudze Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Operation

Operacja interfejsu API REST

OperationDisplay

Obiekt opisujący operację.

OperationsListOptionalParams

Parametry opcjonalne.

OperationsOperations

Interfejs reprezentujący operacje Operations.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PlatformImagePurchasePlan

Konfiguracja planu zakupu dla obrazu platformy.

ProvisioningError

Opisuje błąd występujący podczas tworzenia lub aktualizowania szablonu obrazu

ProxyResource

Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji

Resource

Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager

RestorePollerOptions
RunOutput

Reprezentuje dane wyjściowe utworzone przez uruchomienie szablonu obrazu.

RunOutputProperties

Opisuje właściwości wyjścia wyniku

SimplePollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

SourceImageTriggerProperties

Właściwości wyzwalacza typu SourceImage

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TargetRegion

Opisuje informacje o regionie docelowym.

TrackedResource

Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"

Trigger

Reprezentuje wyzwalacz, który może wywołać kompilację szablonu obrazu.

TriggerProperties

Opisuje właściwości wyzwalacza

TriggerStatus

Opisuje stan wyzwalacza

TriggersCreateOrUpdateOptionalParams

Parametry opcjonalne.

TriggersDeleteOptionalParams

Parametry opcjonalne.

TriggersGetOptionalParams

Parametry opcjonalne.

TriggersListByImageTemplateOptionalParams

Parametry opcjonalne.

TriggersOperations

Interfejs reprezentujący operacje wyzwalające.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

VirtualMachineImageTemplatesCancelOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesDeleteOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesGetOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesListOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesOperations

Interfejs reprezentujący operacje VirtualMachineImageTemplates.

VirtualMachineImageTemplatesRunOptionalParams

Parametry opcjonalne.

VirtualMachineImageTemplatesUpdateOptionalParams

Parametry opcjonalne.

VirtualNetworkConfig

Konfiguracja sieci wirtualnej.

Aliasy typu

AutoRunState

Włączenie tego pola spowoduje wyzwolenie automatycznej kompilacji podczas tworzenia lub aktualizowania szablonu obrazu.

AzureSupportedClouds

Obsługiwane wartości ustawienia chmury jako typ literału ciągu

ContinuablePage

Interfejs opisujący stronę wyników.

CreatedByType

Rodzaj jednostki, która utworzyła zasób.
KnownCreatedByType można używać zamiennie z parametrem CreatedByType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownik: jednostka została utworzona przez użytkownika.
Application: jednostka została utworzona przez aplikację.
managedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
klucz: jednostka została utworzona przez klucz.

DistributeVersionerUnion

Alias for DistributeVersionerUnion

ImageTemplateCustomizerUnion

Alias dla ImageTemplateCustomizerUnion

ImageTemplateDistributorUnion

Alias dla ImageTemplateDistributorUnion

ImageTemplateInVMValidatorUnion

Alias dla ImageTemplateInVMValidatorUnion

ImageTemplateSourceUnion

Alias dla ImageTemplateSourceUnion

OnBuildError

Zachowanie obsługi błędów po niepowodzeniu budowy
KnownOnBuildError można używać zamiennie z błędem OnBuildError, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Sprzątanie: Sprzątanie
przerwać: przerwać

ProvisioningErrorCode

Kod błędu awarii provisioningu
KnownProvisioningErrorCode można używać zamiennie z kodem ProvisioningErrorCode, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

ZłeŹródłoTyp: ZłeŹródło
BadPIRSource: BadPIRSource
ŹleZarządzanyObrazemŹródło: ZłyZarządzanyObrazemŹródło
ŹleUdostępnionyObrazuŹródło: ZłyUdostępnionyObrazWersja
BadCustomizerType: BadCustomizerType
UnsupportedCustomizerType: UnsupportedCustomizerType
NoCustomizerScript: NoCustomizerScript
BadValidatorType: BadValidatorType
UnsupportedValidatorType: UnsupportedValidatorType
NoValidatorScript: NoValidatorScript
BadDistributeType: BadDistributeType
ZłyUdostępnionyObrazDystrybucja: Zły UdostępnionyObrazDystrybucja
BadStagingResourceGroup: BadStagingResourceGroup
SerwerBłąd: Serwerowy Błąd
Inne: Inne

ProvisioningState

Stan aprowizacji zasobu

ReplicationMode

Opisuje tryb replikacji do dystrybucji w Azure Compute Gallery. Pomiń użycie domyślnego (Full).
KnownReplicationMode można używać zamiennie z trybem ReplicationMode, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Pełna: Tryb pełnej replikacji
Płytki: Płytki tryb replikacji

ResourceIdentityType

Typ tożsamości używany dla szablonu obrazu. Typ "None" usunie wszystkie tożsamości z szablonu obrazu.

RunState

Stan ostatniego przejazdu

RunSubState

Podstan ostatniego przebiegu

SharedImageStorageAccountType

Określa typ konta pamięci, który ma być użyty do przechowywania wersji obrazu Azure Compute Gallery.
KnownSharedImageStorageAccountType można używać zamiennie z wartościami SharedImageStorageAccountType. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Standard_LRS: Standard_LRS
Standard_ZRS: Standard_ZRS
Premium_LRS: Premium_LRS

TriggerPropertiesUnion

Alias dla TriggerPropertiesUnion

VMBootOptimizationState

Włączenie tego pola poprawi czas rozruchu maszyny wirtualnej, optymalizując ostateczne dostosowane dane wyjściowe obrazu.

WorkloadOptimizationState

Włączenie tego pola zoptymalizuje obrazy VM dla konkretnych obciążeń.

Wyliczenia

AzureClouds

Enum opisujące środowiska Azure Cloud.

KnownCreatedByType

Rodzaj jednostki, która utworzyła zasób.

KnownOnBuildError

Zachowanie obsługi błędów po niepowodzeniu budowy

KnownProvisioningErrorCode

Kod błędu awarii provisioningu

KnownReplicationMode

Opisuje tryb replikacji do dystrybucji w Azure Compute Gallery. Pomiń użycie domyślnego (Full).

KnownSharedImageStorageAccountType

Określa typ konta pamięci, który ma być użyty do przechowywania wersji obrazu Azure Compute Gallery.

KnownVersions

Dostępne wersje interfejsu API.

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

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

Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

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

Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

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

Parametry

serializedState

string

sourceOperation

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

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ