Freigeben über


Microsoft.VirtualMachineImages imageTemplates 2024-02-01

Bicep-Ressourcendefinition

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoRun: {
      state: 'string'
    }
    buildTimeoutInMinutes: int
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    errorHandling: {
      onCustomizerError: 'string'
      onValidationError: 'string'
    }
    managedResourceTags: {
      {customized property}: 'string'
    }
    optimize: {
      vmBoot: {
        state: 'string'
      }
    }
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    stagingResourceGroup: 'string'
    validate: {
      continueDistributeOnFailure: bool
      inVMValidations: [
        {
          name: 'string'
          type: 'string'
          // For remaining properties, see ImageTemplateInVMValidator objects
        }
      ]
      sourceValidationOnly: bool
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        containerInstanceSubnetId: 'string'
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

DistributeVersioner-Objekte

Legen Sie die Schemaeigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Neueste" Folgendes:

{
  major: int
  scheme: 'Latest'
}

Verwenden Sie für Source:

{
  scheme: 'Source'
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

Verwenden Sie für PowerShell Folgendes:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

Verwenden Sie für Shell Folgendes:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

Verwenden Sie für WindowsRestart Folgendes:

{
  restartCheckCommand: 'string'
  restartCommand: 'string'
  restartTimeout: 'string'
  type: 'WindowsRestart'
}

Verwenden Sie für WindowsUpdate Folgendes:

{
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  type: 'WindowsUpdate'
  updateLimit: int
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  imageId: 'string'
  type: 'ManagedImage'
}

Verwenden Sie für PlatformImage Folgendes:

{
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

Verwenden Sie für SharedImageVersion Folgendes:

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  imageId: 'string'
  location: 'string'
  type: 'ManagedImage'
}

Verwenden Sie für SharedImage Folgendes:

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  targetRegions: [
    {
      name: 'string'
      replicaCount: int
      storageAccountType: 'string'
    }
  ]
  type: 'SharedImage'
  versioning: {
    scheme: 'string'
    // For remaining properties, see DistributeVersioner objects
  }
}

Verwenden Sie für VHD Folgendes:

{
  type: 'VHD'
  uri: 'string'
}

ImageTemplateInVMValidator-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  destination: 'string'
  sha256Checksum: 'string'
  sourceUri: 'string'
  type: 'File'
}

Verwenden Sie für PowerShell Folgendes:

{
  inline: [
    'string'
  ]
  runAsSystem: bool
  runElevated: bool
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

Verwenden Sie für Shell Folgendes:

{
  inline: [
    'string'
  ]
  scriptUri: 'string'
  sha256Checksum: 'string'
  type: 'Shell'
}

Eigenschaftswerte

Microsoft.VirtualMachineImages/imageTemplates

Name BESCHREIBUNG Wert
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity (erforderlich)
Standort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplate-Eigenschaften
Schlagwörter Ressourcenetiketten Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

DistributeVersioner

Name BESCHREIBUNG Wert
Schema Legen Sie den Wert auf 'Latest' für den Typ DistributeVersionerLatest fest. Legen Sie für den Typ "DistributeVersionerSource" den Typ "Source" fest. "Neuestes"
"Quelle" (erforderlich)

DistributeVersionerNeueste

Name BESCHREIBUNG Wert
Haupt 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. Int

Zwänge:
Min-Wert = -1
Schema Versionsnummerierungsschema, das verwendet werden soll. "Neueste" (erforderlich)

DistributeVersionerSource

Name BESCHREIBUNG Wert
Schema Versionsnummerierungsschema, das verwendet werden soll. "Quelle" (erforderlich)

ImageTemplateAutoRun

Name BESCHREIBUNG Wert
Staat Wenn Sie dieses Feld aktivieren, wird ein automatischer Build für die Erstellung oder Aktualisierung von Bildvorlagen ausgelöst. "Deaktiviert"
"Aktiviert"

ImageTemplateCustomizer

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileCustomizer' festgelegt. Legen Sie für den Typ ImageTemplatePowerShellCustomizer auf 'PowerShell' fest. Legen Sie für den Typ ImageTemplateShellCustomizer auf 'Shell' fest. Legen Sie den Wert auf 'WindowsRestart' für den Typ ImageTemplateRestartCustomizer fest. Legen Sie diesen Wert auf 'WindowsUpdate' für den Typ ImageTemplateWindowsUpdateCustomizer fest. 'Datei'
"PowerShell"
"Schale"
"WindowsRestart"
"WindowsUpdate" (erforderlich)

ImageTemplateVerteiler

Name BESCHREIBUNG Wert
artefaktTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Typ Legen Sie den Wert auf "ManagedImage" für den Typ ImageTemplateManagedImageDistributor fest. Legen Sie den Wert auf 'SharedImage' für den Typ ImageTemplateSharedImageDistributor fest. Für den Typ ImageTemplateVhdDistributor auf 'VHD' festgelegt. "ManagedImage"
"SharedImage"
"VHD" (erforderlich)

ImageTemplateDistributorArtifactTags

Name BESCHREIBUNG Wert

ImageTemplateFileCustomizer

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Datei' (erforderlich)

ImageTemplateFileValidator

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Datei' (erforderlich)

ImageTemplateIdentity

Name BESCHREIBUNG Wert
Typ Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. "Keine"
"UserAssigned"
vom Benutzer zugewiesene 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. UserAssignedIdentities-

ImageTemplateInVMValidator

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileValidator' festgelegt. Auf 'PowerShell' für den Typ ImageTemplatePowerShellValidator festgelegt. Legen Sie für den Typ ImageTemplateShellValidator auf 'Shell' fest. 'Datei'
"PowerShell"
'Shell' (erforderlich)

ImageTemplateManagedImageDistributor

Name BESCHREIBUNG Wert
imageId (englisch) Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Standort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Typ Typ der Verteilung. "ManagedImage" (erforderlich)

ImageTemplateManagedImageSource

Name BESCHREIBUNG Wert
imageId (englisch) ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ManagedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name BESCHREIBUNG Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
planInfo Optionale Konfiguration des Einkaufsplans für das Plattformimage. PlattformImagePurchasePlan
Verleger Bildherausgeber in Azure Gallery Images. Schnur
Sku Bildsku aus den Azure Gallery Images. Schnur
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Ausgabe Bildversion aus den Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. Schnur

ImageTemplatePowerShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplatePowerShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplate-Eigenschaften

Name BESCHREIBUNG Wert
AutoRun Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. ImageTemplateAutoRun
buildTimeoutInMinuten 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). Int

