Freigeben über

Neuerungen in Azure VM Image Builder

Gilt für: ✔️ Linux VMs ✔️ Windows VMs ✔️ Flexible Skalierungsgruppen ✔️ Einheitliche Skalierungsgruppen

Dieser Artikel enthält alle wichtigsten API-Änderungen und Funktionsupdates für den Azure VM Image Builder-Dienst.

Aktualisierungen

September 2024

Die automatische Bilderstellung über Trigger wird deaktiviert, wenn der Build der Bildvorlage mehrmals hintereinander fehlschlägt. Durch diese Deaktivierung werden unnötige Buildfehler vermieden.

Sie können die Bildvorlage weiterhin manuell erstellen. Nachdem ein manueller Build erfolgreich war, werden die automatischen Trigger reaktiviert.

Dieses Verhalten ist unabhängig davon, welche API-Version Sie für die Bildvorlagenressource verwenden.

Mai 2024

Breaking Change: Groß-/Kleinschreibung

Ab dem 21. Mai 2024 unterscheidet VM Image Builder API ab Version 2024-02-01 und höher in allen Feldern zwischen Groß- und Kleinschreibung. Die Groß-/Kleinschreibung von Buchstaben in Ihren API-Anforderungen muss exakt mit dem erwarteten Format übereinstimmen.

Wichtig

Wenn Sie ein vorhandener Benutzer des VM Image Builder sind, wirkt sich diese Änderung nicht auf Ihre vorhandenen Ressourcen aus. Die Beachtung der Groß- und Kleinschreibung gilt nur für neu erstellte Ressourcen, die API-Version 2024-02-01 und höher verwenden. Ihre vorhandenen Ressourcen funktionieren ohne Änderungen weiterhin wie erwartet.

Wenn Probleme im Zusammenhang mit der Groß-/Kleinschreibung auftreten, lesen Sie die aktualisierte Dokumentation zur VM Image Builder-API, um Anleitungen zu erhalten.

Bisher war die VM Image Builder-API im Hinblick auf den Fall eher verzeihend. In der Zukunft ist Präzision von entscheidender Bedeutung. Stellen Sie bei API-Aufrufen sicher, dass Sie die richtige Groß-/Kleinschreibung für Feldnamen, Parameter und Werte verwenden. Wenn ein Feld z. B. vmBoot genannt ist, müssen Sie vmBoot verwenden (nicht VMBoot oder vmboot).

Wenn Sie eine API-Anforderung an die VM Image Builder API Version 2024-02-01 oder höher mit falschen Feldern oder nicht erkannten Feldern senden, lehnt der Dienst sie ab. Sie erhalten eine Fehlerantwort, die angibt, dass die Anforderung ungültig ist. Der Fehler sieht ungefähr wie in diesem Beispiel aus:

Unmarshalling entity encountered error: unmarshalling type *v2024_02_01.ImageTemplate: struct field Properties: unmarshalling type *v2024_02_01.ImageTemplateProperties: struct field Optimize: unmarshalling type *v2024_02_01.ImageTemplatePropertiesOptimize: unmarshalling type *v2024_02_01.ImageTemplatePropertiesOptimize, unknown field \"vmboot\". There is an issue with the syntax with the JSON template you are submitting. Please check the JSON template for syntax and grammar. For more information on the syntax and grammar of the JSON template, visit http://aka.ms/azvmimagebuildertmplref.

Die Fehlermeldung erwähnt ein "unbekanntes Feld" und leitet Sie zur offiziellen Dokumentation weiter: Erstellen Sie eine JSON-Vorlage für azure VM Image Builder Bicep oder Azure Resource Manager.

Hinweis

Wenn Sie API-Aufrufe an den VM Image Builder-Dienst tätigen, verweisen Sie immer auf die Swagger-Dokumentation. Diese Dokumentation dient als endgültige Quelle der Wahrheit für VM Image Builder-API-Spezifikationen. Obwohl die öffentliche Dokumentation aktualisiert wurde, um die richtigen Großschreibungs- und Feldnamen vor der API-Veröffentlichung einzuschließen, enthält die Swagger-Definition genaue Details zu jeder VM Image Builder-API. Diese Details helfen sicherzustellen, dass Sie Anrufe an den Dienst ordnungsgemäß tätigen.

