Freigeben über


Virtual Machine Image Templates - Get

Abrufen von Informationen zu einer Vm-Imagevorlage

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

Der Name der Bildvorlage

RegEx-Muster: ^[A-Za-z0-9-_.]{1,64}$

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

OK

Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

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

{
  "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 der Grundlage vorhandener Versionsnummern die neueste ist.

DistributeVersionerSource

Generiert die Versionsnummer basierend auf der Versionsnummer des Quellimages.

ImageTemplate

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

ImageTemplateFileCustomizer

Lädt Dateien auf virtuelle Computer (Linux, Windows) hoch. Entspricht Packer-Dateibereitstellung

ImageTemplateFileValidator

Lädt dateien, die für die Validierung erforderlich sind, auf virtuelle Computer (Linux, Windows) hoch. Entspricht der Packer-Dateibereitstellung.

ImageTemplateIdentity

Identität für die Bildvorlage.

ImageTemplateLastRunStatus

Beschreibt den neuesten status der Ausführung einer Bildvorlage

ImageTemplateManagedImageDistributor

Verteilen sie als verwaltetes Datenträgerimage.

ImageTemplateManagedImageSource

Beschreibt eine Bildquelle, bei der es sich um ein verwaltetes Image im Kundenabonnement handelt. Dieses Image 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 dem virtuellen Computer (Windows) aus. Entspricht der Packer PowerShell-Bereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplatePowerShellValidator

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

ImageTemplateRestartCustomizer

Startet einen virtuellen Computer neu und wartet, bis er wieder online ist (Windows). Entspricht packer windows-restart provisioner

ImageTemplateSharedImageDistributor

Verteilen sie über den Azure Compute-Katalog.

ImageTemplateSharedImageVersionSource

Beschreibt eine Imagequelle, bei der es sich um eine Imageversion in einem Azure Compute-Katalog oder einem direct Shared Gallery handelt.

ImageTemplateShellCustomizer

Führt ein Shellskript während der Anpassungsphase (Linux) aus. Entspricht der Packer-Shellbereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

ImageTemplateShellValidator

Führt das angegebene Shellskript während der Validierungsphase (Linux) aus. Entspricht der Packer-Shellbereitstellung. 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 Image ausgeführt werden soll.

PlatformImagePurchasePlan

Konfiguration des Einkaufsplans für das Plattformimage.

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

Unterzustand der letzten Ausführung

SharedImageStorageAccountType

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

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

TargetRegion

Beschreibt die Zielregionsinformationen.

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

Validate

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

VirtualNetworkConfig

Virtual Network Konfiguration.

VmBoot

Die Optimierung wird auf das Image angewendet, um einen schnelleren VM-Start zu ermöglichen.

VMBootOptimizationState

Wenn Sie dieses Feld aktivieren, wird die Vm-Startzeit verbessert, indem die endgültige angepasste Imageausgabe optimiert wird.

CloudError

Eine Fehlerantwort des Azure VM Image Builder-Diensts.

Name Typ Beschreibung
error

CloudErrorBody

Details zum Fehler.

CloudErrorBody

Eine Fehlerantwort des Azure VM Image Builder-Diensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet 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 sein soll.

target

string

Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DistributeVersionerLatest

Generiert versionsnummer, die auf der Grundlage vorhandener Versionsnummern die neueste ist.

Name Typ Standardwert Beschreibung
major

integer

-1

Hauptversion für die generierte Versionsnummer. Ermitteln Sie anhand von Versionen mit diesem Wert als Hauptversion, was "latest" ist. -1 entspricht nicht festgelegt.

scheme string:

Latest

Zu verwendendes Versionsnummerierungsschema.

DistributeVersionerSource

Generiert die Versionsnummer basierend auf der Versionsnummer des Quellimages.

Name Typ Beschreibung
scheme string:

Source

Zu verwendendes Versionsnummerierungsschema.

ImageTemplate

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. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ImageTemplateIdentity

Die Identität der Bildvorlage, sofern konfiguriert.

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.buildTimeoutInMinutes

integer

0

Maximale Wartezeit beim Erstellen der Imagevorlage (einschließlich aller Anpassungen, Optimierungen, Validierungen und Verteilungen). Lassen Sie aus, oder geben Sie 0 an, um den Standardwert zu verwenden (4 Stunden).

properties.customize ImageTemplateCustomizer[]:

Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw.

properties.distribute ImageTemplateDistributor[]:

Die Verteilung zielt darauf ab, an die die Bildausgabe gehen muss.

properties.exactStagingResourceGroup

string

Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, 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 der "Ausführung", der derzeit ausgeführt wird oder zuletzt ausgeführt wurde.

properties.optimize

Optimize

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

properties.provisioningError

ProvisioningError

Bereitstellungsfehler, falls vorhanden

properties.provisioningState

ProvisioningState

Bereitstellungsstatus der Ressource

properties.source ImageTemplateSource:

Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden.

properties.stagingResourceGroup

string

Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, 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 derselben Region wie die Bildvorlage sein. Die erstellte Ressourcengruppe wird beim Löschen der Vorlage 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 beim Löschen der Vorlage gelöscht, und die Ressourcengruppe selbst bleibt erhalten.

properties.validate

Validate

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

properties.vmProfile

ImageTemplateVmProfile

Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird.

systemData

systemData

Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ImageTemplateFileCustomizer

Lädt Dateien auf virtuelle Computer (Linux, Windows) hoch. Entspricht Packer-Dateibereitstellung

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 für die Aufgaben dieses Anpassungsschritts

sha256Checksum

string

SHA256-Prüfsumme der Datei, die im feld sourceUri oben bereitgestellt wird

sourceUri

string

Der URI der Datei, die zum Anpassen des virtuellen Computers hochgeladen werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln.

type string:

File

Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein.

ImageTemplateFileValidator

Lädt dateien, die für die Validierung erforderlich sind, auf virtuelle Computer (Linux, Windows) hoch. Entspricht der Packer-Dateibereitstellung.

Name Typ Beschreibung
destination

string

Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) auf der VM hochgeladen wird

