Microsoft.VirtualMachineImages imageTemplates 2019-02-01-preview

Artikel
12/17/2024

Bicep-Ressourcendefinition

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

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

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

Ressourcenformat

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

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {
          {customized property}: 'string'
        }
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

ImageTemplateCustomizer-Objekte

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

Verwenden Sie für PowerShell-:

{
  inline: [
    'string'
  ]
  script: 'string'
  type: 'PowerShell'
  validExitCodes: [
    int
  ]
}

Verwenden Sie für Shell-:

{
  inline: [
    'string'
  ]
  script: 'string'
  type: 'Shell'
}

Verwenden Sie für WindowsRestart-:

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

ImageTemplateSource-Objekte

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

Verwenden Sie für ISO-:

{
  sha256Checksum: 'string'
  sourceURI: 'string'
  type: 'ISO'
}

Verwenden Sie für ManagedImage-:

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

Verwenden Sie für PlatformImage-:

{
  offer: 'string'
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

ImageTemplateDistributor-Objekte

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

Verwenden Sie für ManagedImage-:

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

Verwenden Sie für SharedImage-:

{
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  type: 'SharedImage'
}

Verwenden Sie für VHD-:

{
  type: 'VHD'
}

Eigenschaftswerte

ImageTemplateCustomizer

Name	Beschreibung	Wert
Name	Anzeigename zum Bereitstellen des Kontexts, der in diesem Anpassungsschritt ausgeführt wird	Schnur
Art	Legen Sie für den Typ ImageTemplatePowerShellCustomizerauf "PowerShell" fest. Legen Sie für den Typ ImageTemplateShellCustomizerauf "Shell" fest. Set to 'WindowsRestart' for type ImageTemplateRestartCustomizer.	"PowerShell" 'Shell' "WindowsRestart" (erforderlich)

ImageTemplateDistributor

Name	Beschreibung	Wert
artifactTags	Tags, die auf das Artefakt angewendet werden, nachdem es vom Verteiler erstellt/aktualisiert wurde.	ImageTemplateDistributorArtifactTags
runOutputName	Der Name, der für den zugeordneten RunOutput verwendet werden soll.	Schnur Zwänge: Pattern = `^[A-Za-z0-9-_]{1,64}$` (erforderlich)
Art	Set to 'ManagedImage' for type ImageTemplateManagedImageDistributor. Set to 'SharedImage' for type ImageTemplateSharedImageDistributor. Legen Sie für den Typ ImageTemplateVhdDistributorauf "VHD" fest.	"ManagedImage" "SharedImage" "VHD" (erforderlich)

ImageTemplateDistributorArtifactTags

Name	Beschreibung	Wert

ImageTemplateIsoSource

Name	Beschreibung	Wert
sha256Checksum	SHA256-Prüfsumme des ISO-Images.	Zeichenfolge (erforderlich)
sourceURI	URI zum Abrufen des ISO-Images. Dieser URI muss zum Zeitpunkt der Erstellung der Bildvorlage für den Ressourcenanbieter zugänglich sein.	Zeichenfolge (erforderlich)
Art	Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten.	"ISO" (erforderlich)

ImageTemplateManagedImageDistributor

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

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

Name	Beschreibung	Wert
Angebot	Bildangebot aus dem Azure Gallery Images.	Schnur
Verlag	Image Publisher in Azure Gallery Images.	Schnur
Sku	Bildsku aus der Azure Gallery Images.	Schnur
Art	Gibt den Typ des Quellbilds an, mit dem Sie beginnen möchten.	"PlatformImage" (erforderlich)
Version	Bildversion aus der Azure Gallery Images.	Schnur

ImageTemplatePowerShellCustomizer

Name	Beschreibung	Wert
schritthaltend	Array von auszuführenden PowerShell-Befehlen	string[]
Skript	Das PowerShell-Skript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln.	Schnur
Art	Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein	"PowerShell" (erforderlich)
validExitCodes	Gültige Exitcodes für das PowerShell-Skript. [Standard: 0]	int[]

ImageTemplateProperties

Name	Beschreibung	Wert
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)

ImageTemplateRestartCustomizer

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

ImageTemplateSharedImageDistributor

Name	Beschreibung	Wert
galleryImageId	Ressourcen-ID des Bilds "Freigegebene Bildergalerie"	Zeichenfolge (erforderlich)
replicationRegions		string[] (erforderlich)
Art	Typ der Verteilung.	"SharedImage" (erforderlich)

ImageTemplateShellCustomizer

Name	Beschreibung	Wert
schritthaltend	Array der auszuführenden Shellbefehle	string[]
Skript	Das Shellskript, das zum Anpassen ausgeführt werden soll. Es kann sich um einen GitHub-Link, SAS-URI für Azure Storage usw. handeln.	Schnur
Art	Der Typ des Anpassungstools, das Sie für das Bild verwenden möchten. Beispielsweise kann "Shell" shell customizer sein	'Shell' (erforderlich)

ImageTemplateSource

Name	Beschreibung	Wert
Art	Legen Sie für den Typ ImageTemplateIsoSourceauf "ISO" fest. Set to 'ManagedImage' for type ImageTemplateManagedImageSource. Set to 'PlatformImage' for type ImageTemplatePlatformImageSource.	"ISO" "ManagedImage" "PlatformImage" (erforderlich)

ImageTemplateVhdDistributor

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