Microsoft.VirtualMachineImages imageTemplates 2019-05-01-preview
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@2019-05-01-preview' = {
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
}
vmProfile: {
vmSize: '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'
]
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'
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'
galleryImageId: 'string'
replicationRegions: [
'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 ISO Folgendes:
type: 'ISO'
sha256Checksum: 'string'
sourceUri: 'string'
Verwenden Sie für ManagedImage Folgendes:
type: 'ManagedImage'
imageId: 'string'
Verwenden Sie für PlatformImage Folgendes:
type: 'PlatformImage'
offer: 'string'
publisher: 'string'
sku: 'string'
version: 'string'
Verwenden Sie für SharedImageVersion Folgendes:
type: 'SharedImageVersion'
imageVersionId: 'string'
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | 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 |
| 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 Bildvorlage. 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) |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart (erforderlich) |
ImageTemplateFileCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "Datei" (erforderlich) |
| destination | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) auf der VM hochgeladen wird | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme der Datei, die oben im Feld sourceUri bereitgestellt wird | Zeichenfolge |
| sourceUri | Der URI der Datei, die zum Anpassen der VM 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. Beispielsweise kann "Shell" shell customizer sein. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| 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 |
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) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Typ der Verteilung. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| sourceUri | URI zum Abrufen des ISO-Images. Auf diesen URI muss der Ressourcenanbieter zum Zeitpunkt der Erstellung der Imagevorlage zugreifen können. | Zeichenfolge (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 |
| publisher | Bildherausgeber in Azure-Katalogimages. | Zeichenfolge |
| sku | Bild-SKU aus dem Azure-Katalog Images. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
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) |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| 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 (Standard_D1_v2) zu verwenden. | 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": "2019-05-01-preview",
"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
},
"vmProfile": {
"vmSize": "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" ],
"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"
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",
"galleryImageId": "string",
"replicationRegions": [ "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 ISO Folgendes:
"type": "ISO",
"sha256Checksum": "string",
"sourceUri": "string"
Verwenden Sie für ManagedImage Folgendes:
"type": "ManagedImage",
"imageId": "string"
Verwenden Sie für PlatformImage Folgendes:
"type": "PlatformImage",
"offer": "string",
"publisher": "string",
"sku": "string",
"version": "string"
Verwenden Sie für SharedImageVersion Folgendes:
"type": "SharedImageVersion",
"imageVersionId": "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates" |
| apiVersion | Die Version der Ressourcen-API | "2019-05-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | 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 |
| 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 Bildvorlage. 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) |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart (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[] |
| 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 |
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) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| sourceUri | URI zum Abrufen des ISO-Images. Auf diesen URI muss der Ressourcenanbieter zum Zeitpunkt der Erstellung der Imagevorlage zugreifen können. | Zeichenfolge (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 |
| publisher | Image Publisher in Azure Gallery Images. | Zeichenfolge |
| sku | Image-SKU aus den Azure-Katalogimages. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
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) |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| 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 (Standard_D1_v2) zu verwenden. | 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. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der ImageTemplates-Ressourcentyp kann für Folgendes bereitgestellt werden:
- 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 Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview"
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
}
vmProfile = {
vmSize = "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"
]
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"
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"
galleryImageId = "string"
replicationRegions = [
"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 ISO Folgendes:
type = "ISO"
sha256Checksum = "string"
sourceUri = "string"
Verwenden Sie für ManagedImage Folgendes:
type = "ManagedImage"
imageId = "string"
Verwenden Sie für PlatformImage Folgendes:
type = "PlatformImage"
offer = "string"
publisher = "string"
sku = "string"
version = "string"
Verwenden Sie für SharedImageVersion Folgendes:
type = "SharedImageVersion"
imageVersionId = "string"
Eigenschaftswerte
imageTemplates
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.VirtualMachineImages/imageTemplates@2019-05-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | 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 Imagevorlage, sofern konfiguriert. | ImageTemplateIdentity |
| 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. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". | Array von Benutzeridentitäts-IDs. |
ImageTemplateProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| buildTimeoutInMinutes | Maximale Wartezeit beim Erstellen der Bildvorlage. 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) |
| vmProfile | Beschreibt, wie der virtuelle Computer zum Erstellen von Images eingerichtet wird. | ImageTemplateVmProfile |
ImageTemplateCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Anzeigename, um Kontext für die Funktionsweise dieses Anpassungsschritts bereitzustellen | Zeichenfolge |
| type | Festlegen des Objekttyps | File PowerShell Shell WindowsRestart (erforderlich) |
ImageTemplateFileCustomizer
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Typ des Anpassungstools, das Sie für das Image verwenden möchten. Beispielsweise kann "Shell" shell customizer sein. | "Datei" (erforderlich) |
| destination | Der absolute Pfad zu einer Datei (mit bereits erstellten geschachtelten Verzeichnisstrukturen), in die die Datei (aus sourceUri) auf der VM hochgeladen wird | Zeichenfolge |
| sha256Checksum | SHA256-Prüfsumme der Datei, die oben im Feld sourceUri bereitgestellt wird | Zeichenfolge |
| sourceUri | Der URI der Datei, die zum Anpassen der VM 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. Beispielsweise kann "Shell" shell customizer sein. | "PowerShell" (erforderlich) |
| inline | Array der auszuführenden PowerShell-Befehle | string[] |
| 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 |
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) |
| galleryImageId | Ressourcen-ID des Shared Image Gallery-Images | Zeichenfolge (erforderlich) |
| replicationRegions | Eine Liste der Regionen, in die das Image repliziert wird | string[] (erforderlich) |
ImageTemplateVhdDistributor
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Verteilungstyp. | "VHD" (erforderlich) |
ImageTemplateSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Festlegen des Objekttyps | ISO ManagedImage PlatformImage SharedImageVersion (erforderlich) |
ImageTemplateIsoSource
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Gibt den Typ des Quellimages an, mit dem Sie beginnen möchten. | "ISO" (erforderlich) |
| sha256Checksum | SHA256-Prüfsumme des ISO-Images. | Zeichenfolge (erforderlich) |
| sourceUri | URI zum Abrufen des ISO-Images. Auf diesen URI muss der Ressourcenanbieter zum Zeitpunkt der Erstellung der Imagevorlage zugreifen können. | Zeichenfolge (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 |
| publisher | Image Publisher in Azure Gallery Images. | Zeichenfolge |
| sku | Image-SKU aus den Azure-Katalogimages. | Zeichenfolge |
| version | Imageversion aus den Azure-Katalogimages. | Zeichenfolge |
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) |
ImageTemplateVmProfile
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| 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 (Standard_D1_v2) zu verwenden. | 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