Virtual Machine Image Templates - Get

Dienst:: Image Builder

API-Version:: 2022-07-01

Abrufen von Informationen zu einer Imagevorlage für virtuelle Computer

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
imageTemplateName	path	True	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Der Name der Bildvorlage
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ImageTemplate	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Retrieve an Image Template.

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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
    }
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Azure VM Image Builder-Diensts.
CloudErrorBody	Eine Fehlerantwort des Azure VM Image Builder-Diensts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DistributeVersionerLatest	Generiert versionsnummer, die auf vorhandenen Versionsnummern basiert.
DistributeVersionerSource	Generiert Versionsnummer basierend auf der Versionsnummer des Quellbilds
ImageTemplate	Bildvorlage ist eine ARM-Ressource, die vom Microsoft.VirtualMachineImages-Anbieter verwaltet wird.
ImageTemplateFileCustomizer	Lädt Dateien auf VMs hoch (Linux, Windows). Entspricht dem Packer-Dateibereitstellungsprogramm
ImageTemplateFileValidator	Lädt Dateien hoch, die für die Überprüfung auf VMs (Linux, Windows) erforderlich sind. Entspricht dem Packer-Dateibereitstellungsprogramm
ImageTemplateIdentity	Identität für die Bildvorlage.
ImageTemplateLastRunStatus	Beschreibt den neuesten Status der Ausführung einer Bildvorlage.
ImageTemplateManagedImageDistributor	Als verwaltetes Datenträgerimage verteilen.
ImageTemplateManagedImageSource	Beschreibt eine Bildquelle, die ein verwaltetes Bild im Kundenabonnement ist. Dieses Bild muss sich in demselben Abonnement und derselben Region wie die Image Builder-Vorlage befinden.
ImageTemplatePlatformImageSource	Beschreibt eine Bildquelle aus Azure Gallery Images.
ImageTemplatePowerShellCustomizer	Führt die angegebene PowerShell auf der VM (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.
ImageTemplatePowerShellValidator	Führt das angegebene PowerShell-Skript während der Überprüfungsphase (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.
ImageTemplateRestartCustomizer	Startet einen virtuellen Computer neu und wartet darauf, dass er wieder online (Windows) zurückkommt. Entspricht packer windows-restart provisioner
ImageTemplateSharedImageDistributor	Verteilen über den Azure Compute Gallery.
ImageTemplateSharedImageVersionSource	Beschreibt eine Bildquelle, die eine Bildversion in einem Azure Compute Gallery oder einem direkten freigegebenen Katalog ist.
ImageTemplateShellCustomizer	Führt während der Anpassungsphase (Linux) ein Shellskript aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.
ImageTemplateShellValidator	Führt das angegebene Shellskript während der Validierungsphase (Linux) aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.
ImageTemplateVhdDistributor	Verteilen sie über VHD in einem Speicherkonto.
ImageTemplateVmProfile	Beschreibt die virtuellen Computer, die zum Erstellen und Überprüfen von Images verwendet werden.
ImageTemplateWindowsUpdateCustomizer	Installiert Windows-Updates. Entspricht packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)
Optimize	Gibt die Optimierung an, die für das Bild ausgeführt werden soll.
PlatformImagePurchasePlan	Kaufplankonfiguration für Plattformimages.
ProvisioningError	Beschreibt den Fehler beim Erstellen oder Aktualisieren einer Bildvorlage.
ProvisioningErrorCode	Fehlercode des Bereitstellungsfehlers
ProvisioningState	Bereitstellungsstatus der Ressource
ResourceIdentityType	Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage.
RunState	Status der letzten Ausführung
RunSubState	Unterstatus der letzten Ausführung
SharedImageStorageAccountType	Gibt den Speicherkontotyp an, der zum Speichern der Azure Compute Gallery-Imageversion verwendet werden soll.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TargetRegion	Beschreibt die Zielregioneninformationen.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften
Validate	Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen.
VirtualNetworkConfig	Konfiguration des virtuellen Netzwerks.
VmBoot	Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet.
VMBootOptimizationState	Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird.

CloudError

Objekt

Eine Fehlerantwort des Azure VM Image Builder-Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Objekt

Eine Fehlerantwort des Azure VM Image Builder-Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DistributeVersionerLatest

Objekt

Generiert versionsnummer, die auf vorhandenen Versionsnummern basiert.

Name	Typ	Standardwert	Beschreibung
major	integer (int32) minimum: -1	-1	Hauptversion für die generierte Versionsnummer. Ermitteln Sie, was "neueste" basierend auf Versionen mit diesem Wert als Hauptversion ist. -1 entspricht dem Aufheben der Unmenge.
scheme	string: Latest		Versionsnummerierungsschema, das verwendet werden soll.

DistributeVersionerSource

Objekt

Generiert Versionsnummer basierend auf der Versionsnummer des Quellbilds

Name	Typ	Beschreibung
scheme	string: Source	Versionsnummerierungsschema, das verwendet werden soll.

ImageTemplate

Objekt

Bildvorlage ist eine ARM-Ressource, die vom Microsoft.VirtualMachineImages-Anbieter verwaltet wird.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ImageTemplateIdentity		Die Identität der Bildvorlage, falls konfiguriert.
location	string		Der geografische Standort, an dem sich die Ressource befindet
name	string		Der Name der Ressource
properties.buildTimeoutInMinutes	integer (int32) minimum: 0 maximum: 960	0	Maximale Wartezeit beim Erstellen der Bildvorlage (umfasst alle Anpassungen, Optimierungen, Validierungen und Verteilungen). Lassen Sie "0" aus, oder geben Sie "0" an, um die Standardeinstellung zu verwenden (4 Stunden).
properties.customize	ImageTemplateCustomizer[]: ImageTemplateFileCustomizer[] ImageTemplatePowerShellCustomizer[] ImageTemplateRestartCustomizer[] ImageTemplateShellCustomizer[] ImageTemplateWindowsUpdateCustomizer[]		Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw.
properties.distribute	ImageTemplateDistributor[]: ImageTemplateManagedImageDistributor[] ImageTemplateSharedImageDistributor[] ImageTemplateVhdDistributor[]		Die Verteilungsziele, zu denen die Bildausgabe wechseln muss.
properties.exactStagingResourceGroup	string		Die Stagingressourcengruppen-ID im selben Abonnement wie die Bildvorlage, die zum Erstellen des Images verwendet wird. Dieses schreibgeschützte Feld unterscheidet sich nur dann von 'stagingResourceGroup', wenn der im Feld "stagingResourceGroup" angegebene Wert leer ist.
properties.lastRunStatus	ImageTemplateLastRunStatus		Status von "Run", der derzeit ausgeführt wird oder zuletzt ausgeführt wurde.
properties.optimize	Optimize		Gibt die Optimierung an, die für das Bild ausgeführt werden soll.
properties.provisioningError	ProvisioningError		Bereitstellungsfehler, falls vorhanden
properties.provisioningState	ProvisioningState		Bereitstellungsstatus der Ressource
properties.source	ImageTemplateSource: ImageTemplateManagedImageSource ImageTemplatePlatformImageSource ImageTemplateSharedImageVersionSource		Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden.
properties.stagingResourceGroup	string		Die Stagingressourcengruppen-ID im selben Abonnement wie die Bildvorlage, die zum Erstellen des Images verwendet wird. Wenn dieses Feld leer ist, wird eine Ressourcengruppe mit einem zufälligen Namen erstellt. Wenn die in diesem Feld angegebene Ressourcengruppe nicht vorhanden ist, wird sie mit demselben Namen erstellt. Wenn die angegebene Ressourcengruppe vorhanden ist, muss sie leer und in demselben Bereich wie die Bildvorlage sein. Die erstellte Ressourcengruppe wird beim Löschen von Vorlagen gelöscht, wenn dieses Feld leer ist oder die angegebene Ressourcengruppe nicht vorhanden ist, aber wenn die angegebene Ressourcengruppe vorhanden ist, werden die in der Ressourcengruppe erstellten Ressourcen während des Vorlagenlöschvorgangs gelöscht, und die Ressourcengruppe selbst bleibt erhalten.
properties.validate	Validate		Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen.
properties.vmProfile	ImageTemplateVmProfile		Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden
systemData	systemData		Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object		Ressourcentags.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Objekt

Lädt Dateien auf VMs hoch (Linux, Windows). Entspricht dem Packer-Dateibereitstellungsprogramm

Name	Typ	Beschreibung
destination	string	Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird
name	string	Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird
sha256Checksum	string	SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird
sourceUri	string	Der URI der Datei, die zum Anpassen der VM hochgeladen werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln.
type	string: File	Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein

ImageTemplateFileValidator

Objekt

Lädt Dateien hoch, die für die Überprüfung auf VMs (Linux, Windows) erforderlich sind. Entspricht dem Packer-Dateibereitstellungsprogramm

Name	Typ	Beschreibung
destination	string	Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird
name	string	Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird
sha256Checksum	string	SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird
sourceUri	string	Der URI der Datei, die zur Überprüfung auf den virtuellen Computer hochgeladen werden soll. Dabei kann es sich um einen GitHub-Link, einen Azure Storage-URI (autorisiert oder SAS) handeln usw.
type	string: File	Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein.

ImageTemplateIdentity

Objekt

Identität für die Bildvorlage.

Name	Typ	Beschreibung
type	ResourceIdentityType	Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage.
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ImageTemplateLastRunStatus

Objekt

Beschreibt den neuesten Status der Ausführung einer Bildvorlage.

Name	Typ	Beschreibung
endTime	string (date-time)	Endzeit der letzten Ausführung (UTC)
message	string	Ausführliche Informationen zum Zustand der letzten Ausführung
runState	RunState	Status der letzten Ausführung
runSubState	RunSubState	Unterstatus der letzten Ausführung
startTime	string (date-time)	Startzeit der letzten Ausführung (UTC)

ImageTemplateManagedImageDistributor

Objekt

Als verwaltetes Datenträgerimage verteilen.

Name	Typ	Beschreibung
artifactTags	object	Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde.
imageId	string	Ressourcen-ID des Image des verwalteten Datenträgers
location	string	Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Der Name, der für den zugeordneten RunOutput verwendet werden soll.
type	string: ManagedImage	Typ der Verteilung.

ImageTemplateManagedImageSource

Objekt

Beschreibt eine Bildquelle, die ein verwaltetes Bild im Kundenabonnement ist. Dieses Bild muss sich in demselben Abonnement und derselben Region wie die Image Builder-Vorlage befinden.

Name	Typ	Beschreibung
imageId	string	ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement
type	string: ManagedImage	Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten.

ImageTemplatePlatformImageSource

Objekt

Beschreibt eine Bildquelle aus Azure Gallery Images.

Name	Typ	Beschreibung
exactVersion	string	Bildversion aus der Azure Gallery Images. Dieses Readonly-Feld unterscheidet sich von "version", nur wenn der im Feld "Version" angegebene Wert "latest" lautet.
offer	string	Bildangebot aus dem Azure Gallery Images.
planInfo	PlatformImagePurchasePlan	Optionale Konfiguration des Einkaufsplans für das Plattformimage.
publisher	string	Bildherausgeber in Azure Gallery Images.
sku	string	Bildsku aus der Azure Gallery Images.
type	string: PlatformImage	Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten.
version	string	Bildversion aus der Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird.

ImageTemplatePowerShellCustomizer

Objekt

Führt die angegebene PowerShell auf der VM (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

Name	Typ	Standardwert	Beschreibung
inline	string[]		Array von auszuführenden PowerShell-Befehlen
name	string		Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird
runAsSystem	boolean	False	Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten mithilfe des lokalen Systembenutzers ausgeführt. Kann nur true sein, wenn das obige RunElevated-Feld auf "true" festgelegt ist.
runElevated	boolean	False	Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt.
scriptUri	string		URI des PowerShell-Skripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln.
sha256Checksum	string		SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird
type	string: PowerShell		Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein
validExitCodes	integer[] (int32)		Gültige Exitcodes für das PowerShell-Skript. [Standard: 0]

ImageTemplatePowerShellValidator

Objekt

Führt das angegebene PowerShell-Skript während der Überprüfungsphase (Windows) aus. Entspricht packer powershell provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

Name	Typ	Standardwert	Beschreibung
inline	string[]		Array von auszuführenden PowerShell-Befehlen
name	string		Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird
runAsSystem	boolean	False	Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten mithilfe des lokalen Systembenutzers ausgeführt. Kann nur true sein, wenn das obige RunElevated-Feld auf "true" festgelegt ist.
runElevated	boolean	False	Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt.
scriptUri	string		URI des PowerShell-Skripts, das zur Überprüfung ausgeführt werden soll. Dabei kann es sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln.
sha256Checksum	string		SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird
type	string: PowerShell		Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein.
validExitCodes	integer[] (int32)		Gültige Exitcodes für das PowerShell-Skript. [Standard: 0]

ImageTemplateRestartCustomizer

Objekt

Startet einen virtuellen Computer neu und wartet darauf, dass er wieder online (Windows) zurückkommt. Entspricht packer windows-restart provisioner

Name	Typ	Beschreibung
name	string	Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird
restartCheckCommand	string	Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: '']
restartCommand	string	Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"']
restartTimeout	string	Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m']
type	string: WindowsRestart	Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein

ImageTemplateSharedImageDistributor

Objekt

Verteilen über den Azure Compute Gallery.

Name	Typ	Standardwert	Beschreibung
artifactTags	object		Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde.
excludeFromLatest	boolean	False	Flag, das angibt, ob die erstellte Bildversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) weg.
galleryImageId	string		Ressourcen-ID des Azure Compute Gallery-Bilds
replicationRegions	string[]		[Veraltet] Eine Liste der Regionen, in die das Bild repliziert wird. Diese Liste kann nur angegeben werden, wenn targetRegions nicht angegeben ist. Dieses Feld ist veraltet – verwenden Sie stattdessen targetRegions.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$		Der Name, der für den zugeordneten RunOutput verwendet werden soll.
storageAccountType	SharedImageStorageAccountType		[Veraltet] Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). Dieses Feld kann nur angegeben werden, wenn "replicationRegions" angegeben ist. Dieses Feld ist veraltet – verwenden Sie stattdessen targetRegions.
targetRegions	TargetRegion[]		Die Zielbereiche, in denen die verteilte Imageversion repliziert werden soll. Dieses Objekt ersetzt replikationRegions und kann nur angegeben werden, wenn "replicationRegions" nicht angegeben ist.
type	string: SharedImage		Typ der Verteilung.
versioning	DistributeVersioner: DistributeVersionerLatest DistributeVersionerSource		Beschreibt, wie neue x.y.z-Versionsnummer für die Verteilung generiert wird.