Zwänge:
Min.-Wert = 0
Maximalwert = 960
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
errorBehandlung Fehlerbehandlungsoptionen bei Einem Buildfehler ImageTemplatePropertiesErrorHandling
managedResourceTags Tags, die auf die Vom Dienst erstellte Ressourcengruppe und/oder Ressourcen angewendet werden. ImageTemplatePropertiesManagedResourceTags
optimieren Gibt die Optimierung an, die für das Bild ausgeführt werden soll. ImageTemplatePropertiesOptimieren
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource (erforderlich)
stagingResourceGroup 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. Schnur
validieren Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen. ImageTemplatePropertiesValidate
vmProfil Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfil

ImageTemplatePropertiesErrorHandling

Name BESCHREIBUNG Wert
onCustomizerFehler Wenn ein Customizerfehler vorliegt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Customizerfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"
onValidationError Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"

ImageTemplatePropertiesManagedResourceTags

Name BESCHREIBUNG Wert

ImageTemplatePropertiesOptimieren

Name BESCHREIBUNG Wert
vmBoot Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Name BESCHREIBUNG Wert
Staat Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird. "Deaktiviert"
"Aktiviert"

ImageTemplatePropertiesValidate

Name BESCHREIBUNG Wert
continueDistributeOnFailure 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.] Boolesch
inVMValidationen Liste der überprüfungen, die ausgeführt werden sollen. ImageTemplateInVMValidator[]
sourceValidationOnly 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. Boolesch

ImageTemplateRestartCustomizer

Name BESCHREIBUNG Wert
restartCheckCommand (englisch) Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] Schnur
restartBefehl Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] Schnur
NeustartTimeout Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)

ImageTemplateSharedImageDistributor

Name BESCHREIBUNG Wert
excludeFromLatest Flag, das angibt, ob die erstellte Bildversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) weg. Boolesch
galleryImageId Ressourcen-ID des Azure Compute Gallery-Bilds Zeichenfolge (erforderlich)
replicationRegions (Bereiche) [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. Zeichenfolge[]
Speicherkontotyp [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. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"
targetRegions Die Zielbereiche, in denen die verteilte Imageversion repliziert werden soll. Dieses Objekt ersetzt replikationRegions und kann nur angegeben werden, wenn "replicationRegions" nicht angegeben ist. TargetRegion-[]
Typ Typ der Verteilung. "SharedImage" (erforderlich)
Versionsverwaltung Beschreibt, wie neue x.y.z-Versionsnummer für die Verteilung generiert wird. DistributeVersioner

ImageTemplateSharedImageVersionSource

Name BESCHREIBUNG Wert
imageVersionId ARM-Ressourcen-ID der Bildversion. Wenn der Name der Bildversion "latest" lautet, wird die Version ausgewertet, wenn der Imagebuild stattfindet. Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)

ImageTemplateShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Shell' (erforderlich)

ImageTemplateShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Shell' (erforderlich)

ImageTemplateSource

Name BESCHREIBUNG Wert
Typ Legen Sie den Wert auf 'ManagedImage' für den Typ ImageTemplateManagedImageSource fest. Legen Sie den Wert auf 'PlatformImage' für den Typ ImageTemplatePlatformImageSource fest. Legen Sie den Wert auf 'SharedImageVersion' für den Typ ImageTemplateSharedImageVersionSource fest. "ManagedImage"
"PlatformImage"
"SharedImageVersion" (erforderlich)

ImageTemplateVhdVerteiler

Name BESCHREIBUNG Wert
Typ Typ der Verteilung. "VHD" (erforderlich)
URI 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. Schnur

ImageTemplateVmProfil

Name BESCHREIBUNG Wert
osDiskSizeGB Größe des Betriebssystemdatenträgers in GB. Geben Sie "0" aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. Int

Zwänge:
Min.-Wert = 0
vom Benutzer zugewiesene Identitäten 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. Zeichenfolge[]
vmGröße 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). Schnur
vnetConfig 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. VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Name BESCHREIBUNG Wert
Filter 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. Zeichenfolge[]
SucheKriterien 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
updateLimit (englisch) Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Auslassen oder Angeben von 0 für die Verwendung des Standardwerts (1000) Int

Zwänge:
Min.-Wert = 0