Die folgenden Dokumentationsänderungen wurden vorgenommen, um den Feldnamen in API Version 2024-02-01 zu entsprechen.

In der Dokumentation zum Erstellen einer Azure VM Image Builder Bicep- oder Azure Resource Manager-JSON-Vorlage :

  • Aktualisierte Felder:

    • Ersetzen mehrerer Erwähnungen von vmboot durch vmBoot.
    • Eine Erwähnung von imageVersionID wurde durch imageVersionId ersetzt.

  • Feld entfernt:

    • apiVersion: Es wird empfohlen, die Einbeziehung dieses Felds in Ihre Anforderungen zu vermeiden, da es nicht explizit in der API angegeben ist. Das Einschließen in Ihre JSON-Vorlage kann zu Fehlern in Ihrem Imagebuild führen.

In der Dokumentation zu Azure VM Image Builder-Netzwerkoptionen:

  • Feld aktualisiert:

    • Eine Erwähnung von VirtualNetworkConfig wurde durch vnetConfig ersetzt.

  • Entfernte Felder

    • subnetName in der vnetConfig Eigenschaft: Dieses Feld ist veraltet. Das neue Feld ist subnetId.
    • resourceGroupName in der vnetConfig Eigenschaft: Dieses Feld ist veraltet. Das neue Feld ist subnetId.

Festlegen auf eine ältere VM-Image-Builder-API-Version

Wenn Sie aufgrund der neuen Regeln für die Groß-/Kleinschreibung keine Änderungen an den Eigenschaften in Ihren Imagevorlagen vornehmen möchten, haben Sie die Möglichkeit, Ihre Azure VM Image Builder-API-Aufrufe an eine frühere API-Version anzuheften. Mit dem Anheften können Sie das vertraute Verhalten ohne Änderungen weiterhin verwenden.

Wichtig

Das Anheften an eine ältere VM Image Builder-API-Version kann Kompatibilität mit Ihren vorhandenen Vorlagen bieten. Wir empfehlen dies jedoch aufgrund der folgenden Faktoren nicht:

  • Ältere API-Versionen sind möglicherweise veraltet.
  • Durch das Anheften an eine ältere API-Version verpassen Sie die neuesten Features und Verbesserungen, die in neueren Versionen eingeführt wurden. Diese Verbesserungen verbessern häufig die Leistung, Sicherheit und Funktionalität.

Um die Kompatibilität mit ihren vorhandenen Vorlagen beim Erstellen oder Aktualisieren einer Bildvorlage sicherzustellen, geben Sie die gewünschte API-Version an, indem Sie den api-version Parameter in Ihren Dienstaufruf einschließen. Beispiel:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VirtualMachineImages/imageTemplates/{imageTemplateName}?api-version=2022-07-01

Testen Ihres Codes

Nachdem Sie sich auf die ältere API-Version festgelegt haben, testen Sie Ihren Code, um zu überprüfen, ob er sich wie erwartet verhält. Stellen Sie sicher, dass Ihre vorhandenen Vorlagen weiterhin ordnungsgemäß funktionieren.

November 2023

VM Image Builder ermöglicht schrittweise isolierte Image-Erstellungen über Azure-Containerinstanzen. Der Rollout soll bis Anfang 2024 abgeschlossen sein. Ihre bestehenden Bildvorlagen funktionieren kontinuierlich, und es gibt keine Änderung dabei, wie Sie neue Bildvorlagen erstellen.

Möglicherweise beobachten Sie, dass in der Staging-Ressourcengruppe eine andere Reihe temporärer Azure-Ressourcen angezeigt wird. Sie wirkt sich nicht auf Ihre tatsächlichen Builds oder die Art und Weise aus, wie Sie mit vm Image Builder interagieren. Weitere Informationen zu isolierten Imagebuilds finden Sie hier.