ImageTemplateSharedImageVersionSource

Objekt

Beschreibt eine Bildquelle, die eine Bildversion in einem Azure Compute Gallery oder einem direkten freigegebenen Katalog ist.

Name	Typ	Beschreibung
exactVersion	string	Genaue ARM-Ressourcen-ID der Bildversion. Dieses Readonly-Feld unterscheidet sich von der Bildversions-ID in "imageVersionId" nur, wenn der im Feld "imageVersionId" angegebene Versionsname "latest" lautet.
imageVersionId	string	ARM-Ressourcen-ID der Bildversion. Wenn der Name der Bildversion "latest" lautet, wird die Version ausgewertet, wenn der Imagebuild stattfindet.
type	string: SharedImageVersion	Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten.

ImageTemplateShellCustomizer

Objekt

Führt während der Anpassungsphase (Linux) ein Shellskript aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

Name	Typ	Beschreibung
inline	string[]	Array der auszuführenden Shellbefehle
name	string	Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird
scriptUri	string	URI des Shellskripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln.
sha256Checksum	string	SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird
type	string: Shell	Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein

ImageTemplateShellValidator

Objekt

Führt das angegebene Shellskript während der Validierungsphase (Linux) aus. Entspricht dem Packer Shell-Provisioner. Genau einer von 'scriptUri' oder 'inline' kann angegeben werden.

