@azure/arm-imagebuilder package
Třídy
| ImageBuilderClient |
Rozhraní
| DataDisk |
Vlastnosti datového disku. |
| DistributeVersioner |
Popisuje, jak vygenerovat nové číslo verze x.y.z pro distribuci. |
| DistributeVersionerLatest |
Vygeneruje číslo verze, které bude nejnovější na základě existujících čísel verzí. |
| DistributeVersionerSource |
Vygeneruje číslo verze na základě čísla verze zdrojové image. |
| ErrorAdditionalInfo |
Další informace o chybě správy prostředků |
| ErrorDetail |
Podrobnosti o chybě. |
| ErrorResponse |
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace |
| ImageBuilderClientOptionalParams |
Volitelné parametry pro klienta. |
| ImageTemplate |
Šablona image je prostředek ARM spravovaný poskytovatelem Microsoft.VirtualMachineImages. |
| ImageTemplateAutoRun |
Označuje, jestli je potřeba vytvořit nebo aktualizovat šablonu obrázku. |
| ImageTemplateCustomizer |
Popisuje jednotku přizpůsobení obrázku. |
| ImageTemplateDistributor |
Obecný distribuční objekt |
| ImageTemplateFileCustomizer |
Nahraje soubory do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru. |
| ImageTemplateFileValidator |
Nahraje soubory potřebné k ověření do virtuálních počítačů (Linux, Windows). Odpovídá zřizovacímu modulu souborů packeru. |
| ImageTemplateIdentity |
Identita šablony obrázku |
| ImageTemplateInVMValidator |
Popisuje jednotku in-VM ověření image. |
| ImageTemplateLastRunStatus |
Popisuje nejnovější stav spuštění šablony image. |
| ImageTemplateManagedImageDistributor |
Distribuujte jako image spravovaného disku. |
| ImageTemplateManagedImageSource |
Popisuje zdroj image, který je spravovanou imagí v předplatném zákazníka. Tato image se musí nacházet ve stejném předplatném a oblasti jako šablona Image Builderu. |
| ImageTemplatePlatformImageSource |
Popisuje zdroj image z image galerie Azure. |
| ImageTemplatePowerShellCustomizer |
Spustí zadaný PowerShell na virtuálním počítači (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline". |
| ImageTemplatePowerShellValidator |
Spustí zadaný skript PowerShellu během ověřovací fáze (Windows). Odpovídá zřizovacímu modulu PowerShellu Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline". |
| ImageTemplateProperties |
Popisuje vlastnosti šablony obrazu |
| ImageTemplatePropertiesErrorHandling |
Možnosti zpracování chyb při selhání sestavení |
| ImageTemplatePropertiesOptimize |
Určuje optimalizaci, která se má provést na imagi. |
| ImageTemplatePropertiesOptimizeVmBoot |
Optimalizace se použije na imagi pro rychlejší spuštění virtuálního počítače. |
| ImageTemplatePropertiesOptimizeWorkload |
Optimalizace se aplikuje na obrázek pro konkrétní pracovní zátěže. |
| ImageTemplatePropertiesValidate |
Možnosti konfigurace a seznam ověření, která se mají provést na výsledné imagi. |
| ImageTemplateRestartCustomizer |
Restartuje virtuální počítač a počká, až se vrátí do online režimu (Windows). Odpovídá zřizovacímu programu Packer windows-restart |
| ImageTemplateSharedImageDistributor |
Distribuujte prostřednictvím galerie výpočetních prostředků Azure. |
| ImageTemplateSharedImageVersionSource |
Popisuje zdroj image, který je verzí image v Galerii výpočetních prostředků Azure nebo v přímé sdílené galerii. |
| ImageTemplateShellCustomizer |
Spustí skript prostředí během fáze přizpůsobení (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline". |
| ImageTemplateShellValidator |
Spustí zadaný skript prostředí během ověřovací fáze (Linux). Odpovídá zřizovacímu modulu prostředí Packer. Je možné zadat přesně jeden z "scriptUri" nebo "inline". |
| ImageTemplateSource |
Popisuje zdroj image virtuálního počítače pro sestavování, přizpůsobení a distribuci. |
| ImageTemplateUpdateParameters |
Parametry pro aktualizaci šablony obrázku |
| ImageTemplateUpdateParametersProperties |
Parametry pro aktualizaci šablony obrázku |
| ImageTemplateVhdDistributor |
Distribuce prostřednictvím virtuálního pevného disku v účtu úložiště |
| ImageTemplateVmProfile |
Popisuje virtuální počítače používané k vytváření a ověřování imagí. |
| ImageTemplateWindowsUpdateCustomizer |
Nainstaluje aktualizace Systému Windows. Odpovídá zřizovacímu programu služba Windows Update Packer (https://github.com/rgl/packer-provisioner-windows-update) |
| Operation |
Operace rozhraní REST API |
| OperationDisplay |
Objekt, který popisuje operaci. |
| OperationsListOptionalParams |
Volitelné parametry. |
| OperationsOperations |
Rozhraní představující Operace operací. |
| PageSettings |
Možnosti pro metodu byPage |
| PagedAsyncIterableIterator |
Rozhraní, které umožňuje asynchronní iterovatelnou iteraci až do dokončení i po stránce. |
| PlatformImagePurchasePlan |
Konfigurace plánu nákupu pro image platformy |
| ProvisioningError |
Popisuje chybu, ke které došlo při vytváření nebo aktualizaci šablony obrázku. |
| ProxyResource |
Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění. |
| Resource |
Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru |
| RestorePollerOptions | |
| RunOutput |
Představuje výstup, který byl vytvořen spuštěním šablony image. |
| RunOutputProperties |
Popisuje vlastnosti výstupu běhu |
| SimplePollerLike |
Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace. |
| SourceImageTriggerProperties |
Vlastnosti typu SourceImage triggeru |
| SystemData |
Metadata týkající se vytvoření a poslední změny prostředku. |
| TargetRegion |
Popisuje informace o cílové oblasti. |
| TrackedResource |
Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění. |
| Trigger |
Představuje trigger, který může vyvolat sestavení šablony image. |
| TriggerProperties |
Popisuje vlastnosti triggeru. |
| TriggerStatus |
Popisuje stav triggeru. |
| TriggersCreateOrUpdateOptionalParams |
Volitelné parametry. |
| TriggersDeleteOptionalParams |
Volitelné parametry. |
| TriggersGetOptionalParams |
Volitelné parametry. |
| TriggersListByImageTemplateOptionalParams |
Volitelné parametry. |
| TriggersOperations |
Rozhraní reprezentující operace Triggers. |
| UserAssignedIdentity |
Vlastnosti identity přiřazené uživatelem |
| VirtualMachineImageTemplatesCancelOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesDeleteOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesGetOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesListOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesOperations |
Rozhraní reprezentující operace VirtualMachineImageTemplates. |
| VirtualMachineImageTemplatesRunOptionalParams |
Volitelné parametry. |
| VirtualMachineImageTemplatesUpdateOptionalParams |
Volitelné parametry. |
| VirtualNetworkConfig |
Konfigurace virtuální sítě |
Aliasy typu
| AutoRunState |
Povolením tohoto pole se aktivuje automatické sestavení při vytváření nebo aktualizaci šablony image. |
| AzureSupportedClouds |
Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu |
| ContinuablePage |
Rozhraní, které popisuje stránku výsledků. |
| CreatedByType |
Druh entity, která prostředek vytvořila. Známé hodnoty podporované službou
Uživatel: Entita byla vytvořena uživatelem. |
| DistributeVersionerUnion |
Alias for DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
Alias pro ImageTemplateCustomizerUnion |
| ImageTemplateDistributorUnion |
Alias pro ImageTemplateDistributorUnion |
| ImageTemplateInVMValidatorUnion |
Alias pro ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
Alias pro ImageTemplateSourceUnion |
| OnBuildError |
Chování při zpracování chyb při selhání sestavení Známé hodnoty podporované službou
Úklid: Úklid |
| ProvisioningErrorCode |
Chybový kód selhání provisioningu Známé hodnoty podporované službou
ŠpatnýZdrojTyp: ŠpatnýZdrojový typ |
| ProvisioningState |
Stav zřizování prostředku |
| ReplicationMode |
Popisuje režim replikace pro distribuci v Azure Compute Gallery. Vynechte použití výchozího nastavení (Full). Známé hodnoty podporované službou
Plné: Režim plné replikace |
| ResourceIdentityType |
Typ identity používané pro šablonu obrázku. Typ None odebere ze šablony obrázku všechny identity. |
| RunState |
Stav posledního běhu |
| RunSubState |
Podstav posledního běhu |
| SharedImageStorageAccountType |
Specifikuje typ úložného účtu, který se použije pro uložení verze obrázku Azure Compute Gallery. Známé hodnoty podporované službou
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Alias pro TriggerPropertiesUnion |
| VMBootOptimizationState |
Povolením tohoto pole se zlepší doba spouštění virtuálního počítače optimalizací konečného přizpůsobeného výstupu image. |
| WorkloadOptimizationState |
Zapnutí tohoto pole optimalizuje VM obrazy pro konkrétní pracovní zátěže. |
Výčty
| AzureClouds |
Výčet popisující cloudová prostředí Azure. |
| KnownCreatedByType |
Druh entity, která prostředek vytvořila. |
| KnownOnBuildError |
Chování při zpracování chyb při selhání sestavení |
| KnownProvisioningErrorCode |
Chybový kód selhání provisioningu |
| KnownReplicationMode |
Popisuje režim replikace pro distribuci v Azure Compute Gallery. Vynechte použití výchozího nastavení (Full). |
| KnownSharedImageStorageAccountType |
Specifikuje typ úložného účtu, který se použije pro uložení verze obrázku Azure Compute Gallery. |
| KnownVersions |
Dostupné verze rozhraní API. |
Funkce
| is |
Typeguard pro RestError |
| restore |
Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru. |
Proměnné
| Rest |
Vlastní typ chyby pro neúspěšné požadavky kanálu. |
Podrobnosti funkce
isRestError(unknown)
Typeguard pro RestError
function isRestError(e: unknown): e
Parametry
- e
-
unknown
Něco zachyceného klauzulí catch.
Návraty
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru.
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- ImageBuilderClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Návraty
PollerLike<OperationState<TResult>, TResult>
Podrobnosti proměnné
RestError
Vlastní typ chyby pro neúspěšné požadavky kanálu.
RestError: RestErrorConstructor