name

string

Anzeigename, um Kontext für die Funktionsweise dieses Überprüfungsschritts bereitzustellen

sha256Checksum

string

SHA256-Prüfsumme der Datei, die oben im Feld sourceUri bereitgestellt wird

sourceUri

string

Der URI der Datei, die zur Überprüfung auf den virtuellen Computer hochgeladen werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI (autorisiert oder SAS) usw. handeln.

type string:

File

Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln.

ImageTemplateIdentity

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 benutzerseitig zugewiesenen Identitäten, die der Ressource zugeordnet sind. Bei den UserAssignedIdentities-Wörterbuchschlüsseln handelt es sich um ARM-Ressourcen-IDs in der Form : '/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ImageTemplateLastRunStatus

Beschreibt den neuesten status der Ausführung einer Bildvorlage

Name Typ Beschreibung
endTime

string

Endzeit der letzten Ausführung (UTC)

message

string

Ausführliche Informationen zum letzten Ausführungsstatus

runState

RunState

Status der letzten Ausführung

runSubState

RunSubState

Unterzustand der letzten Ausführung

startTime

string

Startzeit der letzten Ausführung (UTC)

ImageTemplateManagedImageDistributor

Verteilen sie als verwaltetes Datenträgerimage.

Name Typ Beschreibung
artifactTags

object

Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde.

imageId

string

Ressourcen-ID des Verwalteten Datenträgerimages

location

string

Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist

runOutputName

string

Der Name, der für den zugeordneten RunOutput verwendet werden soll.

type string:

ManagedImage

Verteilungstyp.

ImageTemplateManagedImageSource

Beschreibt eine Bildquelle, bei der es sich um ein verwaltetes Image im Kundenabonnement handelt. Dieses Image 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 Quellimages an, mit dem Sie beginnen möchten.

ImageTemplatePlatformImageSource

Beschreibt eine Bildquelle aus Azure Gallery Images.

Name Typ Beschreibung
exactVersion

string