Name	Typ	Beschreibung
inline	string[]	Array der auszuführenden Shellbefehle
name	string	Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird
scriptUri	string	URI des Shellskripts, das zur Überprüfung ausgeführt werden soll. Dabei kann es sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln.
sha256Checksum	string	SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird
type	string: Shell	Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein.

ImageTemplateVhdDistributor

Objekt

Verteilen sie über VHD in einem Speicherkonto.

Name	Typ	Beschreibung
artifactTags	object	Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde.
runOutputName	string pattern: ^[A-Za-z0-9-_.]{1,64}$	Der Name, der für den zugeordneten RunOutput verwendet werden soll.
type	string: VHD	Typ der Verteilung.
uri	string	Optionaler Azure Storage-URI für das verteilte VHD-Blob. Lassen Sie die Standardeinstellung (leere Zeichenfolge) aus, in diesem Fall würde VHD in dem Speicherkonto in der Stagingressourcengruppe veröffentlicht.

ImageTemplateVmProfile

Objekt

Beschreibt die virtuellen Computer, die zum Erstellen und Überprüfen von Images verwendet werden.

Name	Typ	Standardwert	Beschreibung
osDiskSizeGB	integer (int32) minimum: 0	0	Größe des Betriebssystemdatenträgers in GB. Geben Sie "0" aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden.
userAssignedIdentities	string[]		Optionales Array von Ressourcen-IDs von vom Benutzer zugewiesenen verwalteten Identitäten, die auf dem virtuellen Buildcomputer und der Validierungs-VM konfiguriert werden sollen. Dies kann die Identität der Bildvorlage enthalten.
vmSize	string		Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie die leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (Standard_D1_v2 für Gen1-Bilder und Standard_D2ds_v4 für Gen2-Bilder).
vnetConfig	VirtualNetworkConfig		Optionale Konfiguration des virtuellen Netzwerks zur Bereitstellung der Build-VM und validierungs-VM in. Lassen Sie aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss.

