Virtual Machine Image Templates - Get

Service:: Image Builder

API-versie:: 2022-07-01

Informatie ophalen over een installatiekopieënsjabloon voor virtuele machines

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

URI-parameters

Name	In	Vereist	Type	Description
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	De naam van de afbeeldingssjabloon
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	ImageTemplate	OK
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Retrieve an Image Template.

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate?api-version=2022-07-01

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.VirtualMachineImages/imageTemplates/myImageTemplate",
  "name": "myImageTemplate",
  "location": "westus",
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity_1": {
        "clientId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "properties": {
    "source": {
      "type": "ManagedImage",
      "imageId": "/subscriptions/{subscription-id}/resourceGroups/source_rg/providers/Microsoft.Compute/images/source_image"
    },
    "customize": [
      {
        "type": "Shell",
        "name": "Shell Customizer Example",
        "scriptUri": "https://example.com/path/to/script.sh"
      }
    ],
    "distribute": [
      {
        "type": "ManagedImage",
        "location": "1_location",
        "runOutputName": "image_it_pir_1",
        "imageId": "/subscriptions/{subscription-id}/resourceGroups/rg1/providers/Microsoft.Compute/images/image_it_1",
        "artifactTags": {
          "tagName": "value"
        }
      }
    ],
    "vmProfile": {
      "vmSize": "Standard_D2s_v3",
      "osDiskSizeGB": 64
    }
  }
}

Definities

Name	Description
CloudError	Een foutbericht van de Azure VM Image Builder-service.
CloudErrorBody	Een foutbericht van de Azure VM Image Builder-service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
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
ImageTemplate	Afbeeldingssjabloon is een ARM-resource die wordt beheerd door microsoft.VirtualMachineImages-provider
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.
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.
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.
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)
Optimize	Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding.
PlatformImagePurchasePlan	Configuratie van aankoopplan voor platforminstallatiekopieën.
ProvisioningError	Beschrijft de fout die is opgetreden bij het maken of bijwerken van een afbeeldingssjabloon
ProvisioningErrorCode	Foutcode van de inrichtingsfout
ProvisioningState	Inrichtingsstatus van de resource
ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd.
RunState	Status van de laatste uitvoering
RunSubState	Substatus van de laatste uitvoering
SharedImageStorageAccountType	Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de azure Compute Gallery-installatiekopieversie in.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
TargetRegion	Beschrijft de informatie over de doelregio.
UserAssignedIdentity	Door de gebruiker toegewezen identiteitseigenschappen
Validate	Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding.
VirtualNetworkConfig	Configuratie van virtueel netwerk.
VmBoot	Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking.
VMBootOptimizationState	Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren.

CloudError

Object

Een foutbericht van de Azure VM Image Builder-service.

Name	Type	Description
error	CloudErrorBody	Details over de fout.

CloudErrorBody

Object

Een foutbericht van de Azure VM Image Builder-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Object

Hiermee wordt een versienummer gegenereerd dat de meest recente is op basis van bestaande versienummers.

Name	Type	Default value	Description
major	integer (int32) minimum: -1	-1	Primaire versie voor het gegenereerde versienummer. Bepaal wat 'nieuwste' is op basis van versies met deze waarde als primaire versie. -1 is gelijk aan het verlaten ervan.
scheme	string: Latest		Versienummeringsschema dat moet worden gebruikt.

DistributeVersionerSource

Object

Genereert versienummer op basis van versienummer van broninstallatiekopieën

Name	Type	Description
scheme	string: Source	Versienummeringsschema dat moet worden gebruikt.

ImageTemplate

Object

