Microsoft.VirtualMachineImages imageTemplates
Bicep-Ressourcendefinition
Der imageTemplates-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
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 das Schema Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für neuesten:
{
major: int
scheme: 'Latest'
}
Verwenden Sie für Source:
{
scheme: 'Source'
}
ImageTemplateInVMValidator-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
type: 'File'
}
Verwenden Sie für PowerShell-:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
Verwenden Sie für Shell-:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
ImageTemplateDistributor-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für ManagedImage-:
{
imageId: 'string'
location: 'string'
type: 'ManagedImage'
}
Verwenden Sie für SharedImage-:
{
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-:
{
type: 'VHD'
uri: 'string'
}
ImageTemplateCustomizer-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
type: 'File'
}
Verwenden Sie für PowerShell-:
{
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
type: 'PowerShell'
validExitCodes: [
int
]
}
Verwenden Sie für Shell-:
{
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
type: 'Shell'
}
Verwenden Sie für WindowsRestart-:
{
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-:
{
imageId: 'string'
type: 'ManagedImage'
}
Verwenden Sie für PlatformImage-:
{
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'
}
Eigenschaftswerte
DistributeVersioner
Name | Beschreibung | Wert |
---|---|---|
Schema | Legen Sie für typ DistributeVersionerLatestauf "Latest" fest. Set to 'Source' for type DistributeVersionerSource. | "Neuestes" "Quelle" (erforderlich) |
DistributeVersionerLatest
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 |
---|---|---|
Zustand | 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 |
Art | Legen Sie für den Typ ImageTemplateFileCustomizerauf "Datei" fest. Legen Sie für den Typ ImageTemplatePowerShellCustomizerauf "PowerShell" fest. Legen Sie für den Typ ImageTemplateShellCustomizerauf "Shell" fest. Set to 'WindowsRestart' for type ImageTemplateRestartCustomizer. Set to 'WindowsUpdate' for type ImageTemplateWindowsUpdateCustomizer. | 'Datei' "PowerShell" 'Shell' "WindowsRestart" "WindowsUpdate" (erforderlich) |
ImageTemplateDistributor
Name | Beschreibung | Wert |
---|---|---|
artifactTags | 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. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageDistributor. Set to 'SharedImage' for type ImageTemplateSharedImageDistributor. Legen Sie für den Typ ImageTemplateVhdDistributorauf "VHD" fest. | "ManagedImage" "SharedImage" "VHD" (erforderlich) |
ImageTemplateDistributorArtifactTags
Name | Beschreibung | Wert |
---|
ImageTemplateFileCustomizer
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Art | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | 'None' "UserAssigned" |
userAssignedIdentities | 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 |
Art | Legen Sie für den Typ "File" ImageTemplateFileValidatorfest. Set to 'PowerShell' for type ImageTemplatePowerShellValidator. Legen Sie für den Typ ImageTemplateShellValidatorauf "Shell" fest. | 'Datei' "PowerShell" 'Shell' (erforderlich) |
ImageTemplateManagedImageDistributor
Name | Beschreibung | Wert |
---|---|---|
imageId | Ressourcen-ID des Image des verwalteten Datenträgers | Zeichenfolge (erforderlich) |
Ort | Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist | Zeichenfolge (erforderlich) |
Art | Typ der Verteilung. | "ManagedImage" (erforderlich) |
ImageTemplateManagedImageSource
Name | Beschreibung | Wert |
---|---|---|
imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
Art | 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. | PlatformImagePurchasePlan- |
Verlag | Image Publisher in Azure Gallery Images. | Schnur |
Sku | Bildsku aus der Azure Gallery Images. | Schnur |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
Version | Bildversion aus der Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. | Schnur |
ImageTemplatePowerShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array von auszuführenden PowerShell-Befehlen | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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 | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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[] |
ImageTemplateProperties
Name | Beschreibung | Wert |
---|---|---|
AutoRun | Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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) |
errorHandling | 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. | ImageTemplatePropertiesOptimize- |
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 |
vmProfile | Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Name | Beschreibung | Wert |
---|---|---|
onCustomizerError | 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 |
---|
ImageTemplatePropertiesOptimize
Name | Beschreibung | Wert |
---|---|---|
vmBoot | Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Name | Beschreibung | Wert |
---|---|---|
Zustand | 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.] | Bool |
inVMValidations | 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. | Bool |
ImageTemplateRestartCustomizer
Name | Beschreibung | Wert |
---|---|---|
restartCheckCommand | Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Schnur |
restartCommand | Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] | Schnur |
restartTimeout | Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] | Schnur |
Art | 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. | Bool |
galleryImageId | Ressourcen-ID des Azure Compute Gallery-Bilds | Zeichenfolge (erforderlich) |
replicationRegions | [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. | string[] |
storageAccountType | [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-[] |
Art | 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) |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
ImageTemplateShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array der auszuführenden Shellbefehle | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 |
---|---|---|
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageSource. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. Set to 'SharedImageVersion' for type ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (erforderlich) |
ImageTemplateVhdDistributor
Name | Beschreibung | Wert |
---|---|---|
Art | 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 |
ImageTemplateVmProfile
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 |
userAssignedIdentities | 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. | string[] |
vmSize | 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. | string[] |
searchCriteria | 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 |
Art | Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein | "WindowsUpdate" (erforderlich) |
updateLimit | 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 |
Microsoft.VirtualMachineImages/imageTemplates
Name | Beschreibung | Wert |
---|---|---|
Identität | Die Identität der Bildvorlage, falls konfiguriert. | ImageTemplateIdentity- (erforderlich) |
Ort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Eigenschaften | Die Eigenschaften der Bildvorlage | ImageTemplateProperties- |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
PlatformImagePurchasePlan
Name | Beschreibung | Wert |
---|---|---|
planName | Name des Einkaufsplans. | Zeichenfolge (erforderlich) |
planProduct | Produkt des Einkaufsplans. | Zeichenfolge (erforderlich) |
planPublisher | Herausgeber des Einkaufsplans. | Zeichenfolge (erforderlich) |
TargetRegion
Name | Beschreibung | Wert |
---|---|---|
Name | Der Name der Region. | Zeichenfolge (erforderlich) |
replicaCount | 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 |
storageAccountType | 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" |
TrackedResourceTags
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 ebenfalls angegeben ist und sich im gleichen virtuellen Netzwerk wie das subnetz befinden muss, das in subnetId angegeben ist. |
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 |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
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:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
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 das Schema Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für neuesten:
{
"major": "int",
"scheme": "Latest"
}
Verwenden Sie für Source:
{
"scheme": "Source"
}
ImageTemplateInVMValidator-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string",
"type": "File"
}
Verwenden Sie für PowerShell-:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
Verwenden Sie für Shell-:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
ImageTemplateDistributor-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für ManagedImage-:
{
"imageId": "string",
"location": "string",
"type": "ManagedImage"
}
Verwenden Sie für SharedImage-:
{
"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-:
{
"type": "VHD",
"uri": "string"
}
ImageTemplateCustomizer-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string",
"type": "File"
}
Verwenden Sie für PowerShell-:
{
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"type": "PowerShell",
"validExitCodes": [ "int" ]
}
Verwenden Sie für Shell-:
{
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string",
"type": "Shell"
}
Verwenden Sie für WindowsRestart-:
{
"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-:
{
"imageId": "string",
"type": "ManagedImage"
}
Verwenden Sie für PlatformImage-:
{
"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"
}
Eigenschaftswerte
DistributeVersioner
Name | Beschreibung | Wert |
---|---|---|
Schema | Legen Sie für typ DistributeVersionerLatestauf "Latest" fest. Set to 'Source' for type DistributeVersionerSource. | "Neuestes" "Quelle" (erforderlich) |
DistributeVersionerLatest
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 |
---|---|---|
Zustand | 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 |
Art | Legen Sie für den Typ ImageTemplateFileCustomizerauf "Datei" fest. Legen Sie für den Typ ImageTemplatePowerShellCustomizerauf "PowerShell" fest. Legen Sie für den Typ ImageTemplateShellCustomizerauf "Shell" fest. Set to 'WindowsRestart' for type ImageTemplateRestartCustomizer. Set to 'WindowsUpdate' for type ImageTemplateWindowsUpdateCustomizer. | 'Datei' "PowerShell" 'Shell' "WindowsRestart" "WindowsUpdate" (erforderlich) |
ImageTemplateDistributor
Name | Beschreibung | Wert |
---|---|---|
artifactTags | 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. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageDistributor. Set to 'SharedImage' for type ImageTemplateSharedImageDistributor. Legen Sie für den Typ ImageTemplateVhdDistributorauf "VHD" fest. | "ManagedImage" "SharedImage" "VHD" (erforderlich) |
ImageTemplateDistributorArtifactTags
Name | Beschreibung | Wert |
---|
ImageTemplateFileCustomizer
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Art | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | 'None' "UserAssigned" |
userAssignedIdentities | 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 |
Art | Legen Sie für den Typ "File" ImageTemplateFileValidatorfest. Set to 'PowerShell' for type ImageTemplatePowerShellValidator. Legen Sie für den Typ ImageTemplateShellValidatorauf "Shell" fest. | 'Datei' "PowerShell" 'Shell' (erforderlich) |
ImageTemplateManagedImageDistributor
Name | Beschreibung | Wert |
---|---|---|
imageId | Ressourcen-ID des Image des verwalteten Datenträgers | Zeichenfolge (erforderlich) |
Ort | Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist | Zeichenfolge (erforderlich) |
Art | Typ der Verteilung. | "ManagedImage" (erforderlich) |
ImageTemplateManagedImageSource
Name | Beschreibung | Wert |
---|---|---|
imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
Art | 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. | PlatformImagePurchasePlan- |
Verlag | Image Publisher in Azure Gallery Images. | Schnur |
Sku | Bildsku aus der Azure Gallery Images. | Schnur |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
Version | Bildversion aus der Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. | Schnur |
ImageTemplatePowerShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array von auszuführenden PowerShell-Befehlen | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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 | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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[] |
ImageTemplateProperties
Name | Beschreibung | Wert |
---|---|---|
AutoRun | Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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) |
errorHandling | 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. | ImageTemplatePropertiesOptimize- |
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 |
vmProfile | Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Name | Beschreibung | Wert |
---|---|---|
onCustomizerError | 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 |
---|
ImageTemplatePropertiesOptimize
Name | Beschreibung | Wert |
---|---|---|
vmBoot | Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Name | Beschreibung | Wert |
---|---|---|
Zustand | 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.] | Bool |
inVMValidations | 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. | Bool |
ImageTemplateRestartCustomizer
Name | Beschreibung | Wert |
---|---|---|
restartCheckCommand | Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Schnur |
restartCommand | Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] | Schnur |
restartTimeout | Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] | Schnur |
Art | 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. | Bool |
galleryImageId | Ressourcen-ID des Azure Compute Gallery-Bilds | Zeichenfolge (erforderlich) |
replicationRegions | [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. | string[] |
storageAccountType | [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-[] |
Art | 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) |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
ImageTemplateShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array der auszuführenden Shellbefehle | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 |
---|---|---|
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageSource. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. Set to 'SharedImageVersion' for type ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (erforderlich) |
ImageTemplateVhdDistributor
Name | Beschreibung | Wert |
---|---|---|
Art | 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 |
ImageTemplateVmProfile
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 |
userAssignedIdentities | 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. | string[] |
vmSize | 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. | string[] |
searchCriteria | 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 |
Art | Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein | "WindowsUpdate" (erforderlich) |
updateLimit | 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 |
Microsoft.VirtualMachineImages/imageTemplates
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die API-Version | '2024-02-01' |
Identität | Die Identität der Bildvorlage, falls konfiguriert. | ImageTemplateIdentity- (erforderlich) |
Ort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Eigenschaften | Die Eigenschaften der Bildvorlage | ImageTemplateProperties- |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
Art | Der Ressourcentyp | 'Microsoft.VirtualMachineImages/imageTemplates' |
PlatformImagePurchasePlan
Name | Beschreibung | Wert |
---|---|---|
planName | Name des Einkaufsplans. | Zeichenfolge (erforderlich) |
planProduct | Produkt des Einkaufsplans. | Zeichenfolge (erforderlich) |
planPublisher | Herausgeber des Einkaufsplans. | Zeichenfolge (erforderlich) |
TargetRegion
Name | Beschreibung | Wert |
---|---|---|
Name | Der Name der Region. | Zeichenfolge (erforderlich) |
replicaCount | 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 |
storageAccountType | 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" |
TrackedResourceTags
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 ebenfalls angegeben ist und sich im gleichen virtuellen Netzwerk wie das subnetz befinden muss, das in subnetId angegeben ist. |
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 |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
Schablone | 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. |
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"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
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 das Schema Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für neuesten:
{
major = int
scheme = "Latest"
}
Verwenden Sie für Source:
{
scheme = "Source"
}
ImageTemplateInVMValidator-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
type = "File"
}
Verwenden Sie für PowerShell-:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
Verwenden Sie für Shell-:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
ImageTemplateDistributor-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für ManagedImage-:
{
imageId = "string"
location = "string"
type = "ManagedImage"
}
Verwenden Sie für SharedImage-:
{
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-:
{
type = "VHD"
uri = "string"
}
ImageTemplateCustomizer-Objekte
Legen Sie den Typ Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für Datei-:
{
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
type = "File"
}
Verwenden Sie für PowerShell-:
{
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
type = "PowerShell"
validExitCodes = [
int
]
}
Verwenden Sie für Shell-:
{
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
type = "Shell"
}
Verwenden Sie für WindowsRestart-:
{
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-:
{
imageId = "string"
type = "ManagedImage"
}
Verwenden Sie für PlatformImage-:
{
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"
}
Eigenschaftswerte
DistributeVersioner
Name | Beschreibung | Wert |
---|---|---|
Schema | Legen Sie für typ DistributeVersionerLatestauf "Latest" fest. Set to 'Source' for type DistributeVersionerSource. | "Neuestes" "Quelle" (erforderlich) |
DistributeVersionerLatest
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 |
---|---|---|
Zustand | 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 |
Art | Legen Sie für den Typ ImageTemplateFileCustomizerauf "Datei" fest. Legen Sie für den Typ ImageTemplatePowerShellCustomizerauf "PowerShell" fest. Legen Sie für den Typ ImageTemplateShellCustomizerauf "Shell" fest. Set to 'WindowsRestart' for type ImageTemplateRestartCustomizer. Set to 'WindowsUpdate' for type ImageTemplateWindowsUpdateCustomizer. | 'Datei' "PowerShell" 'Shell' "WindowsRestart" "WindowsUpdate" (erforderlich) |
ImageTemplateDistributor
Name | Beschreibung | Wert |
---|---|---|
artifactTags | 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. | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageDistributor. Set to 'SharedImage' for type ImageTemplateSharedImageDistributor. Legen Sie für den Typ ImageTemplateVhdDistributorauf "VHD" fest. | "ManagedImage" "SharedImage" "VHD" (erforderlich) |
ImageTemplateDistributorArtifactTags
Name | Beschreibung | Wert |
---|
ImageTemplateFileCustomizer
Name | Beschreibung | Wert |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Bestimmungsort | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Schnur |
sha256Checksum | 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 |
Art | 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 |
---|---|---|
Art | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | 'None' "UserAssigned" |
userAssignedIdentities | 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 |
Art | Legen Sie für den Typ "File" ImageTemplateFileValidatorfest. Set to 'PowerShell' for type ImageTemplatePowerShellValidator. Legen Sie für den Typ ImageTemplateShellValidatorauf "Shell" fest. | 'Datei' "PowerShell" 'Shell' (erforderlich) |
ImageTemplateManagedImageDistributor
Name | Beschreibung | Wert |
---|---|---|
imageId | Ressourcen-ID des Image des verwalteten Datenträgers | Zeichenfolge (erforderlich) |
Ort | Azure-Speicherort für das Image sollte übereinstimmen, wenn das Bild bereits vorhanden ist | Zeichenfolge (erforderlich) |
Art | Typ der Verteilung. | "ManagedImage" (erforderlich) |
ImageTemplateManagedImageSource
Name | Beschreibung | Wert |
---|---|---|
imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
Art | 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. | PlatformImagePurchasePlan- |
Verlag | Image Publisher in Azure Gallery Images. | Schnur |
Sku | Bildsku aus der Azure Gallery Images. | Schnur |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
Version | Bildversion aus der Azure Gallery Images. Wenn hier "latest" angegeben wird, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht, wenn die Vorlage übermittelt wird. | Schnur |
ImageTemplatePowerShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array von auszuführenden PowerShell-Befehlen | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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 | string[] |
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. | Bool |
runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt. | Bool |
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 |
sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld "scriptUri" bereitgestellt wird | Schnur |
Art | 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[] |
ImageTemplateProperties
Name | Beschreibung | Wert |
---|---|---|
AutoRun | Gibt an, ob die Bildvorlage automatisch auf der Vorlagenerstellung oder -aktualisierung ausgeführt werden soll. | ImageTemplateAutoRun |
buildTimeoutInMinutes | 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) |
errorHandling | 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. | ImageTemplatePropertiesOptimize- |
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 |
vmProfile | Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden | ImageTemplateVmProfile |
ImageTemplatePropertiesErrorHandling
Name | Beschreibung | Wert |
---|---|---|
onCustomizerError | 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 |
---|
ImageTemplatePropertiesOptimize
Name | Beschreibung | Wert |
---|---|---|
vmBoot | Die Optimierung wird auf das Image für einen schnelleren VM-Start angewendet. | ImageTemplatePropertiesOptimizeVmBoot |
ImageTemplatePropertiesOptimizeVmBoot
Name | Beschreibung | Wert |
---|---|---|
Zustand | 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.] | Bool |
inVMValidations | 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. | Bool |
ImageTemplateRestartCustomizer
Name | Beschreibung | Wert |
---|---|---|
restartCheckCommand | Befehl zum Überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Schnur |
restartCommand | Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] | Schnur |
restartTimeout | Neustarttimeout, das als Größenzeichenfolge und Einheit angegeben ist, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] | Schnur |
Art | 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. | Bool |
galleryImageId | Ressourcen-ID des Azure Compute Gallery-Bilds | Zeichenfolge (erforderlich) |
replicationRegions | [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. | string[] |
storageAccountType | [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-[] |
Art | 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) |
Art | Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
ImageTemplateShellCustomizer
Name | Beschreibung | Wert |
---|---|---|
schritthaltend | Array der auszuführenden Shellbefehle | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 | string[] |
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 |
sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im ScriptUri-Feld bereitgestellt wird | Schnur |
Art | 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 |
---|---|---|
Art | Set to 'ManagedImage' for type ImageTemplateManagedImageSource. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource. Set to 'SharedImageVersion' for type ImageTemplateSharedImageVersionSource. | "ManagedImage" "PlatformImage" "SharedImageVersion" (erforderlich) |
ImageTemplateVhdDistributor
Name | Beschreibung | Wert |
---|---|---|
Art | 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 |
ImageTemplateVmProfile
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 |
userAssignedIdentities | 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. | string[] |
vmSize | 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. | string[] |
searchCriteria | 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 |
Art | Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein | "WindowsUpdate" (erforderlich) |
updateLimit | 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 |
Microsoft.VirtualMachineImages/imageTemplates
Name | Beschreibung | Wert |
---|---|---|
Identität | Die Identität der Bildvorlage, falls konfiguriert. | ImageTemplateIdentity- (erforderlich) |
Ort | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[A-Za-z0-9-_.]{1,64}$ (erforderlich) |
Eigenschaften | Die Eigenschaften der Bildvorlage | ImageTemplateProperties- |
Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
Art | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01" |
PlatformImagePurchasePlan
Name | Beschreibung | Wert |
---|---|---|
planName | Name des Einkaufsplans. | Zeichenfolge (erforderlich) |
planProduct | Produkt des Einkaufsplans. | Zeichenfolge (erforderlich) |
planPublisher | Herausgeber des Einkaufsplans. | Zeichenfolge (erforderlich) |
TargetRegion
Name | Beschreibung | Wert |
---|---|---|
Name | Der Name der Region. | Zeichenfolge (erforderlich) |
replicaCount | 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 |
storageAccountType | 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" |
TrackedResourceTags
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 ebenfalls angegeben ist und sich im gleichen virtuellen Netzwerk wie das subnetz befinden muss, das in subnetId angegeben ist. |
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 |