ImageTemplateWindowsUpdateCustomizer

Objekt

Installiert Windows-Updates. Entspricht packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Name	Typ	Standardwert	Beschreibung
filters	string[]		Array von Filtern, um updates auszuwählen, die angewendet werden sollen. Lassen Sie das leere Array aus, um den Standardwert zu verwenden (kein Filter). Im obigen Link finden Sie Beispiele und eine ausführliche Beschreibung dieses Felds.
name	string		Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird
searchCriteria	string		Kriterien für die Suche nach Aktualisierungen. Lassen Oder geben Sie leere Zeichenfolge an, um die Standardeinstellung zu verwenden (alle durchsuchen). Im obigen Link finden Sie Beispiele und eine ausführliche Beschreibung dieses Felds.
type	string: WindowsUpdate		Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein
updateLimit	integer (int32) minimum: 0	0	Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Auslassen oder Angeben von 0 für die Verwendung des Standardwerts (1000)

Optimize

Objekt

Gibt die Optimierung an, die für das Bild ausgeführt werden soll.

Name	Typ	Beschreibung
vmBoot	VmBoot	Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet.

PlatformImagePurchasePlan

Objekt

Kaufplankonfiguration für Plattformimages.

Name	Typ	Beschreibung
planName	string	Name des Einkaufsplans.
planProduct	string	Produkt des Einkaufsplans.
planPublisher	string	Herausgeber des Einkaufsplans.