Afbeeldingssjabloon is een ARM-resource die wordt beheerd door microsoft.VirtualMachineImages-provider

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		De identiteit van de afbeeldingssjabloon, indien geconfigureerd.
location	string		De geografische locatie waar de resource zich bevindt
name	string		De naam van de resource
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Maximale duur om te wachten tijdens het bouwen van de afbeeldingssjabloon (inclusief alle aanpassingen, optimalisatie, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken.
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan.
properties.exactStagingResourceGroup	string		De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Dit alleen-lezenveld verschilt van 'stagingResourceGroup' alleen als de waarde die is opgegeven in het veld stagingResourceGroup leeg is.
properties.lastRunStatus	ImageTemplateLastRunStatus		Status van 'run' die momenteel wordt uitgevoerd of voor het laatst is uitgevoerd.
properties.optimize	Optimize		Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding.
properties.provisioningError	ProvisioningError		Inrichtingsfout, indien van toepassing
properties.provisioningState	ProvisioningState		Inrichtingsstatus van de resource
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven.
properties.stagingResourceGroup	string		De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze gemaakt met dezelfde naam. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources verwijderd die in de resourcegroep zijn gemaakt tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf behouden.
properties.validate	Validate		Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding.
properties.vmProfile	ImageTemplateVmProfile		Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën
systemData	systemData		Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object		Resourcetags.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ImageTemplateFileCustomizer

Object

Uploadt bestanden naar VM's (Linux, Windows). Komt overeen met Packer-bestandsinrichting

Name	Type	Description
destination	string	Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine
name	string	Beschrijvende naam om context te geven over wat deze aanpassingsstap doet
sha256Checksum	string	SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld
sourceUri	string	De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn
type	string: File	Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn

ImageTemplateFileValidator

Object

Uploadt bestanden die nodig zijn voor validatie naar VM's (Linux, Windows). Komt overeen met Packer-bestandsinrichting

Name	Type	Description
destination	string	Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine
name	string	Beschrijvende naam om context op te geven over wat deze validatiestap doet
sha256Checksum	string	SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld
sourceUri	string	De URI van het bestand dat moet worden geüpload naar de VIRTUELE machine voor validatie. Het kan een github-koppeling, Azure Storage-URI (geautoriseerd of SAS) zijn, enzovoort
type	string: File	Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn

ImageTemplateIdentity

Object

Identiteit voor de afbeeldingssjabloon.

Name	Type	Description
type	ResourceIdentityType	Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned identiteiten De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen.

ImageTemplateLastRunStatus

Object

Beschrijft de meest recente status van het uitvoeren van een afbeeldingssjabloon

Name	Type	Description
endTime	string (date-time)	Eindtijd van de laatste uitvoering (UTC)
message	string	Uitgebreide informatie over de laatste uitvoeringsstatus
runState	RunState	Status van de laatste uitvoering
runSubState	RunSubState	Substatus van de laatste uitvoering
startTime	string (date-time)	Begintijd van de laatste uitvoering (UTC)

ImageTemplateManagedImageDistributor

Object

Distribueer als een installatiekopieën van een beheerde schijf.

Name	Type	Description
artifactTags	object	Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur.
imageId	string	Resource-id van de installatiekopieën van de beheerde schijf
location	string	Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	De naam die moet worden gebruikt voor de bijbehorende RunOutput.
type	string: ManagedImage	Type distributie.

ImageTemplateManagedImageSource

Object

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.

Name	Type	Description
imageId	string	ARM-resource-id van de beheerde installatiekopieën in het klantabonnement
type	string: ManagedImage	Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen.

ImageTemplatePlatformImageSource

Object

Beschrijft een afbeeldingsbron uit Azure Gallery-installatiekopieën.

Name	Type	Description
exactVersion	string	Installatiekopieën van de Azure Gallery-installatiekopieën. Dit alleen-lezen veld verschilt van 'version', alleen als de waarde die is opgegeven in het veld 'version' 'latest' is.
offer	string	Afbeeldingsaanbieding uit de Azure Gallery Images.
planInfo	PlatformImagePurchasePlan	Optionele configuratie van aankoopplan voor platforminstallatiekopieën.
publisher	string	Image Publisher in Azure Gallery-installatiekopieën.
sku	string	Afbeeldingsku uit de Azure Gallery-installatiekopieën.
type	string: PlatformImage	Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen.
version	string	Installatiekopieën van de Azure Gallery-installatiekopieën. Als hier 'nieuwste' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden.

ImageTemplatePowerShellCustomizer

Object

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.

Name	Type	Default value	Description
inline	string[]		Matrix met PowerShell-opdrachten die moeten worden uitgevoerd
name	string		Beschrijvende naam om context te geven over wat deze aanpassingsstap doet
runAsSystem	boolean	False	Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true.
runElevated	boolean	False	Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden
scriptUri	string		URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn
sha256Checksum	string		SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld
type	string: PowerShell		Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn
validExitCodes	integer[] (int32)		Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0]

ImageTemplatePowerShellValidator

Object

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.

Name	Type	Default value	Description
inline	string[]		Matrix met PowerShell-opdrachten die moeten worden uitgevoerd
name	string		Beschrijvende naam om context op te geven over wat deze validatiestap doet
runAsSystem	boolean	False	Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true.
runElevated	boolean	False	Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden
scriptUri	string		URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn
sha256Checksum	string		SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld
type	string: PowerShell		Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn
validExitCodes	integer[] (int32)		Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0]

ImageTemplateRestartCustomizer

Object