PlattformImagePurchasePlan

Name BESCHREIBUNG Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProdukt Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

Zielregion

Name BESCHREIBUNG Wert
Name Der Name der Region. Zeichenfolge (erforderlich)
replicaCount (englisch) Die Anzahl der Replikate der Bildversion, die in dieser Region erstellt werden soll. Lassen Sie die Standardeinstellung (1) weg. Int

Zwänge:
Min.-Wert = 1
Speicherkontotyp Gibt den Speicherkontotyp an, der zum Speichern des Bilds in dieser Region verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

Verfolgte ResourceTags

Name BESCHREIBUNG Wert

UserAssignedIdentities

Name BESCHREIBUNG Wert

UserAssignedIdentity

Name BESCHREIBUNG Wert

VirtualNetworkConfig

Name BESCHREIBUNG Wert
containerInstanceSubnetId Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem Azure-Containerinstanz für isolierte Builds bereitgestellt wird. Dieses Feld kann nur angegeben werden, wenn subnetId es auch angegeben ist und sich im selben virtuellen Netzwerk wie das untere subnetIdSubnetz befinden muss. Schnur
proxyVmSize Die Größe des virtuellen Proxycomputers, der zum Übergeben des Datenverkehrs an den virtuellen Buildcomputer und die Überprüfungs-VM verwendet wird. Dies darf nicht angegeben werden, wenn containerInstanceSubnetId angegeben wird, da in diesem Fall kein virtueller Proxycomputer bereitgestellt wird. Lassen Oder geben Sie leere Zeichenfolge an, um die Standardeinstellung zu verwenden (Standard_A1_v2). Schnur
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem der virtuelle Buildcomputer und die Validierungs-VM bereitgestellt werden Schnur

Verwendungsbeispiele

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul BESCHREIBUNG
Imagevorlage für virtuelle Computer AVM-Ressourcenmodul für Imagevorlage für virtuelle Computer

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei BESCHREIBUNG
Azure Image Builder mit Azure Windows Baseline Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit den neuesten Angewendeten Windows-Updates und Azure Windows Baseline.
Konfigurieren des Dev Box-Diensts Diese Vorlage würde alle Dev Box-Administratorressourcen gemäß dev Box-Schnellstarthandbuch (/azure/dev-box/quickstart-create-dev-box) erstellen. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihr erstes Dev Box zu erstellen.