ProvisioningError

Objekt

Beschreibt den Fehler beim Erstellen oder Aktualisieren einer Bildvorlage.

Name	Typ	Beschreibung
message	string	Ausführliche Fehlermeldung über den Bereitstellungsfehler
provisioningErrorCode	ProvisioningErrorCode	Fehlercode des Bereitstellungsfehlers

ProvisioningErrorCode

Enumeration

Fehlercode des Bereitstellungsfehlers

Wert	Beschreibung
BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Other

ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource

Wert	Beschreibung
Creating
Updating
Succeeded
Failed
Deleting
Canceled

ResourceIdentityType

Enumeration

Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage.

Wert	Beschreibung
UserAssigned
None

RunState

Enumeration

Status der letzten Ausführung

Wert	Beschreibung
Running
Canceling
Succeeded
PartiallySucceeded
Failed
Canceled

RunSubState

Enumeration

Unterstatus der letzten Ausführung

Wert	Beschreibung
Queued
Building
Customizing
Optimizing
Validating
Distributing

SharedImageStorageAccountType

Enumeration

Gibt den Speicherkontotyp an, der zum Speichern der Azure Compute Gallery-Imageversion verwendet werden soll.

Wert	Beschreibung
Standard_LRS
Standard_ZRS
Premium_LRS

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TargetRegion