Imageversion aus den Azure-Katalogimages. Dieses schreibgeschützte Feld unterscheidet sich von "version", nur wenn der im Feld "version" angegebene Wert "neueste" ist.

offer

string

Imageangebot aus dem Azure-Katalog images.

planInfo

PlatformImagePurchasePlan

Optionale Konfiguration des Kaufplans für das Plattformimage.

publisher

string

Image Publisher in Azure Gallery Images.

sku

string

Image-SKU aus den Azure-Katalogimages.

type string:

PlatformImage

Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten.

version

string

Imageversion aus den Azure-Katalogimages. Wenn hier "neueste" angegeben wird, wird die Version beim Erstellen des Images ausgewertet, nicht beim Übermitteln der Vorlage.

ImageTemplatePowerShellCustomizer

Führt die angegebene PowerShell auf dem virtuellen Computer (Windows) aus. Entspricht der Packer PowerShell-Bereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

Name Typ Standardwert Beschreibung
inline

string[]

Array der auszuführenden PowerShell-Befehle

name

string

Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts

runAsSystem

boolean

False

Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt, indem der Lokale Systembenutzer verwendet wird. Kann nur true sein, wenn das feld runElevated oben auf true festgelegt ist.

runElevated

boolean

False

Falls 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, einen 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 Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein.

validExitCodes

integer[]

Gültige Exitcodes für das PowerShell-Skript. [Standard: 0]

ImageTemplatePowerShellValidator

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

Name Typ Standardwert Beschreibung
inline

string[]

Array der auszuführenden PowerShell-Befehle

name

string

Anzeigename, um Kontext für die Funktionsweise dieses Überprüfungsschritts bereitzustellen

runAsSystem

boolean

False

Falls 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 Berechtigungen ausgeführt.

scriptUri

string

URI des PowerShell-Skripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln.

sha256Checksum

string

SHA256-Prüfsumme des Power Shell-Skripts, das im feld scriptUri oben bereitgestellt wird

type string:

PowerShell

Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln.

validExitCodes

integer[]

Gültige Exitcodes für das PowerShell-Skript. [Standard: 0]

ImageTemplateRestartCustomizer

Startet einen virtuellen Computer neu und wartet, bis er wieder online ist (Windows). Entspricht packer windows-restart provisioner

Name Typ Beschreibung
name

string

Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts

restartCheckCommand

string

Befehl, um zu überprüfen, ob der Neustart erfolgreich war [Standard: '']

restartCommand

string

Befehl zum Ausführen des Neustarts [Standardeinstellung: 'shutdown /r /f /t 0 /c 'packer restart'']

restartTimeout

string

Neustarttimeout als Zeichenfolge von Größe und Einheit angegeben, z. B. "5m" (5 Minuten) oder "2 Stunden" (2 Stunden) [Standard: '5m']

type string:

WindowsRestart

Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein.

ImageTemplateSharedImageDistributor

Verteilen sie über den Azure Compute-Katalog.

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 Imageversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) aus.

galleryImageId

string

Ressourcen-ID des Azure Compute-Katalogimages

replicationRegions

string[]

[Veraltet] Eine Liste der Regionen, in die das Image repliziert wird. Diese Liste kann nur angegeben werden, wenn targetRegions nicht angegeben ist. Dieses Feld ist veraltet. Verwenden Sie stattdessen targetRegions.

runOutputName

string

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 (Standard_LRS) aus. Dieses Feld kann nur angegeben werden, wenn replicationRegions angegeben ist. Dieses Feld ist veraltet. Verwenden Sie stattdessen targetRegions.

targetRegions

TargetRegion[]

Die Zielregionen, in denen die verteilte Imageversion repliziert wird. Dieses Objekt ersetzt replicationRegions und kann nur angegeben werden, wenn replicationRegions nicht angegeben ist.

type string:

SharedImage

Verteilungstyp.

versioning DistributeVersioner:

Beschreibt, wie eine neue x.y.z-Versionsnummer für die Verteilung generiert wird.

ImageTemplateSharedImageVersionSource