Um isolierte Imagebuilds zu verwenden, stellen Sie sicher, dass:

  • Ihr Abonnement ist für den Microsoft.ContainerInstance Anbieter registriert.
  • Es gibt keine Richtlinien, die die Bereitstellung von Azure Container Instances-Ressourcen blockieren.
  • das Kontingent für Azure Container Instances-Ressourcen verfügbar ist.

April 2023

Neue Portalfunktionen wurden für vm Image Builder hinzugefügt. Suchen Sie im Azure-Portal nach Bildvorlagen , und wählen Sie dann "Erstellen" aus. Sie können diese Vorlagenkonfiguration auch verwenden, um mit dem Erstellen und Validieren von benutzerdefinierten Bildern im Portal zu beginnen.

API-Releases

Version 2024-02-01

Verbesserungen

  • Sie können die neue autoRun Eigenschaft verwenden, um den Imagebuild für die Erstellung oder Aktualisierung von Vorlagen auszuführen. Weitere Informationen finden Sie unter Eigenschaften: autoRun.

  • Sie können die neue managedResourceTags Eigenschaft verwenden, um Tags auf die Ressourcen anzuwenden, die der VM Image Builder-Dienst während des ImageBuilds in der Stagingressourcengruppe erstellt. Weitere Informationen finden Sie unter Eigenschaften: managedResourceTags.

  • Mit der neuen containerInstanceSubnetId Eigenschaft können Sie ein Subnetz angeben, in dem Azure-Containerinstanzen für isolierte Imagebuilds bereitgestellt werden. Sie können dieses Feld nur angeben, wenn Sie angeben subnetId. Dieses Eingabefeld muss sich im selben virtuellen Netzwerk wie das angegebene subnetIdSubnetz befinden. Weitere Informationen finden Sie unter Bringen Sie Ihr eigenes Build-VM-Subnetz und bringen Sie Ihr eigenes Container-Instanzen-Subnetz mit.

  • Diese Version fügt Unterstützung für die Aktualisierung der vmProfile Eigenschaft hinzu, einschließlich der folgenden Felder:

    • vmSize
    • osDiskSizeGB
    • userAssignedIdentities
    • vnetConfig
      • subnetId
      • containerInstanceSubnetId

    Weitere Informationen zur vmProfile Eigenschaft finden Sie unter vmProfile.

Änderungen

In API-Version 2024-02-01 wird ein Breaking Change eingeführt, der die Groß-/Kleinschreibung für alle Felder erzwingt. Die Groß-/Kleinschreibung von Buchstaben in Ihren API-Anforderungen muss exakt mit dem erwarteten Format übereinstimmen. Wenn Sie eine API-Anforderung an die VM Image Builder API Version 2024-02-01 oder höher mit einem falschen Fall oder nicht erkannten Feldern senden, lehnt der Dienst sie ab. Sie erhalten eine Fehlerantwort, die angibt, dass die Anforderung ungültig ist. Weitere Informationen finden Sie unter Breaking Change: Groß-/Kleinschreibung in diesem Artikel.

Version 2023-07-01

Änderungen

Die neue errorHandling Eigenschaft bietet Ihnen mehr Kontrolle darüber, wie Fehler während des Imageerstellungsprozesses behandelt werden. Weitere Informationen finden Sie unter errorHandling.

Version 2022-07-01