ARM-Vorlagenressourcendefinition

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2024-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "autoRun": {
      "state": "string"
    },
    "buildTimeoutInMinutes": "int",
    "customize": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateCustomizer objects
    } ],
    "distribute": [ {
      "artifactTags": {
        "{customized property}": "string"
      },
      "runOutputName": "string",
      "type": "string"
      // For remaining properties, see ImageTemplateDistributor objects
    } ],
    "errorHandling": {
      "onCustomizerError": "string",
      "onValidationError": "string"
    },
    "managedResourceTags": {
      "{customized property}": "string"
    },
    "optimize": {
      "vmBoot": {
        "state": "string"
      }
    },
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    },
    "stagingResourceGroup": "string",
    "validate": {
      "continueDistributeOnFailure": "bool",
      "inVMValidations": [ {
        "name": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateInVMValidator objects
      } ],
      "sourceValidationOnly": "bool"
    },
    "vmProfile": {
      "osDiskSizeGB": "int",
      "userAssignedIdentities": [ "string" ],
      "vmSize": "string",
      "vnetConfig": {
        "containerInstanceSubnetId": "string",
        "proxyVmSize": "string",
        "subnetId": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

DistributeVersioner-Objekte

Legen Sie die Schemaeigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Neueste" Folgendes:

{
  "major": "int",
  "scheme": "Latest"
}

Verwenden Sie für Source:

{
  "scheme": "Source"
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string",
  "type": "File"
}

Verwenden Sie für PowerShell Folgendes:

{
  "inline": [ "string" ],
  "runAsSystem": "bool",
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "type": "PowerShell",
  "validExitCodes": [ "int" ]
}

Verwenden Sie für Shell Folgendes:

{
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string",
  "type": "Shell"
}

Verwenden Sie für WindowsRestart Folgendes:

{
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string",
  "type": "WindowsRestart"
}

Verwenden Sie für WindowsUpdate Folgendes:

{
  "filters": [ "string" ],
  "searchCriteria": "string",
  "type": "WindowsUpdate",
  "updateLimit": "int"
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  "imageId": "string",
  "type": "ManagedImage"
}

Verwenden Sie für PlatformImage Folgendes:

{
  "offer": "string",
  "planInfo": {
    "planName": "string",
    "planProduct": "string",
    "planPublisher": "string"
  },
  "publisher": "string",
  "sku": "string",
  "type": "PlatformImage",
  "version": "string"
}

Verwenden Sie für SharedImageVersion Folgendes:

{
  "imageVersionId": "string",
  "type": "SharedImageVersion"
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  "imageId": "string",
  "location": "string",
  "type": "ManagedImage"
}

Verwenden Sie für SharedImage Folgendes:

{
  "excludeFromLatest": "bool",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "storageAccountType": "string",
  "targetRegions": [
    {
      "name": "string",
      "replicaCount": "int",
      "storageAccountType": "string"
    }
  ],
  "type": "SharedImage",
  "versioning": {
    "scheme": "string"
    // For remaining properties, see DistributeVersioner objects
  }
}

Verwenden Sie für VHD Folgendes:

{
  "type": "VHD",
  "uri": "string"
}

ImageTemplateInVMValidator-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  "destination": "string",
  "sha256Checksum": "string",
  "sourceUri": "string",
  "type": "File"
}

Verwenden Sie für PowerShell Folgendes:

{
  "inline": [ "string" ],
  "runAsSystem": "bool",
  "runElevated": "bool",
  "scriptUri": "string",
  "sha256Checksum": "string",
  "type": "PowerShell",
  "validExitCodes": [ "int" ]
}

Verwenden Sie für Shell Folgendes:

{
  "inline": [ "string" ],
  "scriptUri": "string",
  "sha256Checksum": "string",
  "type": "Shell"
}

Eigenschaftswerte

Microsoft.VirtualMachineImages/imageTemplates

Name BESCHREIBUNG Wert
apiVersion (Englisch) Die API-Version '2024-02-01'
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity (erforderlich)
Standort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplate-Eigenschaften
Schlagwörter Ressourcenetiketten Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Typ Der Ressourcentyp 'Microsoft.VirtualMachineImages/imageTemplates'

DistributeVersioner

Name BESCHREIBUNG Wert
Schema Legen Sie den Wert auf 'Latest' für den Typ DistributeVersionerLatest fest. Legen Sie für den Typ "DistributeVersionerSource" den Typ "Source" fest. "Neuestes"
"Quelle" (erforderlich)

DistributeVersionerNeueste

Name BESCHREIBUNG Wert
Haupt 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. Int

Zwänge:
Min-Wert = -1
Schema Versionsnummerierungsschema, das verwendet werden soll. "Neueste" (erforderlich)

DistributeVersionerSource

Name BESCHREIBUNG Wert
Schema Versionsnummerierungsschema, das verwendet werden soll. "Quelle" (erforderlich)

ImageTemplateAutoRun

Name BESCHREIBUNG Wert
Staat Wenn Sie dieses Feld aktivieren, wird ein automatischer Build für die Erstellung oder Aktualisierung von Bildvorlagen ausgelöst. "Deaktiviert"
"Aktiviert"

ImageTemplateCustomizer

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileCustomizer' festgelegt. Legen Sie für den Typ ImageTemplatePowerShellCustomizer auf 'PowerShell' fest. Legen Sie für den Typ ImageTemplateShellCustomizer auf 'Shell' fest. Legen Sie den Wert auf 'WindowsRestart' für den Typ ImageTemplateRestartCustomizer fest. Legen Sie diesen Wert auf 'WindowsUpdate' für den Typ ImageTemplateWindowsUpdateCustomizer fest. 'Datei'
"PowerShell"
"Schale"
"WindowsRestart"
"WindowsUpdate" (erforderlich)

ImageTemplateVerteiler

Name BESCHREIBUNG Wert
artefaktTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Typ Legen Sie den Wert auf "ManagedImage" für den Typ ImageTemplateManagedImageDistributor fest. Legen Sie den Wert auf 'SharedImage' für den Typ ImageTemplateSharedImageDistributor fest. Für den Typ ImageTemplateVhdDistributor auf 'VHD' festgelegt. "ManagedImage"
"SharedImage"
"VHD" (erforderlich)

ImageTemplateDistributorArtifactTags

Name BESCHREIBUNG Wert

ImageTemplateFileCustomizer

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Datei' (erforderlich)

ImageTemplateFileValidator

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Datei' (erforderlich)

ImageTemplateIdentity

Name BESCHREIBUNG Wert
Typ Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. "Keine"
"UserAssigned"
vom Benutzer zugewiesene 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. UserAssignedIdentities-

ImageTemplateInVMValidator

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileValidator' festgelegt. Auf 'PowerShell' für den Typ ImageTemplatePowerShellValidator festgelegt. Legen Sie für den Typ ImageTemplateShellValidator auf 'Shell' fest. 'Datei'
"PowerShell"
'Shell' (erforderlich)

ImageTemplateManagedImageDistributor

Name BESCHREIBUNG Wert
imageId (englisch) Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Standort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Typ Typ der Verteilung. "ManagedImage" (erforderlich)

ImageTemplateManagedImageSource

Name BESCHREIBUNG Wert
imageId (englisch) ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ManagedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name BESCHREIBUNG Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
planInfo Optionale Konfiguration des Einkaufsplans für das Plattformimage. PlattformImagePurchasePlan
Verleger Bildherausgeber in Azure Gallery Images. Schnur
Sku Bildsku aus den Azure Gallery Images. Schnur
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Ausgabe Bildversion aus den Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. Schnur

ImageTemplatePowerShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplatePowerShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplate-Eigenschaften

Name BESCHREIBUNG Wert
AutoRun Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. ImageTemplateAutoRun
buildTimeoutInMinuten 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). Int

Zwänge:
Min.-Wert = 0
Maximalwert = 960
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
errorBehandlung Fehlerbehandlungsoptionen bei Einem Buildfehler ImageTemplatePropertiesErrorHandling
managedResourceTags Tags, die auf die Vom Dienst erstellte Ressourcengruppe und/oder Ressourcen angewendet werden. ImageTemplatePropertiesManagedResourceTags
optimieren Gibt die Optimierung an, die für das Bild ausgeführt werden soll. ImageTemplatePropertiesOptimieren
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource (erforderlich)
stagingResourceGroup 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. Schnur
validieren Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen. ImageTemplatePropertiesValidate
vmProfil Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfil

ImageTemplatePropertiesErrorHandling

Name BESCHREIBUNG Wert
onCustomizerFehler Wenn ein Customizerfehler vorliegt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Customizerfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"
onValidationError Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"

ImageTemplatePropertiesManagedResourceTags

Name BESCHREIBUNG Wert

ImageTemplatePropertiesOptimieren

Name BESCHREIBUNG Wert
vmBoot Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Name BESCHREIBUNG Wert
Staat Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird. "Deaktiviert"
"Aktiviert"

ImageTemplatePropertiesValidate

Name BESCHREIBUNG Wert
continueDistributeOnFailure 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.] Boolesch
inVMValidationen Liste der überprüfungen, die ausgeführt werden sollen. ImageTemplateInVMValidator[]
sourceValidationOnly 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. Boolesch

ImageTemplateRestartCustomizer

Name BESCHREIBUNG Wert
restartCheckCommand (englisch) Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] Schnur
restartBefehl Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] Schnur
NeustartTimeout Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)

ImageTemplateSharedImageDistributor

Name BESCHREIBUNG Wert
excludeFromLatest Flag, das angibt, ob die erstellte Bildversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) weg. Boolesch
galleryImageId Ressourcen-ID des Azure Compute Gallery-Bilds Zeichenfolge (erforderlich)
replicationRegions (Bereiche) [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. Zeichenfolge[]
Speicherkontotyp [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. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"
targetRegions Die Zielbereiche, in denen die verteilte Imageversion repliziert werden soll. Dieses Objekt ersetzt replikationRegions und kann nur angegeben werden, wenn "replicationRegions" nicht angegeben ist. TargetRegion-[]
Typ Typ der Verteilung. "SharedImage" (erforderlich)
Versionsverwaltung Beschreibt, wie neue x.y.z-Versionsnummer für die Verteilung generiert wird. DistributeVersioner

ImageTemplateSharedImageVersionSource

Name BESCHREIBUNG Wert
imageVersionId ARM-Ressourcen-ID der Bildversion. Wenn der Name der Bildversion "latest" lautet, wird die Version ausgewertet, wenn der Imagebuild stattfindet. Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)

ImageTemplateShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Shell' (erforderlich)

ImageTemplateShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Shell' (erforderlich)

ImageTemplateSource

Name BESCHREIBUNG Wert
Typ Legen Sie den Wert auf 'ManagedImage' für den Typ ImageTemplateManagedImageSource fest. Legen Sie den Wert auf 'PlatformImage' für den Typ ImageTemplatePlatformImageSource fest. Legen Sie den Wert auf 'SharedImageVersion' für den Typ ImageTemplateSharedImageVersionSource fest. "ManagedImage"
"PlatformImage"
"SharedImageVersion" (erforderlich)

ImageTemplateVhdVerteiler

Name BESCHREIBUNG Wert
Typ Typ der Verteilung. "VHD" (erforderlich)
URI 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. Schnur

ImageTemplateVmProfil

Name BESCHREIBUNG Wert
osDiskSizeGB Größe des Betriebssystemdatenträgers in GB. Geben Sie "0" aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. Int

Zwänge:
Min.-Wert = 0
vom Benutzer zugewiesene Identitäten 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. Zeichenfolge[]
vmGröße 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). Schnur
vnetConfig 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. VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Name BESCHREIBUNG Wert
Filter 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. Zeichenfolge[]
SucheKriterien 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
updateLimit (englisch) Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Auslassen oder Angeben von 0 für die Verwendung des Standardwerts (1000) Int

Zwänge:
Min.-Wert = 0

PlattformImagePurchasePlan

Name BESCHREIBUNG Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProdukt Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

Zielregion

Name BESCHREIBUNG Wert
Name Der Name der Region. Zeichenfolge (erforderlich)
replicaCount (englisch) Die Anzahl der Replikate der Bildversion, die in dieser Region erstellt werden soll. Lassen Sie die Standardeinstellung (1) weg. Int

Zwänge:
Min.-Wert = 1
Speicherkontotyp Gibt den Speicherkontotyp an, der zum Speichern des Bilds in dieser Region verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

Verfolgte ResourceTags

Name BESCHREIBUNG Wert

UserAssignedIdentities

Name BESCHREIBUNG Wert

UserAssignedIdentity

Name BESCHREIBUNG Wert

VirtualNetworkConfig

Name BESCHREIBUNG Wert
containerInstanceSubnetId Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem Azure-Containerinstanz für isolierte Builds bereitgestellt wird. Dieses Feld kann nur angegeben werden, wenn subnetId es auch angegeben ist und sich im selben virtuellen Netzwerk wie das untere subnetIdSubnetz befinden muss. Schnur
proxyVmSize Die Größe des virtuellen Proxycomputers, der zum Übergeben des Datenverkehrs an den virtuellen Buildcomputer und die Überprüfungs-VM verwendet wird. Dies darf nicht angegeben werden, wenn containerInstanceSubnetId angegeben wird, da in diesem Fall kein virtueller Proxycomputer bereitgestellt wird. Lassen Oder geben Sie leere Zeichenfolge an, um die Standardeinstellung zu verwenden (Standard_A1_v2). Schnur
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem der virtuelle Buildcomputer und die Validierungs-VM bereitgestellt werden Schnur

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone BESCHREIBUNG
Azure Image Builder mit Azure Windows Baseline