Start een virtuele machine opnieuw op en wacht tot deze weer online is (Windows). Komt overeen met Packer windows-restart provisioner

Name	Type	Description
name	string	Beschrijvende naam om context te geven over wat deze aanpassingsstap doet
restartCheckCommand	string	Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: '']
restartCommand	string	Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""]
restartTimeout	string	Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m']
type	string: WindowsRestart	Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn

ImageTemplateSharedImageDistributor

Object

Distribueren via Azure Compute Gallery.

Name	Type	Default value	Description
artifactTags	object		Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur.
excludeFromLatest	boolean	False	Vlag die aangeeft of de gemaakte installatiekopieënversie moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde (onwaar) te gebruiken.
galleryImageId	string		Resource-id van de azure Compute Gallery-installatiekopieën
replicationRegions	string[]		[Afgeschaft] Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd. Deze lijst kan alleen worden opgegeven als targetRegions niet is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		De naam die moet worden gebruikt voor de bijbehorende RunOutput.
storageAccountType	SharedImageStorageAccountType		[Afgeschaft] Het type opslagaccount dat moet worden gebruikt voor het opslaan van de gedeelde installatiekopie. Laat het gebruik van de standaardwaarde weg (Standard_LRS). Dit veld kan alleen worden opgegeven als replicationRegions is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions.
targetRegions	TargetRegion[]		De doelregio's waarnaar de gedistribueerde versie van de installatiekopieën wordt gerepliceerd. Dit object vervangt replicationRegions en kan alleen worden opgegeven als replicationRegions niet is opgegeven.
type	string: SharedImage		Type distributie.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Hierin wordt beschreven hoe u een nieuw x.y.z-versienummer voor distributie genereert.

ImageTemplateSharedImageVersionSource

Object

Beschrijft een installatiekopieënbron die een installatiekopieënversie is in een Azure Compute Gallery of een direct gedeelde galerie.

Name	Type	Description
exactVersion	string	Exacte ARM-resource-id van de versie van de installatiekopieën. Dit alleen-lezen veld verschilt van de versie-id van de installatiekopieën in 'imageVersionId' als de versienaam die is opgegeven in het veld 'imageVersionId' 'latest' is.
imageVersionId	string	ARM-resource-id van de versie van de installatiekopieën. Wanneer de naam van de installatiekopieënversie 'nieuwste' is, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd.
type	string: SharedImageVersion	Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen.

ImageTemplateShellCustomizer

Object

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.

Name	Type	Description
inline	string[]	Matrix van shell-opdrachten die moeten worden uitgevoerd
name	string	Beschrijvende naam om context te geven over wat deze aanpassingsstap doet
scriptUri	string	URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn
sha256Checksum	string	SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld
type	string: Shell	Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn

ImageTemplateShellValidator

Object

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.

Name	Type	Description
inline	string[]	Matrix van shell-opdrachten die moeten worden uitgevoerd
name	string	Beschrijvende naam om context op te geven over wat deze validatiestap doet
scriptUri	string	URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn
sha256Checksum	string	SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld
type	string: Shell	Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn

ImageTemplateVhdDistributor

Object

Distribueren via VHD in een opslagaccount.

Name	Type	Description
artifactTags	object	Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	De naam die moet worden gebruikt voor de bijbehorende RunOutput.
type	string: VHD	Type distributie.
uri	string	Optionele Azure Storage-URI voor de gedistribueerde VHD-blob. Laat het gebruik van de standaardwaarde (lege tekenreeks) weg. In dat geval wordt VHD gepubliceerd naar het opslagaccount in de faseringsresourcegroep.

ImageTemplateVmProfile

Object

Beschrijft de virtuele machines die worden gebruikt om installatiekopieën te bouwen en te valideren

Name	Type	Default value	Description
osDiskSizeGB	integer (int32) minimum: 0	0	Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardschijfgrootte van het besturingssysteem van Azure te gebruiken.
userAssignedIdentities	string[]		Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon zijn.
vmSize	string		Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (Standard_D1_v2 voor Gen1-installatiekopieën en Standard_D2ds_v4 voor Gen2-afbeeldingen).
vnetConfig	VirtualNetworkConfig		Optionele configuratie van het virtuele netwerk dat moet worden gebruikt voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk moet worden gebruikt.

ImageTemplateWindowsUpdateCustomizer

Object

