Freigeben über


Microsoft.VirtualMachineImages imageTemplates 2020-02-14

Bicep-Ressourcendefinition

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

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

Ressourcenformat

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

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2020-02-14' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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: {
      osDiskSizeGB: int
      vmSize: 'string'
      vnetConfig: {
        subnetId: 'string'
      }
    }
  }
}

ImageTemplateCustomizer-Objekte

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

Verwenden Sie für Datei-:

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

Verwenden Sie für PowerShell-:

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

Verwenden Sie für Shell-:

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

Verwenden Sie für WindowsRestart-:

  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 den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage-:

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

Verwenden Sie für SharedImage-:

  type: 'SharedImage'
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'

Verwenden Sie für VHD-:

  type: 'VHD'

ImageTemplateSource-Objekte

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

Verwenden Sie für ManagedImage-:

  type: 'ManagedImage'
  imageId: 'string'

Verwenden Sie für PlatformImage-:

  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'

Eigenschaftswerte

imageTemplates

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity- (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplateProperties-

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 Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Name Beschreibung Wert
{angepasste Eigenschaft} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ImageTemplateProperties

Name Beschreibung Wert
buildTimeoutInMinutes Maximale Wartezeit beim Erstellen der Bildvorlage. 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)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)
vmProfile Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfile

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Festlegen des Objekttyps Datei-
PowerShell-
Shell-
WindowsRestart-
WindowsUpdate- (erforderlich)

ImageTemplateFileCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Datei' (erforderlich)
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

ImageTemplatePowerShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
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
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplateShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Shell' (erforderlich)
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

ImageTemplateRestartCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)
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

ImageTemplateWindowsUpdateCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
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
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

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. Objekt
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge (erforderlich)

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
Art Festlegen des Objekttyps ManagedImage-
SharedImage-
VHD- (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "ManagedImage" (erforderlich)
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)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "SharedImage" (erforderlich)
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 Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions Eine Liste der Regionen, in die das Bild repliziert wird string[] (erforderlich)
storageAccountType Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "VHD" (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Festlegen des Objekttyps ManagedImage-
PlatformImage-
SharedImageVersion- (erforderlich)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
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
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. Die Angabe von "latest" kann ROUNDTRIP_INCONSISTENT_PROPERTY Problem verursachen, das behoben wird. Schnur

PlatformImagePurchasePlan

Name Beschreibung Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProduct Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

ImageTemplateSharedImageVersionSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)
imageVersionId ARM-Ressourcen-ID der Bildversion im freigegebenen Bilderkatalog Zeichenfolge (erforderlich)

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
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, das zum Bereitstellen des virtuellen Buildcomputers verwendet werden soll. Lassen Sie aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. VirtualNetworkConfig-

VirtualNetworkConfig

Name Beschreibung Wert
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes. Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Image Builder mit Azure Windows Baseline

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

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

ARM-Vorlagenressourcendefinition

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

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

Ressourcenformat

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

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2020-02-14",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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": {
      "osDiskSizeGB": "int",
      "vmSize": "string",
      "vnetConfig": {
        "subnetId": "string"
      }
    }
  }
}

ImageTemplateCustomizer-Objekte

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

Verwenden Sie für Datei-:

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

Verwenden Sie für PowerShell-:

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

Verwenden Sie für Shell-:

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

Verwenden Sie für WindowsRestart-:

  "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 den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage-:

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

Verwenden Sie für SharedImage-:

  "type": "SharedImage",
  "excludeFromLatest": "bool",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ],
  "storageAccountType": "string"

Verwenden Sie für VHD-:

  "type": "VHD"

ImageTemplateSource-Objekte

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

Verwenden Sie für ManagedImage-:

  "type": "ManagedImage",
  "imageId": "string"

Verwenden Sie für PlatformImage-:

  "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"

Eigenschaftswerte

imageTemplates

Name Beschreibung Wert
Art Der Ressourcentyp 'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion Die Ressourcen-API-Version '2020-02-14'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity- (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplateProperties-

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 Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Name Beschreibung Wert
{angepasste Eigenschaft} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ImageTemplateProperties

Name Beschreibung Wert
buildTimeoutInMinutes Maximale Wartezeit beim Erstellen der Bildvorlage. 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)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)
vmProfile Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfile

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Festlegen des Objekttyps Datei-
PowerShell-
Shell-
WindowsRestart-
WindowsUpdate- (erforderlich)

ImageTemplateFileCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Datei' (erforderlich)
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

ImageTemplatePowerShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
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
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplateShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein 'Shell' (erforderlich)
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

ImageTemplateRestartCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)
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

ImageTemplateWindowsUpdateCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
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
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

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. Objekt
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge (erforderlich)

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
Art Festlegen des Objekttyps ManagedImage-
SharedImage-
VHD- (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "ManagedImage" (erforderlich)
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)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "SharedImage" (erforderlich)
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 Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions Eine Liste der Regionen, in die das Bild repliziert wird string[] (erforderlich)
storageAccountType Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "VHD" (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Festlegen des Objekttyps ManagedImage-
PlatformImage-
SharedImageVersion- (erforderlich)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
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
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. Die Angabe von "latest" kann ROUNDTRIP_INCONSISTENT_PROPERTY Problem verursachen, das behoben wird. Schnur

PlatformImagePurchasePlan

Name Beschreibung Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProduct Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

ImageTemplateSharedImageVersionSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)
imageVersionId ARM-Ressourcen-ID der Bildversion im freigegebenen Bilderkatalog Zeichenfolge (erforderlich)

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
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, das zum Bereitstellen des virtuellen Buildcomputers verwendet werden soll. Lassen Sie aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. VirtualNetworkConfig-

VirtualNetworkConfig

Name Beschreibung Wert
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes. Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Azure Image Builder mit Azure Windows Baseline

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