Bereitstellung in Azure
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit den neuesten Angewendeten Windows-Updates und Azure Windows Baseline.
Konfigurieren des Dev Box-Diensts

Bereitstellung in Azure
Diese Vorlage würde alle Dev Box-Administratorressourcen gemäß dev Box-Schnellstarthandbuch (/azure/dev-box/quickstart-create-dev-box) erstellen. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihr erstes Dev Box zu erstellen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      autoRun = {
        state = "string"
      }
      buildTimeoutInMinutes = int
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {
            {customized property} = "string"
          }
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      errorHandling = {
        onCustomizerError = "string"
        onValidationError = "string"
      }
      managedResourceTags = {
        {customized property} = "string"
      }
      optimize = {
        vmBoot = {
          state = "string"
        }
      }
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
      stagingResourceGroup = "string"
      validate = {
        continueDistributeOnFailure = bool
        inVMValidations = [
          {
            name = "string"
            type = "string"
            // For remaining properties, see ImageTemplateInVMValidator objects
          }
        ]
        sourceValidationOnly = bool
      }
      vmProfile = {
        osDiskSizeGB = int
        userAssignedIdentities = [
          "string"
        ]
        vmSize = "string"
        vnetConfig = {
          containerInstanceSubnetId = "string"
          proxyVmSize = "string"
          subnetId = "string"
        }
      }
    }
  }
}

DistributeVersioner-Objekte

Legen Sie die Schemaeigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Neueste" Folgendes:

{
  major = int
  scheme = "Latest"
}

Verwenden Sie für Source:

{
  scheme = "Source"
}

ImageTemplateCustomizer-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"
  type = "File"
}

Verwenden Sie für PowerShell Folgendes:

{
  inline = [
    "string"
  ]
  runAsSystem = bool
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  type = "PowerShell"
  validExitCodes = [
    int
  ]
}

Verwenden Sie für Shell Folgendes:

{
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"
  type = "Shell"
}

Verwenden Sie für WindowsRestart Folgendes:

{
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"
  type = "WindowsRestart"
}

Verwenden Sie für WindowsUpdate Folgendes:

{
  filters = [
    "string"
  ]
  searchCriteria = "string"
  type = "WindowsUpdate"
  updateLimit = int
}

ImageTemplateSource-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  imageId = "string"
  type = "ManagedImage"
}

Verwenden Sie für PlatformImage Folgendes:

{
  offer = "string"
  planInfo = {
    planName = "string"
    planProduct = "string"
    planPublisher = "string"
  }
  publisher = "string"
  sku = "string"
  type = "PlatformImage"
  version = "string"
}

Verwenden Sie für SharedImageVersion Folgendes:

{
  imageVersionId = "string"
  type = "SharedImageVersion"
}

ImageTemplateDistributor-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage Folgendes:

{
  imageId = "string"
  location = "string"
  type = "ManagedImage"
}

Verwenden Sie für SharedImage Folgendes:

{
  excludeFromLatest = bool
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  storageAccountType = "string"
  targetRegions = [
    {
      name = "string"
      replicaCount = int
      storageAccountType = "string"
    }
  ]
  type = "SharedImage"
  versioning = {
    scheme = "string"
    // For remaining properties, see DistributeVersioner objects
  }
}

Verwenden Sie für VHD Folgendes:

{
  type = "VHD"
  uri = "string"
}

ImageTemplateInVMValidator-Objekte

Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für "Datei" Folgendes:

{
  destination = "string"
  sha256Checksum = "string"
  sourceUri = "string"
  type = "File"
}

Verwenden Sie für PowerShell Folgendes:

{
  inline = [
    "string"
  ]
  runAsSystem = bool
  runElevated = bool
  scriptUri = "string"
  sha256Checksum = "string"
  type = "PowerShell"
  validExitCodes = [
    int
  ]
}

Verwenden Sie für Shell Folgendes:

{
  inline = [
    "string"
  ]
  scriptUri = "string"
  sha256Checksum = "string"
  type = "Shell"
}

Eigenschaftswerte

Microsoft.VirtualMachineImages/imageTemplates

Name BESCHREIBUNG Wert
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity (erforderlich)
Standort Der geografische Standort, an dem sich die Ressource befindet Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplate-Eigenschaften
Schlagwörter Ressourcenetiketten Wörterbuch der Tagnamen und -werte.
Typ Der Ressourcentyp "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"

DistributeVersioner

Name BESCHREIBUNG Wert
Schema Legen Sie den Wert auf 'Latest' für den Typ DistributeVersionerLatest fest. Legen Sie für den Typ "DistributeVersionerSource" den Typ "Source" fest. "Neuestes"
"Quelle" (erforderlich)

DistributeVersionerNeueste

Name BESCHREIBUNG Wert
Haupt 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. Int

Zwänge:
Min-Wert = -1
Schema Versionsnummerierungsschema, das verwendet werden soll. "Neueste" (erforderlich)

DistributeVersionerSource

Name BESCHREIBUNG Wert
Schema Versionsnummerierungsschema, das verwendet werden soll. "Quelle" (erforderlich)

ImageTemplateAutoRun

Name BESCHREIBUNG Wert
Staat Wenn Sie dieses Feld aktivieren, wird ein automatischer Build für die Erstellung oder Aktualisierung von Bildvorlagen ausgelöst. "Deaktiviert"
"Aktiviert"

