@azure/arm-imagebuilder package
Klassen
| ImageBuilderClient |
Interfaces
| DataDisk |
Eigenschappen van de gegevensschijf. |
| DistributeVersioner |
Hierin wordt beschreven hoe u een nieuw x.y.z-versienummer voor distributie genereert. |
| DistributeVersionerLatest |
Hiermee wordt een versienummer gegenereerd dat de meest recente is op basis van bestaande versienummers. |
| DistributeVersionerSource |
Genereert versienummer op basis van versienummer van broninstallatiekopieën |
| ErrorAdditionalInfo |
Aanvullende informatie over de resourcebeheerfout. |
| ErrorDetail |
De foutdetails. |
| ErrorResponse |
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. |
| ImageBuilderClientOptionalParams |
Optionele parameters voor de client. |
| ImageTemplate |
Afbeeldingssjabloon is een ARM-resource die wordt beheerd door microsoft.VirtualMachineImages-provider |
| ImageTemplateAutoRun |
Geeft aan of de afbeeldingssjabloon moet worden gebouwd op basis van maken/bijwerken |
| ImageTemplateCustomizer |
Beschrijft een eenheid van afbeeldingsaanpassing |
| ImageTemplateDistributor |
Algemeen distributieobject |
| ImageTemplateFileCustomizer |
Uploadt bestanden naar VM's (Linux, Windows). Komt overeen met Packer-bestandsinrichting |
| ImageTemplateFileValidator |
Uploadt bestanden die nodig zijn voor validatie naar VM's (Linux, Windows). Komt overeen met Packer-bestandsinrichting |
| ImageTemplateIdentity |
Identiteit voor de afbeeldingssjabloon. |
| ImageTemplateInVMValidator |
Beschrijft een eenheid van in-VM validatie van de afbeelding |
| ImageTemplateLastRunStatus |
Beschrijft de meest recente status van het uitvoeren van een afbeeldingssjabloon |
| ImageTemplateManagedImageDistributor |
Distribueer als een installatiekopieën van een beheerde schijf. |
| ImageTemplateManagedImageSource |
Beschrijft een afbeeldingsbron die een beheerde installatiekopieën in het abonnement van de klant is. Deze installatiekopieën moeten zich in hetzelfde abonnement en dezelfde regio bevinden als de sjabloon Image Builder. |
| ImageTemplatePlatformImageSource |
Beschrijft een afbeeldingsbron uit Azure Gallery-installatiekopieën. |
| ImageTemplatePowerShellCustomizer |
Hiermee wordt de opgegeven PowerShell uitgevoerd op de virtuele machine (Windows). Komt overeen met packer powershell-inrichting. Er kan precies een van de 'scriptUri' of 'inline' worden opgegeven. |
| ImageTemplatePowerShellValidator |
Hiermee wordt het opgegeven PowerShell-script uitgevoerd tijdens de validatiefase (Windows). Komt overeen met packer powershell-inrichting. Er kan precies een van de 'scriptUri' of 'inline' worden opgegeven. |
| ImageTemplateProperties |
Beschrijft de eigenschappen van een afbeeldingstemplate |
| ImageTemplatePropertiesErrorHandling |
Opties voor foutafhandeling bij een buildfout |
| ImageTemplatePropertiesOptimize |
Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding. |
| ImageTemplatePropertiesOptimizeVmBoot |
Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking. |
| ImageTemplatePropertiesOptimizeWorkload |
Optimalisatie wordt toegepast op de afbeelding voor specifieke workloads. |
| ImageTemplatePropertiesValidate |
Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding. |
| ImageTemplateRestartCustomizer |
Start een virtuele machine opnieuw op en wacht tot deze weer online is (Windows). Komt overeen met Packer windows-restart provisioner |
| ImageTemplateSharedImageDistributor |
Distribueren via Azure Compute Gallery. |
| ImageTemplateSharedImageVersionSource |
Beschrijft een installatiekopieënbron die een installatiekopieënversie is in een Azure Compute Gallery of een direct gedeelde galerie. |
| ImageTemplateShellCustomizer |
Voert een shellscript uit tijdens de aanpassingsfase (Linux). Komt overeen met packer shell-inrichting. Er kan precies een van de 'scriptUri' of 'inline' worden opgegeven. |
| ImageTemplateShellValidator |
Hiermee wordt het opgegeven shellscript uitgevoerd tijdens de validatiefase (Linux). Komt overeen met packer shell-inrichting. Er kan precies een van de 'scriptUri' of 'inline' worden opgegeven. |
| ImageTemplateSource |
Beschrijft een bron voor de installatiekopieën van een virtuele machine voor het bouwen, aanpassen en distribueren van afbeeldingen |
| ImageTemplateUpdateParameters |
Parameters voor het bijwerken van een afbeeldingssjabloon. |
| ImageTemplateUpdateParametersProperties |
Parameters voor het bijwerken van een afbeeldingssjabloon. |
| ImageTemplateVhdDistributor |
Distribueren via VHD in een opslagaccount. |
| ImageTemplateVmProfile |
Beschrijft de virtuele machines die worden gebruikt om installatiekopieën te bouwen en te valideren |
| ImageTemplateWindowsUpdateCustomizer |
Installeert Windows-updates. Komt overeen met Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update) |
| Operation |
Een REST API-bewerking |
| OperationDisplay |
Het object dat de bewerking beschrijft. |
| OperationsListOptionalParams |
Optionele parameters. |
| OperationsOperations |
Interface die een Operations-bewerkingen vertegenwoordigt. |
| PageSettings |
Opties voor de byPage-methode |
| PagedAsyncIterableIterator |
Een interface die asynchrone iteratieve iteratie mogelijk maakt, zowel tot voltooiing als per pagina. |
| PlatformImagePurchasePlan |
Configuratie van aankoopplan voor platforminstallatiekopieën. |
| ProvisioningError |
Beschrijft de fout die is opgetreden bij het maken of bijwerken van een afbeeldingssjabloon |
| ProxyResource |
De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie |
| Resource |
Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources |
| RestorePollerOptions | |
| RunOutput |
Vertegenwoordigt een uitvoer die is gemaakt door een afbeeldingssjabloon uit te voeren. |
| RunOutputProperties |
Beschrijft de eigenschappen van een uitvoerende uitvoer |
| SimplePollerLike |
Een eenvoudige poller die kan worden gebruikt om een langdurige bewerking te peilen. |
| SourceImageTriggerProperties |
Eigenschappen van het type SourceImage van trigger |
| SystemData |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
| TargetRegion |
Beschrijft de informatie over de doelregio. |
| TrackedResource |
De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie |
| Trigger |
Vertegenwoordigt een trigger die een build van een installatiekopieënsjabloon kan aanroepen. |
| TriggerProperties |
Beschrijft de eigenschappen van een trigger |
| TriggerStatus |
Beschrijft de status van een trigger |
| TriggersCreateOrUpdateOptionalParams |
Optionele parameters. |
| TriggersDeleteOptionalParams |
Optionele parameters. |
| TriggersGetOptionalParams |
Optionele parameters. |
| TriggersListByImageTemplateOptionalParams |
Optionele parameters. |
| TriggersOperations |
Interface die de operaties van een trigger vertegenwoordigt. |
| UserAssignedIdentity |
Door de gebruiker toegewezen identiteitseigenschappen |
| VirtualMachineImageTemplatesCancelOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesDeleteOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesGetOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesListOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesOperations |
Interface die een VirtualMachineImageTemplates-operatie vertegenwoordigt. |
| VirtualMachineImageTemplatesRunOptionalParams |
Optionele parameters. |
| VirtualMachineImageTemplatesUpdateOptionalParams |
Optionele parameters. |
| VirtualNetworkConfig |
Configuratie van virtueel netwerk. |
Type-aliassen
| AutoRunState |
Als u dit veld inschakelt, wordt automatisch een build geactiveerd voor het maken of bijwerken van een installatiekopiesjabloon. |
| AzureSupportedClouds |
De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype |
| ContinuablePage |
Een interface die een pagina met resultaten beschrijft. |
| CreatedByType |
Het type entiteit dat de resource heeft gemaakt. Bekende waarden die door de service worden ondersteund
Gebruiker: De entiteit is gemaakt door een gebruiker. |
| DistributeVersionerUnion |
Alias voor DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
Alias voor ImageTemplateCustomizerUnion |
| ImageTemplateDistributorUnion |
Alias voor ImageTemplateDistributorUnion |
| ImageTemplateInVMValidatorUnion |
Alias for ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
Alias voor ImageTemplateSourceUnion |
| OnBuildError |
Foutafhandelingsgedrag bij een buildfout Bekende waarden die door de service worden ondersteund
Opruimen: Opruimen |
| ProvisioningErrorCode |
Foutcode van de provisioning-fout Bekende waarden die door de service worden ondersteund
BadSourceType: BadSourceType |
| ProvisioningState |
Inrichtingsstatus van de resource |
| ReplicationMode |
Beschrijft replicatiemodus voor distributie in Azure Compute Gallery. Niet de standaard (Volledig) gebruiken. Bekende waarden die door de service worden ondersteund
Volledig: Volledige replicatiemodus |
| ResourceIdentityType |
Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. |
| RunState |
Staat van de laatste run |
| RunSubState |
Substaat van de laatste run |
| SharedImageStorageAccountType |
Specificeert het opslagaccounttype dat gebruikt moet worden om de Azure Compute Gallery afbeeldingsversie op te slaan in. Bekende waarden die door de service worden ondersteund
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Alias voor TriggerPropertiesUnion |
| VMBootOptimizationState |
Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren. |
| WorkloadOptimizationState |
Door dit veld in te schakelen, worden VM-images geoptimaliseerd voor specifieke workloads. |
Enums
| AzureClouds |
Een enum om Azure Cloud-omgevingen te beschrijven. |
| KnownCreatedByType |
Het type entiteit dat de resource heeft gemaakt. |
| KnownOnBuildError |
Foutafhandelingsgedrag bij een buildfout |
| KnownProvisioningErrorCode |
Foutcode van de provisioning-fout |
| KnownReplicationMode |
Beschrijft replicatiemodus voor distributie in Azure Compute Gallery. Niet de standaard (Volledig) gebruiken. |
| KnownSharedImageStorageAccountType |
Specificeert het opslagaccounttype dat gebruikt moet worden om de Azure Compute Gallery afbeeldingsversie op te slaan in. |
| KnownVersions |
De beschikbare API-versies. |
Functies
| is |
Typeguard voor RestError |
| restore |
Hiermee maakt u een opiniepeiler op basis van de geserialiseerde status van een andere opiniepeiler. Dit kan handig zijn wanneer u pollers op een andere host wilt maken of wanneer een poller moet worden geconstrueerd nadat de oorspronkelijke niet binnen het bereik valt. |
Variabelen
| Rest |
Een aangepast fouttype voor mislukte pijplijnaanvragen. |
Functiedetails
isRestError(unknown)
Typeguard voor RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Iets betrapt door een catch-component.
Retouren
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Hiermee maakt u een opiniepeiler op basis van de geserialiseerde status van een andere opiniepeiler. Dit kan handig zijn wanneer u pollers op een andere host wilt maken of wanneer een poller moet worden geconstrueerd nadat de oorspronkelijke niet binnen het bereik valt.
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- ImageBuilderClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retouren
PollerLike<OperationState<TResult>, TResult>
Variabele details
RestError
Een aangepast fouttype voor mislukte pijplijnaanvragen.
RestError: RestErrorConstructor