Verbesserungen

  • Diese Version bietet Unterstützung für die Verwendung der neuesten Bildversion, die in azure Compute Gallery als Quelle für die Bildvorlage gespeichert ist.
  • Diese Version fügt versioning hinzu, um das Generieren von Versionsnummern für Bildverteilungen zu unterstützen. Weitere Informationen finden Sie unter Eigenschaften: versioning.
  • Diese Version fügt Unterstützung für die Konfiguration je Region hinzu, wenn Sie in der Azure Compute Gallery verteilen. Weitere Informationen finden Sie unter "Distribute: targetRegions".
  • Diese Version fügt einen neuen File Überprüfungstyp hinzu. Weitere Informationen finden Sie unter Eigenschaften: validate.
  • Sie können virtuelle Festplatten (VHDs) jetzt in einem benutzerdefinierten Blob oder Container in einem benutzerdefinierten Speicherkonto verteilen. Weitere Informationen finden Sie unter Verteilen: VHD.
  • Diese Version fügt die Unterstützung für die Verwendung eines direkt freigegebenen Katalog-Images als Quelle für die Bildvorlage hinzu.

Änderungen

Version 2022-02-14

Verbesserungen

Fassung vom 01.10.2021

Einschneidende Änderung

Mit der API-Version 2021-10-01 wurde eine Änderung am Fehlerschema eingeführt, die für alle künftigen API-Releases gilt. Falls Sie über Azure VM Image Builder-Automatisierungen verfügen, beachten Sie die neue Fehlerausgabe, wenn Sie zur API-Version 2021-10-01 oder höher wechseln.

Wir empfehlen, nach dem Wechsel zur neuesten API-Version, dass Sie nicht zu einer früheren Version zurückkehren. Wenn Sie zurückkehren, müssen Sie Ihre Automatisierung erneut ändern, um das frühere Fehlerschema zu erzeugen. Wir erwarten nicht, dass das Fehlerschema in zukünftigen Versionen erneut geändert wird.

Fehlerausgabe für Version 2020-02-14 und früher
{ 
  "code": "ValidationFailed",
  "message": "Validation failed: 'ImageTemplate.properties.source': Field 'imageId' has a bad value: '/subscriptions/subscriptionID/resourceGroups/resourceGroupName/providers/Microsoft.Compute/images/imageName'. Please review  http://aka.ms/azvmimagebuildertmplref  for details on fields requirements in the Image Builder Template." 
}
Fehlerausgabe für Version 2021-10-01 und höher
{ 
  "error": {
    "code": "ValidationFailed", 
    "message": "Validation failed: 'ImageTemplate.properties.source': Field 'imageId' has a bad value: '/subscriptions/subscriptionID/resourceGroups/resourceGroupName/providers/Microsoft.Compute/images/imageName'. Please review  http://aka.ms/azvmimagebuildertmplref  for details on fields requirements in the Image Builder Template." 
  }
}

Verbesserungen

Version 2020-02-14

Verbesserungen

  • Unterstützung für das Erstellen von Images aus den folgenden Quellen hinzugefügt:
    • Verwaltetes Image
    • Azure-Computergalerie
    • Platform Image Repository (einschließlich Platform Image Purchase Plan)
  • Unterstützung für die folgenden Anpassungen hinzugefügt:
    • Shell (Linux) – Skript oder Inline
    • PowerShell (Windows) – Skript oder Inline, Ausführung mit erhöhten Rechten, Ausführung als System
    • Datei (Linux und Windows)
    • Windows-Neustart (Windows)
    • Windows-Update (Windows): Suchkriterien, Filter und Updatelimit
  • Unterstützung für die folgenden Verteilungstypen hinzugefügt:
    • VHD
    • Verwaltetes Image
    • Azure-Computergalerie
  • Unterstützung für Kunden hinzugefügt, um ihr eigenes virtuelles Netzwerk zu verwenden.
  • Unterstützung für Kunden zum Anpassen der Build-VM (VM-Größe, Betriebssystemdatenträgergröße) hinzugefügt.
  • Unterstützung für vom Benutzer zugewiesene verwaltete Identitäten hinzugefügt (zum Anpassen/Verteilen von Schritten).
  • Unterstützung für Bilder der Generation 2 hinzugefügt.

Vorschau-API

Die folgende API ist veraltet, wird aber weiterhin unterstützt:

  • Version 2019-05-01-vorschau

Verwandte Inhalte

  • Last updated on