ImageTemplateCustomizer

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileCustomizer' festgelegt. Legen Sie für den Typ ImageTemplatePowerShellCustomizer auf 'PowerShell' fest. Legen Sie für den Typ ImageTemplateShellCustomizer auf 'Shell' fest. Legen Sie den Wert auf 'WindowsRestart' für den Typ ImageTemplateRestartCustomizer fest. Legen Sie diesen Wert auf 'WindowsUpdate' für den Typ ImageTemplateWindowsUpdateCustomizer fest. 'Datei'
"PowerShell"
"Schale"
"WindowsRestart"
"WindowsUpdate" (erforderlich)

ImageTemplateVerteiler

Name BESCHREIBUNG Wert
artefaktTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. ImageTemplateDistributorArtifactTags
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich)
Typ Legen Sie den Wert auf "ManagedImage" für den Typ ImageTemplateManagedImageDistributor fest. Legen Sie den Wert auf 'SharedImage' für den Typ ImageTemplateSharedImageDistributor fest. Für den Typ ImageTemplateVhdDistributor auf 'VHD' festgelegt. "ManagedImage"
"SharedImage"
"VHD" (erforderlich)

ImageTemplateDistributorArtifactTags

Name BESCHREIBUNG Wert

ImageTemplateFileCustomizer

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Datei' (erforderlich)

ImageTemplateFileValidator

Name BESCHREIBUNG Wert
Reiseziel Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird Schnur
sha256Prüfsumme SHA256-Prüfsumme der Datei, die oben im Quelluri-Feld bereitgestellt wird Schnur
sourceUri 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. Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Datei' (erforderlich)

ImageTemplateIdentity

Name BESCHREIBUNG Wert
Typ Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. "Keine"
"UserAssigned"
vom Benutzer zugewiesene 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. UserAssignedIdentities-

ImageTemplateInVMValidator

Name BESCHREIBUNG Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Überprüfungsschritt ausgeführt wird Schnur
Typ 'File' für den Typ 'ImageTemplateFileValidator' festgelegt. Auf 'PowerShell' für den Typ ImageTemplatePowerShellValidator festgelegt. Legen Sie für den Typ ImageTemplateShellValidator auf 'Shell' fest. 'Datei'
"PowerShell"
'Shell' (erforderlich)

ImageTemplateManagedImageDistributor

Name BESCHREIBUNG Wert
imageId (englisch) Ressourcen-ID des Image des verwalteten Datenträgers Zeichenfolge (erforderlich)
Standort Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist Zeichenfolge (erforderlich)
Typ Typ der Verteilung. "ManagedImage" (erforderlich)

ImageTemplateManagedImageSource

Name BESCHREIBUNG Wert
imageId (englisch) ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "ManagedImage" (erforderlich)

ImageTemplatePlatformImageSource

Name BESCHREIBUNG Wert
Angebot Bildangebot aus dem Azure Gallery Images. Schnur
planInfo Optionale Konfiguration des Einkaufsplans für das Plattformimage. PlattformImagePurchasePlan
Verleger Bildherausgeber in Azure Gallery Images. Schnur
Sku Bildsku aus den Azure Gallery Images. Schnur
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
Ausgabe Bildversion aus den Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. Schnur

ImageTemplatePowerShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplatePowerShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array von auszuführenden PowerShell-Befehlen Zeichenfolge[]
runAsSystem 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. Boolesch
runErhöht Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. Boolesch
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. "PowerShell" (erforderlich)
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplate-Eigenschaften

Name BESCHREIBUNG Wert
AutoRun Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. ImageTemplateAutoRun
buildTimeoutInMinuten 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). Int

Zwänge:
Min.-Wert = 0
Maximalwert = 960
Anpassen Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. ImageTemplateCustomizer[]
verteilen Die Verteilungsziele, zu denen die Bildausgabe wechseln muss. ImageTemplateDistributor[] (erforderlich)
errorBehandlung Fehlerbehandlungsoptionen bei Einem Buildfehler ImageTemplatePropertiesErrorHandling
managedResourceTags Tags, die auf die Vom Dienst erstellte Ressourcengruppe und/oder Ressourcen angewendet werden. ImageTemplatePropertiesManagedResourceTags
optimieren Gibt die Optimierung an, die für das Bild ausgeführt werden soll. ImageTemplatePropertiesOptimieren
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource (erforderlich)
stagingResourceGroup 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. Schnur
validieren Konfigurationsoptionen und Liste der Überprüfungen, die für das resultierende Image ausgeführt werden sollen. ImageTemplatePropertiesValidate
vmProfil Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfil

ImageTemplatePropertiesErrorHandling

Name BESCHREIBUNG Wert
onCustomizerFehler Wenn ein Customizerfehler vorliegt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Customizerfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"
onValidationError Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "Bereinigen" festgelegt ist, werden die Build-VM und die zugehörigen Netzwerkressourcen bereinigt. Dies ist das Standardverhalten. Wenn ein Überprüfungsfehler auftritt und dieses Feld auf "abgebrochen" festgelegt ist, wird die Build-VM beibehalten. "abgebrochen"
"Bereinigung"

ImageTemplatePropertiesManagedResourceTags

Name BESCHREIBUNG Wert

ImageTemplatePropertiesOptimieren