Installeert Windows-updates. Komt overeen met Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Name	Type	Default value	Description
filters	string[]		Matrix met filters om updates te selecteren die moeten worden toegepast. Laat de lege matrix weg of geef deze op om de standaardwaarde te gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld.
name	string		Beschrijvende naam om context te geven over wat deze aanpassingsstap doet
searchCriteria	string		Criteria voor het zoeken naar updates. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (zoek alles). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld.
type	string: WindowsUpdate		Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn
updateLimit	integer (int32) minimum: 0	0	Maximum aantal updates dat tegelijk moet worden toegepast. Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (1000)

Optimize

Object

Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding.

Name	Type	Description
vmBoot	VmBoot	Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking.

PlatformImagePurchasePlan

Object

Configuratie van aankoopplan voor platforminstallatiekopieën.

Name	Type	Description
planName	string	Naam van het aankoopplan.
planProduct	string	Product van het aankoopplan.
planPublisher	string	Uitgever van het aankoopplan.

ProvisioningError

Object

Beschrijft de fout die is opgetreden bij het maken of bijwerken van een afbeeldingssjabloon

Name	Type	Description
message	string	Uitgebreid foutbericht over de inrichtingsfout
provisioningErrorCode	ProvisioningErrorCode	Foutcode van de inrichtingsfout

ProvisioningErrorCode

Inventarisatie

Foutcode van de inrichtingsfout

Waarde	Description
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Inventarisatie

Inrichtingsstatus van de resource

Waarde	Description
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Inventarisatie

Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd.

Waarde	Description
UserAssigned
None

RunState

Inventarisatie

Status van de laatste uitvoering

Waarde	Description
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Inventarisatie

Substatus van de laatste uitvoering

Waarde	Description
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Inventarisatie

Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de azure Compute Gallery-installatiekopieversie in.

Waarde	Description
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

TargetRegion

Object

Beschrijft de informatie over de doelregio.

Name	Type	Default value	Description
name	string		De naam van de regio.
replicaCount	integer (int32) minimum: 1	1	Het aantal replica's van de versie van de installatiekopieën dat in deze regio moet worden gemaakt. Laat het gebruik van de standaardwaarde weg (1).
storageAccountType	SharedImageStorageAccountType		Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de installatiekopie in deze regio. Laat het gebruik van de standaardwaarde weg (Standard_LRS).

UserAssignedIdentity

Object

Door de gebruiker toegewezen identiteitseigenschappen

Name	Type	Description
clientId	string	De client-id van de toegewezen identiteit.
principalId	string	De principal-id van de toegewezen identiteit.

Validate

Object

Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding.

Name	Type	Default value	Description
continueDistributeOnFailure	boolean	False	Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is het standaardgedrag. Als de validatie mislukt en dit veld is ingesteld op true, worden uitvoerafbeeldingen nog steeds gedistribueerd. Gebruik deze optie met voorzichtigheid, omdat dit kan leiden tot slechte installatiekopieën die voor gebruik worden gedistribueerd. In beide gevallen (waar of onwaar) wordt de end-to-end-installatiekopieuitvoering gerapporteerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Lijst met validaties die moeten worden uitgevoerd.
sourceValidationOnly	boolean	False	Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie Bron rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren.

VirtualNetworkConfig

Object

Configuratie van virtueel netwerk.

Name	Type	Description
proxyVmSize	string	De grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Laat de lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_A1_v2).
subnetId	string	Resource-id van een bestaand subnet.

VmBoot

Object

Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking.

Name	Type	Description
state	VMBootOptimizationState	Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren.

VMBootOptimizationState

Inventarisatie

Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren.

Waarde	Description
Enabled
Disabled

Delen via

Virtual Machine Image Templates - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Retrieve an Image Template.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CloudError

CloudErrorBody

createdByType

DistributeVersionerLatest

DistributeVersionerSource

ImageTemplate

ImageTemplateFileCustomizer

ImageTemplateFileValidator

ImageTemplateIdentity

ImageTemplateLastRunStatus

ImageTemplateManagedImageDistributor

ImageTemplateManagedImageSource

ImageTemplatePlatformImageSource

ImageTemplatePowerShellCustomizer

ImageTemplatePowerShellValidator

ImageTemplateRestartCustomizer

ImageTemplateSharedImageDistributor

ImageTemplateSharedImageVersionSource

ImageTemplateShellCustomizer

ImageTemplateShellValidator

ImageTemplateVhdDistributor

ImageTemplateVmProfile

ImageTemplateWindowsUpdateCustomizer

Optimize

PlatformImagePurchasePlan

ProvisioningError

ProvisioningErrorCode

ProvisioningState

ResourceIdentityType

RunState

RunSubState

SharedImageStorageAccountType

systemData

TargetRegion

UserAssignedIdentity

Validate

VirtualNetworkConfig

VmBoot

VMBootOptimizationState