Objekt

Beschreibt die Zielregioneninformationen.

Name	Typ	Standardwert	Beschreibung
name	string		Der Name der Region.
replicaCount	integer (int32) minimum: 1	1	Die Anzahl der Replikate der Bildversion, die in dieser Region erstellt werden soll. Lassen Sie die Standardeinstellung (1) weg.
storageAccountType	SharedImageStorageAccountType		Gibt den Speicherkontotyp an, der zum Speichern des Bilds in dieser Region verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS).

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string	Die Client-ID der zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der zugewiesenen Identität.

Validate

Objekt

Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen.

Name	Typ	Standardwert	Beschreibung
continueDistributeOnFailure	boolean	False	Wenn die Überprüfung fehlschlägt und dieses Feld auf "false" festgelegt ist, wird das Ausgabebild(n) nicht verteilt. Dies ist das Standardverhalten. Wenn die Überprüfung fehlschlägt und dieses Feld auf "true" festgelegt ist, werden Ausgabebilder weiterhin verteilt. Verwenden Sie diese Option mit Vorsicht, da dies dazu führen kann, dass schlechte Bilder zur Verwendung verteilt werden. In beiden Fällen (true oder false) wird die End-to-End-Image-Ausführung gemeldet, wenn bei einem Überprüfungsfehler ein Fehler aufgetreten ist. [Hinweis: Dieses Feld hat keine Auswirkung, wenn die Überprüfung erfolgreich ist.]
inVMValidations	ImageTemplateInVMValidator[]: ImageTemplateFileValidator[] ImageTemplatePowerShellValidator[] ImageTemplateShellValidator[]		Liste der überprüfungen, die ausgeführt werden sollen.
sourceValidationOnly	boolean	False	Wenn dieses Feld auf "true" festgelegt ist, wird das im Abschnitt "Quelle" angegebene Bild direkt überprüft. Es wird kein separater Build ausgeführt, um ein angepasstes Image zu generieren und zu überprüfen.

VirtualNetworkConfig

Objekt

Konfiguration des virtuellen Netzwerks.

Name	Typ	Beschreibung
proxyVmSize	string	Die Größe des virtuellen Proxycomputers, der zum Übergeben des Datenverkehrs an den virtuellen Buildcomputer und die Überprüfungs-VM verwendet wird. Lassen Oder geben Sie leere Zeichenfolge an, um die Standardeinstellung zu verwenden (Standard_A1_v2).
subnetId	string	Ressourcen-ID eines bereits vorhandenen Subnetzes.

VmBoot

Objekt

Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet.

Name	Typ	Beschreibung
state	VMBootOptimizationState	Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird.

VMBootOptimizationState

Enumeration

Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird.

Wert	Beschreibung
Enabled
Disabled

Freigeben über

Virtual Machine Image Templates - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Retrieve an Image Template.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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