Dela via

Nyheter i Azure VM Image Builder

  • Artikel

Gäller för: ✔️ Virtuella Linux-datorer ✔️ med virtuella Windows-datorer ✔️ – flexibla skalningsuppsättningar ✔️ Enhetliga skalningsuppsättningar

Den här artikeln innehåller alla större API-ändringar och funktionsuppdateringar för Tjänsten Azure VM Image Builder (AIB).

Uppdateringar

Maj 2024

Icke-bakåtkompatibel ändring: Skiftlägeskänslighet

Från och med den 21 maj 2024 tillämpar Azure VM Image Builder API version 2024-02-01 och senare skiftlägeskänslighet för alla fält. Det innebär att versaler i dina API-begäranden måste matcha exakt med det förväntade formatet.

Viktigt!

Viktigt för befintliga Azure Image Builder-användare

Om du är en befintlig användare av Azure VM Image Builder kan du vara säker på att den här ändringen inte påverkar dina befintliga resurser. Tvingande av skiftlägeskänslighet gäller endast för nyligen skapade resurser med hjälp av API-version 2024-02-01 och senare. Dina befintliga resurser fortsätter att fungera som förväntat utan några ändringar.

Om du stöter på problem som rör skiftlägeskänslighet kan du läsa mer i Azure Image Builder uppdaterade API-dokumentation.

Tidigare var Azure Image Builder-API:et mer förlåtande när det gäller fall, men framöver är precision avgörande. När du gör API-anrop kontrollerar du att du använder rätt versaler för fältnamn, parametrar och värden. Om ett fält till exempel heter "vmBoot" måste du använda "vmBoot" (inte "VMBoot" eller "vmboot").

Om du skickar en API-begäran till Azure Image Builder API version 2024-02-01 och senare med felaktiga skiftläge eller okända fält avvisar tjänsten den. Du får ett felmeddelande som anger att begäran är ogiltig. Felet ser ut ungefär så här:

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.

Felmeddelandet anger ett "okänt fält" och leder dig till den officiella dokumentationen: Skapa en JSON-mall för Azure Image Builder Bicep eller ARM-mall.

Kommentar

Referera till Azure Image Builder's Swagger för API-anrop

När du gör anrop till Azure Image Builder-tjänsten ska du alltid referera till Swagger-dokumentationen, som fungerar som den slutgiltiga sanningskällan för Api-specifikationerna för Azure Image Builder. Den offentliga dokumentationen har uppdaterats så att den innehåller rätt versaler och fältnamn före API-versionen, men Swagger-definitionen innehåller exakt information om varje AIB-API för att säkerställa att du gör anrop till tjänsten korrekt.

Nedan visas en lista över de dokumentationsändringar som har gjorts för att matcha fältnamnen i API-version 2024-02-01:

I JSON-malldokumentationen Skapa en Azure Image Builder Bicep- eller ARM-mall :

Fält uppdaterade:

  • Ersatte flera omnämnanden av vmboot med vmBoot
  • Ersatte ett omnämnande av imageVersionID med imageVersionId

Fältet har tagits bort:

  • apiVersion: Vi rekommenderar att du undviker att inkludera det här fältet i dina begäranden eftersom det inte uttryckligen anges i vårt API, så att inkludera det i JSON-mallen kan leda till fel i avbildningsversionen.

I dokumentationen för Azure VM Image Builder-nätverksalternativ :

Fältet har uppdaterats:

  • Ersatte ett omnämnande av VirtualNetworkConfig med vnetConfig

Fält har tagits bort:

  • subnetName i egenskapen vnetConfig – det här fältet är inaktuellt och det nya fältet är subnetId
  • resourceGroupName i egenskapen vnetConfig – det här fältet är inaktuellt och det nya fältet är subnetId

Så här fäster du på en äldre Azure Image Builder API-version

Viktigt att tänka på när du fäster vid äldre API-versioner