Name BESCHREIBUNG Wert
vmBoot Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Name BESCHREIBUNG Wert
Staat Durch aktivieren dieses Feld wird die Startzeit des virtuellen Computers verbessert, indem die endgültige angepasste Imageausgabe optimiert wird. "Deaktiviert"
"Aktiviert"

ImageTemplatePropertiesValidate

Name BESCHREIBUNG Wert
continueDistributeOnFailure 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.] Boolesch
inVMValidationen Liste der überprüfungen, die ausgeführt werden sollen. ImageTemplateInVMValidator[]
sourceValidationOnly 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. Boolesch

ImageTemplateRestartCustomizer

Name BESCHREIBUNG Wert
restartCheckCommand (englisch) Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] Schnur
restartBefehl Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] Schnur
NeustartTimeout Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)

ImageTemplateSharedImageDistributor

Name BESCHREIBUNG Wert
excludeFromLatest Flag, das angibt, ob die erstellte Bildversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) weg. Boolesch
galleryImageId Ressourcen-ID des Azure Compute Gallery-Bilds Zeichenfolge (erforderlich)
replicationRegions (Bereiche) [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. Zeichenfolge[]
Speicherkontotyp [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. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"
targetRegions Die Zielbereiche, in denen die verteilte Imageversion repliziert werden soll. Dieses Objekt ersetzt replikationRegions und kann nur angegeben werden, wenn "replicationRegions" nicht angegeben ist. TargetRegion-[]
Typ Typ der Verteilung. "SharedImage" (erforderlich)
Versionsverwaltung Beschreibt, wie neue x.y.z-Versionsnummer für die Verteilung generiert wird. DistributeVersioner

ImageTemplateSharedImageVersionSource

Name BESCHREIBUNG Wert
imageVersionId ARM-Ressourcen-ID der Bildversion. Wenn der Name der Bildversion "latest" lautet, wird die Version ausgewertet, wenn der Imagebuild stattfindet. Zeichenfolge (erforderlich)
Typ Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)

ImageTemplateShellCustomizer

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Shell' (erforderlich)

ImageTemplateShellValidator

Name BESCHREIBUNG Wert
schritthaltend Array der auszuführenden Shellbefehle Zeichenfolge[]
scriptUri 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. Schnur
sha256Prüfsumme SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird Schnur
Typ Der Typ der Überprüfung, die Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" die Shellüberprüfung sein. 'Shell' (erforderlich)

ImageTemplateSource

Name BESCHREIBUNG Wert
Typ Legen Sie den Wert auf 'ManagedImage' für den Typ ImageTemplateManagedImageSource fest. Legen Sie den Wert auf 'PlatformImage' für den Typ ImageTemplatePlatformImageSource fest. Legen Sie den Wert auf 'SharedImageVersion' für den Typ ImageTemplateSharedImageVersionSource fest. "ManagedImage"
"PlatformImage"
"SharedImageVersion" (erforderlich)

ImageTemplateVhdVerteiler

Name BESCHREIBUNG Wert
Typ Typ der Verteilung. "VHD" (erforderlich)
URI 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. Schnur

ImageTemplateVmProfil

Name BESCHREIBUNG Wert
osDiskSizeGB Größe des Betriebssystemdatenträgers in GB. Geben Sie "0" aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. Int

Zwänge:
Min.-Wert = 0
vom Benutzer zugewiesene Identitäten 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. Zeichenfolge[]
vmGröße 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). Schnur
vnetConfig 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. VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Name BESCHREIBUNG Wert
Filter 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. Zeichenfolge[]
SucheKriterien 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. Schnur
Typ Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
updateLimit (englisch) Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Auslassen oder Angeben von 0 für die Verwendung des Standardwerts (1000) Int

Zwänge:
Min.-Wert = 0

PlattformImagePurchasePlan

Name BESCHREIBUNG Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProdukt Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

Zielregion

Name BESCHREIBUNG Wert
Name Der Name der Region. Zeichenfolge (erforderlich)
replicaCount (englisch) Die Anzahl der Replikate der Bildversion, die in dieser Region erstellt werden soll. Lassen Sie die Standardeinstellung (1) weg. Int

Zwänge:
Min.-Wert = 1
Speicherkontotyp Gibt den Speicherkontotyp an, der zum Speichern des Bilds in dieser Region verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"

Verfolgte ResourceTags

Name BESCHREIBUNG Wert

UserAssignedIdentities

Name BESCHREIBUNG Wert

UserAssignedIdentity

Name BESCHREIBUNG Wert

VirtualNetworkConfig

Name BESCHREIBUNG Wert
containerInstanceSubnetId Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem Azure-Containerinstanz für isolierte Builds bereitgestellt wird. Dieses Feld kann nur angegeben werden, wenn subnetId es auch angegeben ist und sich im selben virtuellen Netzwerk wie das untere subnetIdSubnetz befinden muss. Schnur
proxyVmSize Die Größe des virtuellen Proxycomputers, der zum Übergeben des Datenverkehrs an den virtuellen Buildcomputer und die Überprüfungs-VM verwendet wird. Dies darf nicht angegeben werden, wenn containerInstanceSubnetId angegeben wird, da in diesem Fall kein virtueller Proxycomputer bereitgestellt wird. Lassen Oder geben Sie leere Zeichenfolge an, um die Standardeinstellung zu verwenden (Standard_A1_v2). Schnur
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes, auf dem der virtuelle Buildcomputer und die Validierungs-VM bereitgestellt werden Schnur