Bereitstellen in Azure
Diese Vorlage würde alle Dev Box-Administratorressourcen gemäß Dev Box-Schnellstarthandbuch (https://learn.microsoft.com/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@2020-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
      }
      vmProfile = {
        osDiskSizeGB = int
        vmSize = "string"
        vnetConfig = {
          subnetId = "string"
        }
      }
    }
  })
}

ImageTemplateCustomizer-Objekte

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

Verwenden Sie für Datei-:

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

Verwenden Sie für PowerShell-:

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

Verwenden Sie für Shell-:

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

Verwenden Sie für WindowsRestart-:

  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 den Typ Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für ManagedImage-:

  type = "ManagedImage"
  imageId = "string"
  location = "string"

Verwenden Sie für SharedImage-:

  type = "SharedImage"
  excludeFromLatest = bool
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]
  storageAccountType = "string"

Verwenden Sie für VHD-:

  type = "VHD"

ImageTemplateSource-Objekte

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

Verwenden Sie für ManagedImage-:

  type = "ManagedImage"
  imageId = "string"

Verwenden Sie für PlatformImage-:

  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"

Eigenschaftswerte

imageTemplates

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.VirtualMachineImages/imageTemplates@2020-02-14"
Name Der Ressourcenname Zeichenfolge (erforderlich)
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
parent_id Verwenden Sie die ID dieser Ressourcengruppe, um sie in einer Ressourcengruppe bereitzustellen. Zeichenfolge (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Identität Die Identität der Bildvorlage, falls konfiguriert. ImageTemplateIdentity- (erforderlich)
Eigenschaften Die Eigenschaften der Bildvorlage ImageTemplateProperties-

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. "UserAssigned"
identity_ids Die Liste der Benutzeridentitäten, die der Bildvorlage zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Array von Benutzeridentitäts-IDs.

ImageTemplateIdentityUserAssignedIdentities

Name Beschreibung Wert
{angepasste Eigenschaft} ComponentsVrq145SchemasImagetemplateidentityProperti...

ComponentsVrq145SchemasImagetemplateidentityProperti...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ImageTemplateProperties

Name Beschreibung Wert
buildTimeoutInMinutes Maximale Wartezeit beim Erstellen der Bildvorlage. 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)
Quelle Gibt die Eigenschaften an, die zum Beschreiben des Quellbilds verwendet werden. ImageTemplateSource- (erforderlich)
vmProfile Beschreibt, wie virtuelle Computer zum Erstellen von Images eingerichtet werden ImageTemplateVmProfile

ImageTemplateCustomizer

Name Beschreibung Wert
Name Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird Schnur
Art Festlegen des Objekttyps Datei-
PowerShell-
Shell-
WindowsRestart-
WindowsUpdate- (erforderlich)

ImageTemplateFileCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "Datei" (erforderlich)
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

ImageTemplatePowerShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "PowerShell" (erforderlich)
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
validExitCodes Gültige Exitcodes für das PowerShell-Skript. [Standard: 0] int[]

ImageTemplateShellCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "Shell" (erforderlich)
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

ImageTemplateRestartCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsRestart" (erforderlich)
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

ImageTemplateWindowsUpdateCustomizer

Name Beschreibung Wert
Art Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein "WindowsUpdate" (erforderlich)
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
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

ImageTemplateDistributor

Name Beschreibung Wert
artifactTags Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde. Objekt
runOutputName Der Name, der für den zugeordneten RunOutput verwendet werden soll. Zeichenfolge (erforderlich)

Zwänge:
Pattern = ^[A-Za-z0-9-_.]{1,64}$
Art Festlegen des Objekttyps ManagedImage-
SharedImage-
VHD- (erforderlich)

ImageTemplateManagedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "ManagedImage" (erforderlich)
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)

ImageTemplateSharedImageDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "SharedImage" (erforderlich)
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 Bilds "Freigegebene Bildergalerie" Zeichenfolge (erforderlich)
replicationRegions Eine Liste der Regionen, in die das Bild repliziert wird string[] (erforderlich)
storageAccountType Speicherkontotyp, der zum Speichern des freigegebenen Images verwendet werden soll. Lassen Sie die Standardeinstellung aus (Standard_LRS). "Standard_LRS"
"Standard_ZRS"

ImageTemplateVhdDistributor

Name Beschreibung Wert
Art Typ der Verteilung. "VHD" (erforderlich)

ImageTemplateSource

Name Beschreibung Wert
Art Festlegen des Objekttyps ManagedImage-
PlatformImage-
SharedImageVersion- (erforderlich)

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "PlatformImage" (erforderlich)
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
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. Die Angabe von "latest" kann ROUNDTRIP_INCONSISTENT_PROPERTY Problem verursachen, das behoben wird. Schnur

PlatformImagePurchasePlan

Name Beschreibung Wert
planName Name des Einkaufsplans. Zeichenfolge (erforderlich)
planProduct Produkt des Einkaufsplans. Zeichenfolge (erforderlich)
planPublisher Herausgeber des Einkaufsplans. Zeichenfolge (erforderlich)

ImageTemplateSharedImageVersionSource

Name Beschreibung Wert
Art Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten. "SharedImageVersion" (erforderlich)
imageVersionId ARM-Ressourcen-ID der Bildversion im freigegebenen Bilderkatalog Zeichenfolge (erforderlich)

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
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, das zum Bereitstellen des virtuellen Buildcomputers verwendet werden soll. Lassen Sie aus, wenn kein bestimmtes virtuelles Netzwerk verwendet werden muss. VirtualNetworkConfig-

VirtualNetworkConfig

Name Beschreibung Wert
subnetz-ID Ressourcen-ID eines bereits vorhandenen Subnetzes. Schnur