Att fästa på en äldre Azure Image Builder API-version kan ge kompatibilitet med dina befintliga mallar, men det rekommenderas inte på grund av följande faktorer:

  • Utfasningsrisk: Äldre API-versioner kan så småningom bli inaktuella.

  • Saknade funktioner: Genom att fästa på en äldre API-version går du miste om de senaste funktionerna och förbättringarna som introduceras i nyare versioner. Dessa förbättringar förbättrar ofta prestanda, säkerhet och funktioner.

Om du vill undvika att göra ändringar i egenskaperna i dina avbildningsmallar på grund av de nya reglerna för skiftlägeskänslighet har du möjlighet att fästa api-anropen för Azure VM Image Builder till en tidigare API-version. På så sätt kan du fortsätta att använda det välbekanta beteendet utan några ändringar.

För att säkerställa kompatibilitet med dina befintliga mallar anger du den önskade API-versionen (t.ex. api-version=2022-07-01) när du skapar eller uppdaterar en avbildningsmall genom att inkludera parametern api-version i anropet till tjänsten. Exempel:

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

Testa din kod

När du har fäst den äldre API-versionen testar du koden för att kontrollera att den fungerar som förväntat. Se till att dina befintliga mallar fortsätter att fungera korrekt.

November 2023

Azure Image Builder aktiverar isolerade avbildningsversioner med hjälp av Azure Container Instances stegvis. Distributionen förväntas vara klar i början av 2024. Dina befintliga avbildningsmallar fortsätter att fungera och det sker ingen ändring i hur du skapar eller skapar nya avbildningsmallar.

Du kan se en annan uppsättning tillfälliga Azure-resurser visas tillfälligt i resursgruppen för mellanlagring, men det påverkar inte dina faktiska versioner eller hur du interagerar med Azure Image Builder. Mer information finns i Isolerade avbildningsversioner.

Viktigt!

Kontrollera att din prenumeration är registrerad för providern Microsoft.ContainerInstance och att det inte finns några principer som blockerar distributionen av Azure Container Instances-resurser. Se också till att kvoten är tillgänglig för Azure Container Instances-resurser.

April 2023

Nya portalfunktioner har lagts till för Azure Image Builder. Sök efter "Bildmallar" i Azure-portalen och klicka sedan på "Skapa". Du kan också komma igång här med att skapa och verifiera anpassade avbildningar i portalen.

API-versioner

Version 2024-02-01

Förbättringar

  • Ny autoRun egenskap som gör att du kan köra avbildningsversionen när mallen skapas eller uppdateras. Mer information finns i Egenskaper: autoKör.
  • Ny managedResourceTags egenskap som gör att du kan använda taggar för de resurser som Azure Image Builder-tjänsten skapar i mellanlagringsresursgruppen under avbildningsversionen. Mer information finns i Egenskaper: managedResourceTags.
  • Ny containerInstanceSubnetId egenskap som gör att du kan ange ett undernät där Azure Container Instance ska distribueras för isolerade versioner. Det här fältet kan endast anges om subnetId det också anges och måste finnas i samma virtuella nätverk som det undernät som anges i subnetId. Mer information finns i Bring your own Build VM subnet and bring your own ACI subnet (Bring your own Build VM subnet and bring your own ACI subnet).
  • Stöd har lagts till för att uppdatera vmProfile egenskapen, inklusive följande fält:
    • vmSize
    • osDiskSizeGB
    • userAssignedIdentities
    • vnetConfig

Ändringar i API-version 2024-02-01 medför en icke-bakåtkompatibel ändring som framtvingar skiftlägeskänslighet för alla fält. Det innebär att versaler i dina API-begäranden måste matcha exakt med det förväntade formatet. Om du skickar en API-begäran till Azure Image Builder API version 2024-02-01 och senare med felaktiga skiftläge eller okända fält avvisar tjänsten den. Du får ett felmeddelande som anger att begäran är ogiltig. Mer information finns i Icke-bakåtkompatibel ändring: Skiftlägeskänslighet.

Version 2023-07-01

Kommer snart

