Microsoft.VirtualMachineImages imageTemplates
Bicep-Ressourcendefinition
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.VirtualMachineImages/imageTemplates-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2022-02-14' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
buildTimeoutInMinutes: int
customize: [
{
name: 'string'
type: 'string'
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute: [
{
artifactTags: {}
runOutputName: 'string'
type: 'string'
// For remaining properties, see ImageTemplateDistributor objects
}
]
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: {
proxyVmSize: 'string'
subnetId: 'string'
}
}
}
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Datei Folgendes:
type: 'File'
destination: 'string'
sha256Checksum: 'string'
sourceUri: 'string'
Verwenden Sie für PowerShell Folgendes:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Verwenden Sie für Shell Folgendes:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Verwenden Sie für WindowsRestart Folgendes:
type: 'WindowsRestart'
restartCheckCommand: 'string'
restartCommand: 'string'
restartTimeout: 'string'
Verwenden Sie für WindowsUpdate Folgendes:
type: 'WindowsUpdate'
filters: [
'string'
]
searchCriteria: 'string'
updateLimit: int
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
type: 'ManagedImage'
imageId: 'string'
location: 'string'
Verwenden Sie für SharedImage Folgendes:
type: 'SharedImage'
excludeFromLatest: bool
galleryImageId: 'string'
replicationRegions: [
'string'
]
storageAccountType: 'string'
Verwenden Sie für VHD Folgendes:
type: 'VHD'
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
type: 'ManagedImage'
imageId: 'string'
Verwenden Sie für PlatformImage Folgendes:
type: 'PlatformImage'
offer: 'string'
planInfo: {
planName: 'string'
planProduct: 'string'
planPublisher: 'string'
}
publisher: 'string'
sku: 'string'
version: 'string'
Verwenden Sie für SharedImageVersion Folgendes:
type: 'SharedImageVersion'
imageVersionId: 'string'
ImageTemplateInVMValidator-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für PowerShell Folgendes:
type: 'PowerShell'
inline: [
'string'
]
runAsSystem: bool
runElevated: bool
scriptUri: 'string'
sha256Checksum: 'string'
validExitCodes: [
int
]
Verwenden Sie für Shell Folgendes:
type: 'Shell'
inline: [
'string'
]
scriptUri: 'string'
sha256Checksum: 'string'
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| Identität | Die Identität der Imagevorlage, sofern konfiguriert. | ImageTemplateIdentity (erforderlich) |
| properties | Die Eigenschaften der Bildvorlage | ImageTemplateProperties |
ImageTemplateIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | "Keine" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Objekt (object) |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| buildTimeoutInMinutes | Maximale Wartezeit beim Erstellen der Imagevorlage (umfasst alle Anpassungen, Überprüfungen und Distributionen). Lassen Sie den Standardwert (4 Stunden) aus, oder geben Sie 0 an. | INT |
| Anpassen | Gibt die Eigenschaften an, die verwendet werden, um die Anpassungsschritte des Bilds zu beschreiben, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilungsziele, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
| stagingResourceGroup | Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, die zum Erstellen des Images verwendet wird. Wenn dieses Feld leer ist, wird eine Ressourcengruppe mit einem zufälligen Namen erstellt. Wenn die in diesem Feld angegebene Ressourcengruppe nicht vorhanden ist, wird sie mit demselben Namen erstellt. Wenn die angegebene Ressourcengruppe vorhanden ist, muss sie leer sein und sich in derselben Region wie die Bildvorlage befinden. Die erstellte Ressourcengruppe wird beim Löschen der Vorlage gelöscht, wenn dieses Feld leer ist oder die angegebene Ressourcengruppe nicht vorhanden ist. Wenn die angegebene Ressourcengruppe jedoch vorhanden ist, werden die in der Ressourcengruppe erstellten Ressourcen beim Löschen der Vorlage gelöscht, und die Ressourcengruppe selbst bleibt erhalten. | Zeichenfolge |
| validate | Konfigurationsoptionen und Liste der Validierungen, die für das resultierende Image ausgeführt werden sollen. | ImageTemplatePropertiesValidate |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart WindowsUpdate (erforderlich) |
ImageTemplateFileCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | 'Datei' (erforderlich) |
| destination | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme der Datei, die im feld sourceUri oben bereitgestellt wird | Zeichenfolge |
| sourceUri | Der URI der Datei, die zum Anpassen des virtuellen Computers hochgeladen werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplatePowerShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt, indem der Lokale Systembenutzer verwendet wird. Kann nur true sein, wenn das feld runElevated oben auf true festgelegt ist. | bool |
| runElevated | Falls 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, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld scriptUri bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateRestartCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "WindowsRestart" (erforderlich) |
| restartCheckCommand | Befehl, um zu überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Zeichenfolge |
| restartCommand | Befehl zum Ausführen des Neustarts [Standardeinstellung: 'shutdown /r /f /t 0 /c 'packer restart''] | Zeichenfolge |
| restartTimeout | Neustarttimeout als Zeichenfolge von Größe und Einheit angegeben, z. B. "5m" (5 Minuten) oder "2 Stunden" (2 Stunden) [Standard: '5m'] | Zeichenfolge |
ImageTemplateWindowsUpdateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "WindowsUpdate" (erforderlich) |
| Filter | Array von Filtern zum Auswählen der zu übernehmenden Updates. Lassen Sie das leere Array aus, oder geben Sie es an, um den Standard (kein Filter) zu verwenden. Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie im obigen Link. | string[] |
| searchCriteria | Kriterien für die Suche nach Updates. Lassen Sie die leere Zeichenfolge weg, oder geben Sie sie an, um den Standardwert zu verwenden (alle durchsuchen). Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie im obigen Link. | Zeichenfolge |
| updateLimit | Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Weglassen oder 0 angeben, um den Standardwert zu verwenden (1000) | INT |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | ManagedImage SharedImage VHD (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "ManagedImage" (erforderlich) |
| imageId | Ressourcen-ID des Verwalteten Datenträgerimages | Zeichenfolge (erforderlich) |
| location | Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "SharedImage" (erforderlich) |
| excludeFromLatest | Flag, das angibt, ob die erstellte Imageversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie die Standardeinstellung (false) aus. | bool |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
| storageAccountType | Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung (Standard_LRS) aus. | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateManagedImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ManagedImage" (erforderlich) |
| imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog images. | Zeichenfolge |
| planInfo | Optionale Konfiguration des Kaufplans für das Plattformimage. | PlatformImagePurchasePlan |
| publisher | Image Publisher in Azure Gallery Images. | Zeichenfolge |
| sku | Image-SKU aus den Azure-Katalogimages. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. Wenn hier "neueste" angegeben wird, wird die Version beim Erstellen des Images ausgewertet, nicht beim Übermitteln der Vorlage. | Zeichenfolge |
PlatformImagePurchasePlan
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| planName | Name des Kaufplans. | Zeichenfolge (erforderlich) |
| planProduct | Produkt des Kaufplans. | Zeichenfolge (erforderlich) |
| planPublisher | Herausgeber des Kaufplans. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageVersionSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
| imageVersionId | ARM-Ressourcen-ID der Imageversion im Katalog für freigegebene Images | Zeichenfolge (erforderlich) |
ImageTemplatePropertiesValidate
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| continueDistributeOnFailure | Wenn die Überprüfung fehlschlägt und dieses Feld auf false festgelegt ist, werden die Ausgabebilder nicht verteilt. Dies ist das Standardverhalten. Wenn die Überprüfung fehlschlägt und dieses Feld auf true festgelegt ist, werden die Ausgabebilder weiterhin verteilt. Verwenden Sie diese Option mit Vorsicht, da dies dazu führen kann, dass schlechte Bilder zur Verwendung verteilt werden. In beiden Fällen (true oder false) wird bei der End-to-End-Image-Ausführung gemeldet, dass im Falle eines Validierungsfehlers ein Fehler aufgetreten ist. [Hinweis: Dieses Feld hat keine Auswirkungen, wenn die Validierung erfolgreich ist.] | bool |
| inVMValidations | Liste der durchzuführenden Überprüfungen. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Wenn dieses Feld auf true festgelegt ist, wird das im Abschnitt "Source" angegebene Bild direkt überprüft. Es wird kein separater Build ausgeführt, um ein angepasstes Image zu generieren und dann zu überprüfen. | bool |
ImageTemplateInVMValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename zum Bereitstellen des Kontexts für die Ausführung dieses Validierungsschritts | Zeichenfolge |
| type | Festlegen des Objekttyps | PowerShell Shell (erforderlich) |
ImageTemplatePowerShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt, indem der Lokale Systembenutzer verwendet wird. Kann nur true sein, wenn das feld runElevated oben auf true festgelegt ist. | bool |
| runElevated | Falls 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. Es kann sich um einen Github-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld scriptUri bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| osDiskSizeGB | Größe des Betriebssystemdatenträgers in GB. Lassen Sie 0 aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. | INT |
| userAssignedIdentities | Optionales Array von Ressourcen-IDs mit benutzerseitig zugewiesenen verwalteten Identitäten, die auf der Build-VM und der Validierungs-VM konfiguriert werden sollen. Dies kann die Identität der Bildvorlage umfassen. | string[] |
| vmSize | Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (Standard_D1_v2 für Gen1-Bilder und Standard_D2ds_v4 für Gen2-Bilder). | Zeichenfolge |
| vnetConfig | Optionale Konfiguration des virtuellen Netzwerks, das zum Bereitstellen der Build-VM und der Validierungs-VM verwendet werden soll. Lassen Sie diese Angabe aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. | VirtualNetworkConfig |
VirtualNetworkConfig
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| proxyVmSize | Größe des virtuellen Proxycomputers, der verwendet wird, um Datenverkehr an die Build-VM und die Validierungs-VM zu übergeben. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge (Standard_A1_v2) zu verwenden. | Zeichenfolge |
| subnetId | Ressourcen-ID eines bereits vorhandenen Subnetzes. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Azure Image Builder mit Azure Windows Baseline |
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit dem neuesten Windows Updates und angewendeter Azure Windows-Baseline. |
| Konfigurieren des Dev Box-Diensts |
Mit dieser Vorlage würden alle Dev Box-Administratorressourcen gemäß der Dev Box-Schnellstartanleitung erstellt. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihre erste Dev Box zu erstellen. |
Ressourcendefinition mit einer ARM-Vorlage
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Ä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": "2022-02-14",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"buildTimeoutInMinutes": "int",
"customize": [
{
"name": "string",
"type": "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
],
"distribute": [
{
"artifactTags": {},
"runOutputName": "string",
"type": "string"
// For remaining properties, see ImageTemplateDistributor objects
}
],
"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": {
"proxyVmSize": "string",
"subnetId": "string"
}
}
}
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Datei Folgendes:
"type": "File",
"destination": "string",
"sha256Checksum": "string",
"sourceUri": "string"
Verwenden Sie für PowerShell Folgendes:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Verwenden Sie für Shell Folgendes:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Verwenden Sie für WindowsRestart Folgendes:
"type": "WindowsRestart",
"restartCheckCommand": "string",
"restartCommand": "string",
"restartTimeout": "string"
Verwenden Sie für WindowsUpdate Folgendes:
"type": "WindowsUpdate",
"filters": [ "string" ],
"searchCriteria": "string",
"updateLimit": "int"
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
"type": "ManagedImage",
"imageId": "string",
"location": "string"
Verwenden Sie für SharedImage Folgendes:
"type": "SharedImage",
"excludeFromLatest": "bool",
"galleryImageId": "string",
"replicationRegions": [ "string" ],
"storageAccountType": "string"
Verwenden Sie für VHD Folgendes:
"type": "VHD"
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
"type": "ManagedImage",
"imageId": "string"
Verwenden Sie für PlatformImage Folgendes:
"type": "PlatformImage",
"offer": "string",
"planInfo": {
"planName": "string",
"planProduct": "string",
"planPublisher": "string"
},
"publisher": "string",
"sku": "string",
"version": "string"
Verwenden Sie für SharedImageVersion Folgendes:
"type": "SharedImageVersion",
"imageVersionId": "string"
ImageTemplateInVMValidator-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für PowerShell Folgendes:
"type": "PowerShell",
"inline": [ "string" ],
"runAsSystem": "bool",
"runElevated": "bool",
"scriptUri": "string",
"sha256Checksum": "string",
"validExitCodes": [ "int" ]
Verwenden Sie für Shell Folgendes:
"type": "Shell",
"inline": [ "string" ],
"scriptUri": "string",
"sha256Checksum": "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | Die Version der Ressourcen-API | '2022-02-14' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Identität | Die Identität der Bildvorlage, sofern konfiguriert. | ImageTemplateIdentity (erforderlich) |
| properties | Die Eigenschaften der Bildvorlage | ImageTemplateProperties |
ImageTemplateIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | "Keine" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Objekt (object) |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| buildTimeoutInMinutes | Maximale Wartezeit beim Erstellen der Imagevorlage (umfasst alle Anpassungen, Überprüfungen und Distributionen). Lassen Sie aus, oder geben Sie 0 an, um den Standardwert zu verwenden (4 Stunden). | INT |
| Anpassen | Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilung zielt darauf ab, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
| stagingResourceGroup | Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, die zum Erstellen des Images verwendet wird. Wenn dieses Feld leer ist, wird eine Ressourcengruppe mit einem zufälligen Namen erstellt. Wenn die in diesem Feld angegebene Ressourcengruppe nicht vorhanden ist, wird sie mit demselben Namen erstellt. Wenn die angegebene Ressourcengruppe vorhanden ist, muss sie leer und in derselben Region wie die Bildvorlage sein. Die erstellte Ressourcengruppe wird beim Löschen der Vorlage gelöscht, wenn dieses Feld leer ist oder die angegebene Ressourcengruppe nicht vorhanden ist, aber wenn die angegebene Ressourcengruppe vorhanden ist, werden die in der Ressourcengruppe erstellten Ressourcen beim Löschen der Vorlage gelöscht, und die Ressourcengruppe selbst bleibt erhalten. | Zeichenfolge |
| validate | Konfigurationsoptionen und Liste der Validierungen, die für das resultierende Image ausgeführt werden sollen. | ImageTemplatePropertiesValidate |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart WindowsUpdate (erforderlich) |
ImageTemplateFileCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | 'Datei' (erforderlich) |
| destination | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme der Datei, die im feld sourceUri oben bereitgestellt wird | Zeichenfolge |
| sourceUri | Der URI der Datei, die zum Anpassen des virtuellen Computers hochgeladen werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplatePowerShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten mithilfe des Lokalen Systembenutzers ausgeführt. Kann nur true sein, wenn das obige runElevated-Feld auf true festgelegt ist. | bool |
| runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Berechtigungen ausgeführt. | bool |
| scriptUri | URI des PowerShell-Skripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das im feld scriptUri oben bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateRestartCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "WindowsRestart" (erforderlich) |
| restartCheckCommand | Befehl, um zu überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Zeichenfolge |
| restartCommand | Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] | Zeichenfolge |
| restartTimeout | Neustarttimeout als Zeichenfolge von Größe und Einheit angegeben, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] | Zeichenfolge |
ImageTemplateWindowsUpdateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "WindowsUpdate" (erforderlich) |
| Filter | Array von Filtern zum Auswählen der anzuwendenden Updates. Lassen Sie ein leeres Array aus, um das Standardarray (kein Filter) zu verwenden. Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie unter dem obigen Link. | string[] |
| searchCriteria | Kriterien für die Suche nach Updates. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (alle durchsuchen). Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie unter dem obigen Link. | Zeichenfolge |
| updateLimit | Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Lassen Oder geben Sie 0 an, um den Standardwert zu verwenden (1000). | INT |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | ManagedImage SharedImage VHD (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "ManagedImage" (erforderlich) |
| imageId | Ressourcen-ID des Images für verwaltete Datenträger | Zeichenfolge (erforderlich) |
| location | Der Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "SharedImage" (erforderlich) |
| excludeFromLatest | Flag, das angibt, ob die erstellte Imageversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie aus, um den Standardwert (false) zu verwenden. | bool |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
| storageAccountType | Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung (Standard_LRS) aus. | "Standard_LRS" "Standard_ZRS" |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateManagedImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ManagedImage" (erforderlich) |
| imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog Images. | Zeichenfolge |
| planInfo | Optionale Konfiguration des Einkaufsplans für das Plattformimage. | PlatformImagePurchasePlan |
| publisher | Bildherausgeber in Azure-Katalogimages. | Zeichenfolge |
| sku | Bild-SKU aus dem Azure-Katalog Images. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. Wenn hier "latest" angegeben ist, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht beim Übermitteln der Vorlage. | Zeichenfolge |
PlatformImagePurchasePlan
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| planName | Name des Einkaufsplans. | Zeichenfolge (erforderlich) |
| planProduct | Produkt des Einkaufsplans. | Zeichenfolge (erforderlich) |
| planPublisher | Herausgeber des Kaufplans. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageVersionSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
| imageVersionId | ARM-Ressourcen-ID der Imageversion in der Shared Image Gallery | Zeichenfolge (erforderlich) |
ImageTemplatePropertiesValidate
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| continueDistributeOnFailure | Wenn die Überprüfung fehlschlägt und dieses Feld auf false festgelegt ist, werden die Ausgabebilder nicht verteilt. Dies ist das Standardverhalten. Wenn die Überprüfung fehlschlägt und dieses Feld auf TRUE festgelegt ist, werden die Ausgabebilder weiterhin verteilt. Verwenden Sie diese Option mit Vorsicht, da dies dazu führen kann, dass schlechte Bilder zur Verwendung verteilt werden. In beiden Fällen (true oder false) wird gemeldet, dass die End-to-End-Imageausführung im Falle eines Validierungsfehlers fehlgeschlagen ist. [Hinweis: Dieses Feld hat keine Auswirkung, wenn die Überprüfung erfolgreich ist.] | bool |
| inVMValidations | Liste der durchzuführenden Überprüfungen. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Wenn dieses Feld auf TRUE festgelegt ist, wird das im Abschnitt "Source" angegebene Bild direkt überprüft. Es wird kein separater Build ausgeführt, um ein angepasstes Image zu generieren und dann zu überprüfen. | bool |
ImageTemplateInVMValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Überprüfungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | PowerShell Shell (erforderlich) |
ImageTemplatePowerShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten mithilfe des Lokalen Systembenutzers ausgeführt. Kann nur true sein, wenn das obige runElevated-Feld auf true festgelegt ist. | bool |
| runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Berechtigungen ausgeführt. | bool |
| scriptUri | URI des PowerShell-Skripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das im feld scriptUri oben bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| osDiskSizeGB | Größe des Betriebssystemdatenträgers in GB. Lassen Sie 0 aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. | INT |
| userAssignedIdentities | Optionales Array von Ressourcen-IDs mit benutzerseitig zugewiesenen verwalteten Identitäten, die auf der Build-VM und der Validierungs-VM konfiguriert werden sollen. Dies kann die Identität der Bildvorlage umfassen. | string[] |
| vmSize | Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (Standard_D1_v2 für Gen1-Bilder und Standard_D2ds_v4 für Gen2-Bilder). | Zeichenfolge |
| vnetConfig | Optionale Konfiguration des virtuellen Netzwerks, das zum Bereitstellen der Build-VM und der Validierungs-VM verwendet werden soll. Lassen Sie diese Angabe aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. | VirtualNetworkConfig |
VirtualNetworkConfig
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| proxyVmSize | Größe des virtuellen Proxycomputers, der verwendet wird, um Datenverkehr an die Build-VM und die Validierungs-VM zu übergeben. Lassen Sie die leere Zeichenfolge aus, um den Standard (Standard_A1_v2) zu verwenden. | Zeichenfolge |
| subnetId | Ressourcen-ID eines bereits vorhandenen Subnetzes. | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Azure Image Builder mit Azure Windows-Baseline |
Erstellt eine Azure Image Builder-Umgebung und erstellt ein Windows Server-Image mit dem neuesten Windows Updates und Azure Windows Baseline angewendet. |
| Konfigurieren des Dev Box-Diensts |
Mit dieser Vorlage werden alle Dev Box-Administratorressourcen gemäß dev Box-Schnellstartanleitung erstellt. Sie können alle erstellten Ressourcen anzeigen oder direkt zu DevPortal.microsoft.com wechseln, um Ihre erste Dev Box zu erstellen. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der ImageTemplates-Ressourcentyp kann bereitgestellt werden in:
- 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 Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
buildTimeoutInMinutes = int
customize = [
{
name = "string"
type = "string"
// For remaining properties, see ImageTemplateCustomizer objects
}
]
distribute = [
{
artifactTags = {}
runOutputName = "string"
type = "string"
// For remaining properties, see ImageTemplateDistributor objects
}
]
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 = {
proxyVmSize = "string"
subnetId = "string"
}
}
}
})
}
ImageTemplateCustomizer-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für Datei Folgendes:
type = "File"
destination = "string"
sha256Checksum = "string"
sourceUri = "string"
Verwenden Sie für PowerShell Folgendes:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Verwenden Sie für Shell Folgendes:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Verwenden Sie für WindowsRestart Folgendes:
type = "WindowsRestart"
restartCheckCommand = "string"
restartCommand = "string"
restartTimeout = "string"
Verwenden Sie für WindowsUpdate Folgendes:
type = "WindowsUpdate"
filters = [
"string"
]
searchCriteria = "string"
updateLimit = int
ImageTemplateDistributor-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
type = "ManagedImage"
imageId = "string"
location = "string"
Verwenden Sie für SharedImage Folgendes:
type = "SharedImage"
excludeFromLatest = bool
galleryImageId = "string"
replicationRegions = [
"string"
]
storageAccountType = "string"
Verwenden Sie für VHD Folgendes:
type = "VHD"
ImageTemplateSource-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für ManagedImage Folgendes:
type = "ManagedImage"
imageId = "string"
Verwenden Sie für PlatformImage Folgendes:
type = "PlatformImage"
offer = "string"
planInfo = {
planName = "string"
planProduct = "string"
planPublisher = "string"
}
publisher = "string"
sku = "string"
version = "string"
Verwenden Sie für SharedImageVersion Folgendes:
type = "SharedImageVersion"
imageVersionId = "string"
ImageTemplateInVMValidator-Objekte
Legen Sie die type-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für PowerShell Folgendes:
type = "PowerShell"
inline = [
"string"
]
runAsSystem = bool
runElevated = bool
scriptUri = "string"
sha256Checksum = "string"
validExitCodes = [
int
]
Verwenden Sie für Shell Folgendes:
type = "Shell"
inline = [
"string"
]
scriptUri = "string"
sha256Checksum = "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates@2022-02-14" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Der geografische Standort, an dem sich die Ressource befindet | Zeichenfolge (erforderlich) |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Ressourcentags. | Wörterbuch der Tagnamen und -werte. |
| Identität | Die Identität der Bildvorlage, sofern konfiguriert. | ImageTemplateIdentity (erforderlich) |
| properties | Die Eigenschaften der Bildvorlage | ImageTemplateProperties |
ImageTemplateIdentity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Identitätstyp, der für die Bildvorlage verwendet wird. Der Typ "None" entfernt alle Identitäten aus der Bildvorlage. | "UserAssigned" |
| identity_ids | Die Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Array von Benutzeridentitäts-IDs. |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| buildTimeoutInMinutes | Maximale Wartezeit beim Erstellen der Imagevorlage (umfasst alle Anpassungen, Überprüfungen und Distributionen). Lassen Sie aus, oder geben Sie 0 an, um den Standardwert zu verwenden (4 Stunden). | INT |
| Anpassen | Gibt die Eigenschaften an, die zum Beschreiben der Anpassungsschritte des Bilds verwendet werden, z. B. Bildquelle usw. | ImageTemplateCustomizer[] |
| Verteilen (distribute) | Die Verteilung zielt darauf ab, an die die Bildausgabe gehen muss. | ImageTemplateDistributor[] (erforderlich) |
| source | Gibt die Eigenschaften an, die zum Beschreiben des Quellimages verwendet werden. | ImageTemplateSource (erforderlich) |
| stagingResourceGroup | Die Stagingressourcengruppen-ID im selben Abonnement wie die Imagevorlage, die zum Erstellen des Images verwendet wird. Wenn dieses Feld leer ist, wird eine Ressourcengruppe mit einem zufälligen Namen erstellt. Wenn die in diesem Feld angegebene Ressourcengruppe nicht vorhanden ist, wird sie mit demselben Namen erstellt. Wenn die angegebene Ressourcengruppe vorhanden ist, muss sie leer und in derselben Region wie die Bildvorlage sein. Die erstellte Ressourcengruppe wird beim Löschen der Vorlage gelöscht, wenn dieses Feld leer ist oder die angegebene Ressourcengruppe nicht vorhanden ist, aber wenn die angegebene Ressourcengruppe vorhanden ist, werden die in der Ressourcengruppe erstellten Ressourcen beim Löschen der Vorlage gelöscht, und die Ressourcengruppe selbst bleibt erhalten. | Zeichenfolge |
| validate | Konfigurationsoptionen und Liste der Validierungen, die für das resultierende Image ausgeführt werden sollen. | ImageTemplatePropertiesValidate |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename zum Bereitstellen des Kontexts für die Aufgaben dieses Anpassungsschritts | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart WindowsUpdate (erforderlich) |
ImageTemplateFileCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "Datei" (erforderlich) |
| destination | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) in den virtuellen Computer hochgeladen wird | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme der Datei, die im feld sourceUri oben bereitgestellt wird | Zeichenfolge |
| sourceUri | Der URI der Datei, die zum Anpassen des virtuellen Computers hochgeladen werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
ImageTemplatePowerShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten ausgeführt, indem der Lokale Systembenutzer verwendet wird. Kann nur true sein, wenn das feld runElevated oben auf true festgelegt ist. | bool |
| runElevated | Falls 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, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das oben im Feld scriptUri bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zum Anpassen ausgeführt werden soll. Es kann sich um einen Github-Link, einen SAS-URI für Azure Storage usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateRestartCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. "Shell" kann z. B. Shell-Customizer sein. | "WindowsRestart" (erforderlich) |
| restartCheckCommand | Befehl, um zu überprüfen, ob der Neustart erfolgreich war [Standard: ''] | Zeichenfolge |
| restartCommand | Befehl zum Ausführen des Neustarts [Standard: 'shutdown /r /f /t 0 /c "packer restart"'] | Zeichenfolge |
| restartTimeout | Neustarttimeout als Zeichenfolge von Größe und Einheit angegeben, z. B. "5m" (5 Minuten) oder "2h" (2 Stunden) [Standard: '5m'] | Zeichenfolge |
ImageTemplateWindowsUpdateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "WindowsUpdate" (erforderlich) |
| Filter | Array von Filtern zum Auswählen der anzuwendenden Updates. Lassen Sie ein leeres Array aus, um das Standardarray (kein Filter) zu verwenden. Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie unter dem obigen Link. | string[] |
| searchCriteria | Kriterien für die Suche nach Updates. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (alle durchsuchen). Beispiele und eine ausführliche Beschreibung dieses Felds finden Sie unter dem obigen Link. | Zeichenfolge |
| updateLimit | Maximale Anzahl von Updates, die gleichzeitig angewendet werden sollen. Lassen Oder geben Sie 0 an, um den Standardwert zu verwenden (1000). | INT |
ImageTemplateDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| artifactTags | Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. | Objekt (object) |
| runOutputName | Der Name, der für den zugeordneten RunOutput verwendet werden soll. | Zeichenfolge (erforderlich) |
| Typ | Festlegen des Objekttyps | ManagedImage SharedImage VHD (erforderlich) |
ImageTemplateManagedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "ManagedImage" (erforderlich) |
| imageId | Ressourcen-ID des Images für verwaltete Datenträger | Zeichenfolge (erforderlich) |
| location | Der Azure-Speicherort für das Image sollte übereinstimmen, wenn das Image bereits vorhanden ist. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "SharedImage" (erforderlich) |
| excludeFromLatest | Flag, das angibt, ob die erstellte Imageversion von der neuesten Version ausgeschlossen werden soll. Lassen Sie aus, um den Standardwert (false) zu verwenden. | bool |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
| storageAccountType | Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung (Standard_LRS) aus. | „Standard_LRS“ „Standard_ZRS“ |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateManagedImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ManagedImage" (erforderlich) |
| imageId | ARM-Ressourcen-ID des verwalteten Images im Kundenabonnement | Zeichenfolge (erforderlich) |
ImageTemplatePlatformImageSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "PlatformImage" (erforderlich) |
| offer | Imageangebot aus dem Azure-Katalog Images. | Zeichenfolge |
| planInfo | Optionale Konfiguration des Einkaufsplans für das Plattformimage. | PlatformImagePurchasePlan |
| publisher | Bildherausgeber in Azure-Katalogimages. | Zeichenfolge |
| sku | Bild-SKU aus dem Azure-Katalog Images. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. Wenn hier "latest" angegeben ist, wird die Version ausgewertet, wenn der Imagebuild stattfindet, nicht beim Übermitteln der Vorlage. | Zeichenfolge |
PlatformImagePurchasePlan
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| planName | Name des Einkaufsplans. | Zeichenfolge (erforderlich) |
| planProduct | Produkt des Einkaufsplans. | Zeichenfolge (erforderlich) |
| planPublisher | Herausgeber des Kaufplans. | Zeichenfolge (erforderlich) |
ImageTemplateSharedImageVersionSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "SharedImageVersion" (erforderlich) |
| imageVersionId | ARM-Ressourcen-ID der Imageversion in der Shared Image Gallery | Zeichenfolge (erforderlich) |
ImageTemplatePropertiesValidate
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| continueDistributeOnFailure | Wenn die Überprüfung fehlschlägt und dieses Feld auf false festgelegt ist, werden die Ausgabebilder nicht verteilt. Dies ist das Standardverhalten. Wenn die Überprüfung fehlschlägt und dieses Feld auf TRUE festgelegt ist, werden die Ausgabebilder weiterhin verteilt. Verwenden Sie diese Option mit Vorsicht, da dies dazu führen kann, dass schlechte Bilder zur Verwendung verteilt werden. In beiden Fällen (true oder false) wird gemeldet, dass die End-to-End-Imageausführung im Falle eines Validierungsfehlers fehlgeschlagen ist. [Hinweis: Dieses Feld hat keine Auswirkung, wenn die Überprüfung erfolgreich ist.] | bool |
| inVMValidations | Liste der durchzuführenden Überprüfungen. | ImageTemplateInVMValidator[] |
| sourceValidationOnly | Wenn dieses Feld auf TRUE festgelegt ist, wird das im Abschnitt "Source" angegebene Bild direkt überprüft. Es wird kein separater Build ausgeführt, um ein angepasstes Image zu generieren und dann zu überprüfen. | bool |
ImageTemplateInVMValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Überprüfungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | PowerShell Shell (erforderlich) |
ImageTemplatePowerShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| runAsSystem | Falls angegeben, wird das PowerShell-Skript mit erhöhten Rechten mithilfe des Lokalen Systembenutzers ausgeführt. Kann nur true sein, wenn das obige runElevated-Feld auf true festgelegt ist. | bool |
| runElevated | Wenn angegeben, wird das PowerShell-Skript mit erhöhten Berechtigungen ausgeführt. | bool |
| scriptUri | URI des PowerShell-Skripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Power Shell-Skripts, das im feld scriptUri oben bereitgestellt wird | Zeichenfolge |
| validExitCodes | Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] | int[] |
ImageTemplateShellValidator
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ der Validierung, die Sie für das Image verwenden möchten. Beispielsweise kann es sich bei "Shell" um eine Shellvalidierung handeln. | "Shell" (erforderlich) |
| inline | Array der auszuführenden Shellbefehle | string[] |
| scriptUri | URI des Shellskripts, das zur Überprüfung ausgeführt werden soll. Es kann sich um einen GitHub-Link, einen Azure Storage-URI usw. handeln. | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme des Shellskripts, das im Feld scriptUri bereitgestellt wird | Zeichenfolge |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| osDiskSizeGB | Größe des Betriebssystemdatenträgers in GB. Lassen Sie 0 aus, um die Standardgröße des Betriebssystemdatenträgers von Azure zu verwenden. | INT |
| userAssignedIdentities | Optionales Array von Ressourcen-IDs mit benutzerseitig zugewiesenen verwalteten Identitäten, die auf der Build-VM und der Validierungs-VM konfiguriert werden sollen. Dies kann die Identität der Bildvorlage umfassen. | string[] |
| vmSize | Größe des virtuellen Computers, der zum Erstellen, Anpassen und Erfassen von Images verwendet wird. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge zu verwenden (Standard_D1_v2 für Gen1-Bilder und Standard_D2ds_v4 für Gen2-Bilder). | Zeichenfolge |
| vnetConfig | Optionale Konfiguration des virtuellen Netzwerks, das zum Bereitstellen der Build-VM und der Validierungs-VM verwendet werden soll. Lassen Sie diese Angabe aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. | VirtualNetworkConfig |
VirtualNetworkConfig
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| proxyVmSize | Größe des virtuellen Proxycomputers, der verwendet wird, um Datenverkehr an die Build-VM und die Validierungs-VM zu übergeben. Lassen Sie eine leere Zeichenfolge aus, um die Standardzeichenfolge (Standard_A1_v2) zu verwenden. | Zeichenfolge |
| subnetId | Ressourcen-ID eines bereits vorhandenen Subnetzes. | Zeichenfolge |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für