Beschreibt eine Imagequelle, bei der es sich um eine Imageversion in einem Azure Compute-Katalog oder einem direct Shared Gallery handelt.

Name Typ Beschreibung
exactVersion

string

Genaue ARM-Ressourcen-ID der Imageversion. Dieses schreibgeschützte Feld unterscheidet sich nur dann von der Imageversions-ID in "imageVersionId", wenn der im Feld "imageVersionId" angegebene Versionsname "neueste" lautet.

imageVersionId

string

ARM-Ressourcen-ID der Imageversion. Wenn der Imageversionsname „latest“ lautet, wird die Version ausgewertet, wenn der Imagebuild stattfindet.

type string:

SharedImageVersion

Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten.

ImageTemplateShellCustomizer

Führt ein Shellskript während der Anpassungsphase (Linux) aus. Entspricht der Packer-Shellbereitstellung. Genau eine von "scriptUri" oder "inline" kann angegeben werden.

Name Typ Beschreibung
inline

string[]

Array der auszuführenden Shellbefehle

name

string

Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts

scriptUri

string

URI des Shellskripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln.

sha256Checksum

string

SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird

type string:

Shell

Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein.

ImageTemplateShellValidator

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

Name Typ Beschreibung
inline

string[]

Array der auszuführenden Shellbefehle

name

string

Anzeigename, um Kontext für die Funktionsweise dieses Überprüfungsschritts bereitzustellen

scriptUri

string

URI des Shellskripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln.

sha256Checksum

string

SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird

type string:

Shell

Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln.

ImageTemplateVhdDistributor

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

Der Name, der für den zugeordneten RunOutput verwendet werden soll.

type string:

VHD

Verteilungstyp.

uri

string

Optionaler Azure Storage-URI für das verteilte VHD-Blob. Lassen Sie diese Option weg, um den Standardwert (leere Zeichenfolge) zu verwenden. In diesem Fall würde die VHD im Speicherkonto in der Stagingressourcengruppe veröffentlicht werden.

ImageTemplateVmProfile

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

Name Typ Standardwert Beschreibung
osDiskSizeGB

integer

0

Größe des Betriebssystemdatenträgers in GB. Lassen Sie 0 aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden.

userAssignedIdentities

string[]

Optionales Array von Ressourcen-IDs mit benutzerseitig zugewiesenen verwalteten Identitäten, die auf der Build-VM und der Validierungs-VM konfiguriert werden sollen. Dies kann die Identität der Bildvorlage umfassen.

vmSize

string

Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie die leere Zeichenfolge aus, um den Standardwert zu verwenden (Standard_D1_v2 für Gen1-Bilder und Standard_D2ds_v4 für Gen2-Bilder).

vnetConfig

VirtualNetworkConfig

Optionale Konfiguration des virtuellen Netzwerks, die zum Bereitstellen der Build-VM und der Überprüfungs-VM in verwendet werden soll. Lassen Sie diese Angabe aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss.

ImageTemplateWindowsUpdateCustomizer

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 zum Auswählen der zu übernehmenden Updates. Lassen Sie das leere Array aus, oder geben Sie es an, um den Standard (kein Filter) zu verwenden. Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie im obigen Link.

name

string

Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts

searchCriteria

string

Kriterien für die Suche nach Updates. Lassen Sie die leere Zeichenfolge weg, oder geben Sie sie an, um den Standardwert zu verwenden (alle durchsuchen). Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie im obigen Link.

type string:

WindowsUpdate

Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein.

updateLimit

integer

0

Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Weglassen oder 0 angeben, um den Standardwert zu verwenden (1000)

Optimize

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

Name Typ Beschreibung
vmBoot

VmBoot

Die Optimierung wird auf das Image angewendet, um einen schnelleren VM-Start zu ermöglichen.

PlatformImagePurchasePlan

Konfiguration des Einkaufsplans für das Plattformimage.

Name Typ Beschreibung
planName

string

Name des Einkaufsplans.

planProduct

string

Produkt des Einkaufsplans.

planPublisher

string