Stöd för uppdatering av distributionsmål för Azure Compute Gallery.

Ändringar

Ny errorHandling egenskap. Den här egenskapen ger användarna mer kontroll över hur fel hanteras under bildskapandeprocessen. Mer information finns i errorHandling

Version 2022-07-01

Förbättringar

  • Stöd har lagts till för att använda den senaste avbildningsversionen som lagras i Azure Compute Gallery som källa för avbildningsmallen
  • Har lagts versioning till för att generera versionsnummer för avbildningsdistributioner. Mer information finns i egenskaper: versionshantering
  • Stöd har lagts till för konfiguration per region när du distribuerar till Azure Compute Gallery. Mer information finns i Distribuera:targetRegions
  • Ny valideringstyp för fil har lagts till. Mer information finns i verifiera egenskaper
  • Virtuella hårddiskar kan nu distribueras till en anpassad blob eller container i ett anpassat lagringskonto. Mer information finns i Distribuera: VHD
  • Stöd har lagts till för att använda en direkt delad galleribild som källa för bildmallen

Ändringar

  • replicationRegions är nu inaktuell för galleridistributioner. Mer information finns i gallery-replicated-regions
  • Virtuella hårddiskar kan nu distribueras till en anpassad blob eller container i ett anpassat lagringskonto
  • targetRegions matrisen har lagts till och endast tillämpats på "SharedImage"-typen distribuera. Mer information om targetRegionsfinns i Azure Compute Gallery
  • Stöd har lagts till för att använda en direkt delad galleribild som källa för avbildningsmallen. Direct Shared Gallery är för närvarande i förhandsversion.
  • Utlösare är nu tillgängliga i offentlig förhandsversion för att konfigurera automatiska avbildningsversioner. Mer information finns i Använda AIB-utlösare

Version 2022-02-14

Förbättringar

Version 2021-10-01

Icke-bakåtkompatibel ändring

API-version 2021-10-01 introducerar en ändring av felschemat som kommer att ingå i varje framtida API-version. Om du har några Azure VM Image Builder-automatiseringar bör du vara medveten om de nya felutdata när du växlar till API-version 2021-10-01 eller senare. När du har bytt till den senaste API-versionen rekommenderar vi att du inte återgår till en tidigare version, eftersom du måste ändra automatiseringen igen för att skapa det tidigare felschemat. Vi förväntar oss inte att vi kommer att ändra felschemat igen i framtida versioner.

Felutdata för version 2020-02-14 och tidigare
{ 
  "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." 
}
Felutdata för version 2021-10-01 och senare
{ 
  "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." 
  }
}

Förbättringar

Version 2020-02-14

Förbättringar

  • Stöd har lagts till för att skapa avbildningar från följande källor:
    • Hanterad avbildning
    • Azure Compute Gallery
    • Plattformsbildlagringsplats (inklusive plattformsbildköpsplan)
  • Stöd har lagts till för följande anpassningar:
    • Shell (Linux): Skript eller infogat
    • PowerShell (Windows): Skript eller infogad, kör upphöjd, kör som system
    • Fil (Linux och Windows)
    • Omstart av Windows (Windows)
    • Windows Update (Windows): Sökvillkor, filter och uppdateringsgräns
  • Stöd har lagts till för följande distributionstyper:
    • VHD (virtuell hårddisk)
    • Hanterad avbildning
    • Azure Compute Gallery
  • Andra funktioner:
    • Stöd har lagts till för kunder att använda sitt eget virtuella nätverk
    • Stöd har lagts till för kunder för att anpassa den virtuella datorn (VM-storlek, operativsystemdiskstorlek)
    • Stöd har lagts till för användartilldelade Microsoft Windows Installer (MSI) (för att anpassa/distribuera steg)
    • Stöd för Gen2-avbildningar har lagts till

Förhandsversions-API:er

Följande API:er är inaktuella, men stöds fortfarande:

  • Version 2019-05-01-preview

Nästa steg

Läs mer om VM Image Builder.