Herausgeber des Kaufplans.

ProvisioningError

Beschreibt den Fehler beim Erstellen oder Aktualisieren einer Bildvorlage.

Name Typ Beschreibung
message

string

Ausführliche Fehlermeldung zum Bereitstellungsfehler

provisioningErrorCode

ProvisioningErrorCode

Fehlercode des Bereitstellungsfehlers

ProvisioningErrorCode

Fehlercode des Bereitstellungsfehlers

Name Typ Beschreibung
BadCustomizerType

string

BadDistributeType

string

BadManagedImageSource

string

BadPIRSource

string

BadSharedImageDistribute

string

BadSharedImageVersionSource

string

BadSourceType

string

BadStagingResourceGroup

string

BadValidatorType

string

NoCustomizerScript

string

NoValidatorScript

string

Other

string

ServerError

string

UnsupportedCustomizerType

string

UnsupportedValidatorType

string

ProvisioningState

Bereitstellungsstatus der Ressource

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

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

Name Typ Beschreibung
None

string

UserAssigned

string

RunState

Status der letzten Ausführung

Name Typ Beschreibung
Canceled

string

Canceling

string

Failed

string

PartiallySucceeded

string

Running

string

Succeeded

string

RunSubState

Unterzustand der letzten Ausführung

Name Typ Beschreibung
Building

string

Customizing

string

Distributing

string

Optimizing

string

Queued

string

Validating

string

SharedImageStorageAccountType

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

Name Typ Beschreibung
Premium_LRS

string

Standard_LRS

string

Standard_ZRS

string

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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

Beschreibt die Zielregionsinformationen.

Name Typ Standardwert Beschreibung
name

string

Der Name der Region.

replicaCount

integer

1

Die Anzahl der Replikate der Imageversion, die in dieser Region erstellt werden soll. Lassen Sie aus, um die Standardeinstellung (1) zu verwenden.

storageAccountType

SharedImageStorageAccountType

Gibt den Speicherkontotyp an, der zum Speichern des Images in dieser Region verwendet werden soll. Lassen Sie die Standardeinstellung (Standard_LRS) aus.

UserAssignedIdentity

Benutzerseitig 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

Konfigurationsoptionen und Liste der Validierungen, 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, werden die Ausgabebilder nicht verteilt. Dies ist das Standardverhalten. Wenn die Überprüfung fehlschlägt und dieses Feld auf true festgelegt ist, werden die 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 bei der End-to-End-Image-Ausführung gemeldet, dass im Falle eines Validierungsfehlers ein Fehler aufgetreten ist. [Hinweis: Dieses Feld hat keine Auswirkungen, wenn die Validierung erfolgreich ist.]

inVMValidations ImageTemplateInVMValidator[]:

Liste der durchzuführenden Überprüfungen.

sourceValidationOnly

boolean

False

Wenn dieses Feld auf true festgelegt ist, wird das im Abschnitt "Source" angegebene Bild direkt überprüft. Es wird kein separater Build ausgeführt, um ein angepasstes Image zu generieren und dann zu überprüfen.

VirtualNetworkConfig

Virtual Network Konfiguration.

Name Typ Beschreibung
proxyVmSize

string

Größe des virtuellen Proxycomputers, der verwendet wird, um Datenverkehr an die Build-VM und die Validierungs-VM zu übergeben. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge (Standard_A1_v2) zu verwenden.

subnetId

string

Ressourcen-ID eines bereits vorhandenen Subnetzes.

VmBoot

Die Optimierung wird auf das Image angewendet, um einen schnelleren VM-Start zu ermöglichen.

Name Typ Beschreibung
state

VMBootOptimizationState

Durch Aktivieren dieses Felds wird die Startzeit der VM verbessert, indem die endgültige ausgabe des angepassten Images optimiert wird.

VMBootOptimizationState

Wenn Sie dieses Feld aktivieren, wird die Vm-Startzeit verbessert, indem die endgültige angepasste Imageausgabe optimiert wird.

Name Typ Beschreibung
Disabled

string

Enabled

string