Microsoft.VirtualMachineImages imageTemplates

Artikel
12/17/2024

Bicep-resursdefinition

Resurstypen imageTemplates kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.VirtualMachineImages/imageTemplates-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2024-02-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    autoRun: {
      state: 'string'
    }
    buildTimeoutInMinutes: int
    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
      }
    ]
    errorHandling: {
      onCustomizerError: 'string'
      onValidationError: 'string'
    }
    managedResourceTags: {
      {customized property}: 'string'
    }
    optimize: {
      vmBoot: {
        state: 'string'
      }
    }
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    stagingResourceGroup: 'string'
    validate: {
      continueDistributeOnFailure: bool
      inVMValidations: [
        {
          name: 'string'
          type: 'string'
          // For remaining properties, see ImageTemplateInVMValidator objects
        }
      ]
      sourceValidationOnly: bool
    }
    vmProfile: {
      osDiskSizeGB: int
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        containerInstanceSubnetId: 'string'
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

DistribueraVersioner-objekt

Ange -schemat egenskapen för att ange typ av objekt.

För senasteanvänder du:

{
  major: int
  scheme: 'Latest'
}

För Sourceanvänder du:

{
  scheme: 'Source'
}

ImageTemplateDistributor-objekt

Ange egenskapen typ för att ange typ av objekt.

För ManagedImageanvänder du:

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

För SharedImageanvänder du:

{
  excludeFromLatest: bool
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]
  storageAccountType: 'string'
  targetRegions: [
    {
      name: 'string'
      replicaCount: int
      storageAccountType: 'string'
    }
  ]
  type: 'SharedImage'
  versioning: {
    scheme: 'string'
    // For remaining properties, see DistributeVersioner objects
  }
}

För VHD-använder du:

{
  type: 'VHD'
  uri: 'string'
}

ImageTemplateSource-objekt

Ange egenskapen typ för att ange typ av objekt.

För ManagedImageanvänder du:

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

För PlatformImageanvänder du:

{
  offer: 'string'
  planInfo: {
    planName: 'string'
    planProduct: 'string'
    planPublisher: 'string'
  }
  publisher: 'string'
  sku: 'string'
  type: 'PlatformImage'
  version: 'string'
}

För SharedImageVersionanvänder du:

{
  imageVersionId: 'string'
  type: 'SharedImageVersion'
}

ImageTemplateInVMValidator-objekt

Ange egenskapen typ för att ange typ av objekt.

För Fileanvänder du:

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

För PowerShell-använder du:

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

För Shell-använder du:

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

ImageTemplateCustomizer-objekt

Ange egenskapen typ för att ange typ av objekt.

För Fileanvänder du:

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

För PowerShell-använder du:

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

För Shell-använder du:

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

För WindowsRestartanvänder du:

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

För WindowsUpdateanvänder du:

{
  filters: [
    'string'
  ]
  searchCriteria: 'string'
  type: 'WindowsUpdate'
  updateLimit: int
}

Egenskapsvärden

DistribueraVersioner

Namn	Beskrivning	Värde
schema	Ange till "Senaste" för typen DistributeVersionerLatest. Ange till "Källa" för typen DistributeVersionerSource.	"Senaste" "Källa" (krävs)

DistributeVersionerLatest

Namn	Beskrivning	Värde
major	Huvudversion för det genererade versionsnumret. Ta reda på vad som är "senaste" baserat på versioner med det här värdet som huvudversion. -1 motsvarar att lämna den oet.	Int Begränsningar: Minsta värde = -1
schema	Versionsnumreringsschema som ska användas.	"Senaste" (krävs)

DistribueraVersionerSource

Namn	Beskrivning	Värde
schema	Versionsnumreringsschema som ska användas.	"Källa" (krävs)

ImageTemplateAutoRun

Namn	Beskrivning	Värde
stat	Om du aktiverar det här fältet utlöses en automatisk version av skapande eller uppdatering av avbildningsmallar.	"Inaktiverad" "Aktiverad"

ImageTemplateCustomizer

Namn	Beskrivning	Värde
Namn	Eget namn för att ge kontext för vad det här anpassningssteget gör	sträng
typ	Ange till "Arkiv" för typen ImageTemplateFileCustomizer. Ange till PowerShell för typen ImageTemplatePowerShellCustomizer. Ange till "Shell" för typen ImageTemplateShellCustomizer. Ange till "WindowsRestart" för typ ImageTemplateRestartCustomizer. Ange till "WindowsUpdate" för typ ImageTemplateWindowsUpdateCustomizer.	"Fil" "PowerShell" "Shell" "WindowsRestart" "WindowsUpdate" (krävs)

ImageTemplateDistributor

Namn	Beskrivning	Värde
artifactTags	Taggar som ska tillämpas på artefakten när den har skapats/uppdaterats av distributören.	ImageTemplateDistributorArtifactTags
runOutputName	Namnet som ska användas för det associerade RunOutput.	sträng Begränsningar: Mönster = `^[A-Za-z0-9-_.]{1,64}$` (krävs)
typ	Ange till "ManagedImage" för typen ImageTemplateManagedImageDistributor. Ange till "SharedImage" för typen ImageTemplateSharedImageDistributor. Ange till "VHD" för typen ImageTemplateVhdDistributor.	"ManagedImage" "SharedImage" "VHD" (krävs)

ImageTemplateDistributorArtifactTags

Namn	Beskrivning	Värde

ImageTemplateFileCustomizer

Namn	Beskrivning	Värde
destination	Den absoluta sökvägen till en fil (med kapslade katalogstrukturer som redan har skapats) där filen (från sourceUri) laddas upp till på den virtuella datorn	sträng
sha256Checksum	SHA256-kontrollsumma för filen som anges i sourceUri-fältet ovan	sträng
sourceUri	URI:n för filen som ska laddas upp för att anpassa den virtuella datorn. Det kan vara en github-länk, SAS-URI för Azure Storage osv.	sträng
typ	Den typ av anpassningsverktyg som du vill använda på bilden. Till exempel kan "Shell" vara gränssnittsanpassare	"Fil" (krävs)

ImageTemplateFileValidator

Namn	Beskrivning	Värde
destination	Den absoluta sökvägen till en fil (med kapslade katalogstrukturer som redan har skapats) där filen (från sourceUri) laddas upp till på den virtuella datorn	sträng
sha256Checksum	SHA256-kontrollsumma för filen som anges i sourceUri-fältet ovan	sträng
sourceUri	URI:n för filen som ska laddas upp till den virtuella datorn för validering. Det kan vara en github-länk, Azure Storage-URI (auktoriserad eller SAS) osv.	sträng
typ	Den typ av validering som du vill använda på avbildningen. Till exempel kan "Shell" vara shell-validering	"Fil" (krävs)

ImageTemplateIdentity

Namn	Beskrivning	Värde
typ	Den typ av identitet som används för bildmallen. Typen "Ingen" tar bort alla identiteter från bildmallen.	"Ingen" "UserAssigned"
userAssignedIdentities	Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.	UserAssignedIdentiteter

ImageTemplateInVMValidator

Namn	Beskrivning	Värde
Namn	Eget namn för att ge kontext för vad det här valideringssteget gör	sträng
typ	Ange till "Arkiv" för typen ImageTemplateFileValidator. Ange till PowerShell för typen ImageTemplatePowerShellValidator. Ange till "Shell" för typen ImageTemplateShellValidator.	"Fil" "PowerShell" "Shell" (krävs)

ImageTemplateManagedImageDistributor

Namn	Beskrivning	Värde
imageId	Resurs-ID för managed disk-avbildningen	sträng (krävs)
plats	Azure-platsen för avbildningen ska matcha om avbildningen redan finns	sträng (krävs)
typ	Typ av distribution.	"ManagedImage" (krävs)

ImageTemplateManagedImageSource

Namn	Beskrivning	Värde
imageId	ARM-resurs-ID för den hanterade avbildningen i kundprenumeration	sträng (krävs)
typ	Anger vilken typ av källbild du vill börja med.	"ManagedImage" (krävs)

ImageTemplatePlatformImageSource

Namn	Beskrivning	Värde
erbjudande	Bilderbjudande från Azure Gallery Images.	sträng
planInfo	Valfri konfiguration av inköpsplan för plattformsbild.	PlatformImagePurchasePlan
förläggare	Image Publisher i Azure Gallery Images.	sträng
Sku	Bild-SKU från Azure Gallery Images.	sträng
typ	Anger vilken typ av källbild du vill börja med.	"PlatformImage" (krävs)
version	Bildversion från Azure Gallery Images. Om "senaste" anges här utvärderas versionen när avbildningsversionen äger rum, inte när mallen skickas.	sträng

ImageTemplatePowerShellCustomizer

Namn	Beskrivning	Värde
Inline	Matris med PowerShell-kommandon som ska köras	string[]
runAsSystem	Om det anges körs PowerShell-skriptet med förhöjd behörighet med hjälp av den lokala systemanvändaren. Kan bara vara sant när fältet runElevated ovan är inställt på true.	Bool
runElevated	Om det anges körs PowerShell-skriptet med förhöjd behörighet	Bool
scriptUri	URI för PowerShell-skriptet som ska köras för anpassning. Det kan vara en github-länk, SAS-URI för Azure Storage osv.	sträng
sha256Checksum	SHA256-kontrollsumma för power shell-skriptet som anges i fältet scriptUri ovan	sträng
typ	Den typ av anpassningsverktyg som du vill använda på bilden. Till exempel kan "Shell" vara gränssnittsanpassare	"PowerShell" (krävs)
validExitCodes	Giltiga slutkoder för PowerShell-skriptet. [Standard: 0]	int[]

ImageTemplatePowerShellValidator

Namn	Beskrivning	Värde
Inline	Matris med PowerShell-kommandon som ska köras	string[]
runAsSystem	Om det anges körs PowerShell-skriptet med förhöjd behörighet med hjälp av den lokala systemanvändaren. Kan bara vara sant när fältet runElevated ovan är inställt på true.	Bool
runElevated	Om det anges körs PowerShell-skriptet med förhöjd behörighet	Bool
scriptUri	URI för PowerShell-skriptet som ska köras för validering. Det kan vara en github-länk, Azure Storage-URI osv.	sträng
sha256Checksum	SHA256-kontrollsumma för power shell-skriptet som anges i fältet scriptUri ovan	sträng
typ	Den typ av validering som du vill använda på avbildningen. Till exempel kan "Shell" vara shell-validering	"PowerShell" (krävs)
validExitCodes	Giltiga slutkoder för PowerShell-skriptet. [Standard: 0]	int[]

ImageTemplateProperties

Namn	Beskrivning	Värde
autoRun	Anger om avbildningsmallen ska köras automatiskt när mallen skapas eller uppdateras.	ImageTemplateAutoRun
buildTimeoutInMinutes	Maximal väntetid när du skapar avbildningsmallen (omfattar alla anpassningar, optimering, valideringar och distributioner). Utelämna eller ange 0 för att använda standardvärdet (4 timmar).	Int Begränsningar: Minsta värde = 0 Maxvärde = 960
anpassa	Anger de egenskaper som används för att beskriva anpassningsstegen för bilden, till exempel Bildkälla osv.	ImageTemplateCustomizer[]
distribuera	Distributionen riktar sig till de avbildningsutdata som ska gå till.	ImageTemplateDistributor[] (krävs)
errorHandling	Felhanteringsalternativ vid ett byggfel	ImageTemplatePropertiesErrorHandling
managedResourceTags	Taggar som ska tillämpas på resursgruppen och/eller resurserna som skapas av tjänsten.	ImageTemplatePropertiesManagedResourceTags
optimera	Anger optimering som ska utföras på bilden.	ImageTemplatePropertiesOptimize
källa	Anger de egenskaper som används för att beskriva källbilden.	ImageTemplateSource (krävs)
stagingResourceGroup	Mellanlagringsresursgruppens ID i samma prenumeration som avbildningsmallen som ska användas för att skapa avbildningen. Om det här fältet är tomt skapas en resursgrupp med ett slumpmässigt namn. Om resursgruppen som anges i det här fältet inte finns skapas den med samma namn. Om den angivna resursgruppen finns måste den vara tom och i samma region som bildmallen. Den skapade resursgruppen tas bort under borttagningen av mallen om det här fältet är tomt eller om den angivna resursgruppen inte finns, men om den angivna resursgruppen finns tas resurserna som skapats i resursgruppen bort under borttagningen av mallen och själva resursgruppen blir kvar.	sträng
validera	Konfigurationsalternativ och lista över valideringar som ska utföras på den resulterande avbildningen.	ImageTemplatePropertiesValidate
vmProfile	Beskriver hur den virtuella datorn har konfigurerats för att skapa avbildningar	ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Namn	Beskrivning	Värde
onCustomizerError	Om det finns ett anpassningsfel och fältet är inställt på "rensning" rensas den virtuella datorn och associerade nätverksresurser. Det här är standardbeteendet. Om det finns ett anpassningsfel och fältet är inställt på "abort" bevaras den virtuella byggdatorn.	"avbryt" "rensning"
onValidationError	Om det finns ett verifieringsfel och fältet är inställt på "rensning" rensas den virtuella datorn och associerade nätverksresurser. Det här är standardbeteendet. Om det finns ett verifieringsfel och fältet är inställt på "abort" bevaras den virtuella byggdatorn.	"avbryt" "rensning"

ImageTemplatePropertiesManagedResourceTags

Namn	Beskrivning	Värde

ImageTemplatePropertiesOptimize

Namn	Beskrivning	Värde
vmBoot	Optimering tillämpas på avbildningen för en snabbare vm-start.	ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Namn	Beskrivning	Värde
stat	Om du aktiverar det här fältet förbättras starttiden för virtuella datorer genom att optimera de slutliga anpassade avbildningsutdata.	"Inaktiverad" "Aktiverad"

ImageTemplatePropertiesValidate

Namn	Beskrivning	Värde
continueDistributeOnFailure	Om verifieringen misslyckas och fältet är inställt på false distribueras inte utdatabilder. Det här är standardbeteendet. Om verifieringen misslyckas och det här fältet är inställt på sant distribueras utdatabilder fortfarande. Använd det här alternativet med försiktighet eftersom det kan leda till att felaktiga bilder distribueras för användning. I båda fallen (sant eller falskt) rapporteras avbildningskörningen från slutpunkt till slutpunkt att ha misslyckats i händelse av ett valideringsfel. [Obs! Det här fältet har ingen effekt om valideringen lyckas.]	Bool
inVMValidations	Lista över valideringar som ska utföras.	ImageTemplateInVMValidator[]
sourceValidationOnly	Om det här fältet är inställt på true verifieras den bild som anges i avsnittet "källa" direkt. Ingen separat version körs för att generera och validera sedan en anpassad avbildning.	Bool

ImageTemplateRestartCustomizer

Namn	Beskrivning	Värde
restartCheckCommand	Kommando för att kontrollera om omstarten lyckades [Standard: '']	sträng
restartCommand	Kommando för att köra omstarten [Standard: 'shutdown /r /f /t 0 /c "packer restart"']	sträng
restartTimeout	Tidsgränsen för omstart anges som en storlekssträng och enhet, t.ex. "5m" (5 minuter) eller "2h" (2 timmar) [Standard: "5m"]	sträng
typ	Den typ av anpassningsverktyg som du vill använda på bilden. Till exempel kan "Shell" vara gränssnittsanpassare	"WindowsRestart" (krävs)

ImageTemplateSharedImageDistributor

Namn	Beskrivning	Värde
excludeFromLatest	Flagga som anger om den skapade avbildningsversionen ska undantas från den senaste. Utelämna för att använda standardvärdet (false).	Bool
galleryImageId	Resurs-ID för Azure Compute Gallery-avbildningen	sträng (krävs)
replicationRegions	[Inaktuell] En lista över regioner som avbildningen ska replikeras till. Den här listan kan endast anges om targetRegions inte har angetts. Det här fältet är inaktuellt – använd targetRegions i stället.	string[]
storageAccountType	[Inaktuell] Lagringskontotyp som ska användas för att lagra den delade avbildningen. Utelämna att använda standardvärdet (Standard_LRS). Det här fältet kan endast anges om replikeringRegioner har angetts. Det här fältet är inaktuellt – använd targetRegions i stället.	"Premium_LRS" "Standard_LRS" "Standard_ZRS"
targetRegions	Målregionerna där den distribuerade avbildningsversionen ska replikeras till. Det här objektet ersätter replikeringRegioner och kan endast anges om replikeringRegioner inte har angetts.	TargetRegion[]
typ	Typ av distribution.	"SharedImage" (krävs)
versionshantering	Beskriver hur du genererar nytt x.y.z-versionsnummer för distribution.	DistributeVersioner

ImageTemplateSharedImageVersionSource

Namn	Beskrivning	Värde
imageVersionId	ARM-resurs-ID för avbildningsversionen. När avbildningsversionsnamnet är "senaste" utvärderas versionen när avbildningsversionen äger rum.	sträng (krävs)
typ	Anger vilken typ av källbild du vill börja med.	"SharedImageVersion" (krävs)

ImageTemplateShellCustomizer

Namn	Beskrivning	Värde
Inline	Matris med gränssnittskommandon som ska köras	string[]
scriptUri	URI för det gränssnittsskript som ska köras för anpassning. Det kan vara en github-länk, SAS-URI för Azure Storage osv.	sträng
sha256Checksum	SHA256-kontrollsumma för shell-skriptet som anges i fältet scriptUri	sträng
typ	Den typ av anpassningsverktyg som du vill använda på bilden. Till exempel kan "Shell" vara gränssnittsanpassare	"Shell" (krävs)

ImageTemplateShellValidator

Namn	Beskrivning	Värde
Inline	Matris med gränssnittskommandon som ska köras	string[]
scriptUri	URI för det gränssnittsskript som ska köras för validering. Det kan vara en github-länk, Azure Storage-URI osv.	sträng
sha256Checksum	SHA256-kontrollsumma för shell-skriptet som anges i fältet scriptUri	sträng
typ	Den typ av validering som du vill använda på avbildningen. Till exempel kan "Shell" vara shell-validering	"Shell" (krävs)

ImageTemplateSource

Namn	Beskrivning	Värde
typ	Ange till "ManagedImage" för typen ImageTemplateManagedImageSource. Ange till PlatformImage för typen ImageTemplatePlatformImageSource. Ange till "SharedImageVersion" för typen ImageTemplateSharedImageVersionSource.	"ManagedImage" "PlatformImage" "SharedImageVersion" (krävs)

ImageTemplateVhdDistributor

Namn	Beskrivning	Värde
typ	Typ av distribution.	"VHD" (krävs)
Uri	Valfri Azure Storage-URI för den distribuerade VHD-bloben. Utelämna att använda standardvärdet (tom sträng) i vilket fall VHD skulle publiceras till lagringskontot i mellanlagringsresursgruppen.	sträng

ImageTemplateVmProfile

Namn	Beskrivning	Värde
osDiskSizeGB	Storleken på OS-disken i GB. Utelämna eller ange 0 för att använda Azures standardstorlek för OS-disken.	Int Begränsningar: Minsta värde = 0
userAssignedIdentities	Valfri matris med resurs-ID:n för användartilldelade hanterade identiteter som ska konfigureras på den virtuella byggdatorn och den virtuella valideringsdatorn. Detta kan omfatta identiteten för bildmallen.	string[]
vmSize	Storleken på den virtuella dator som används för att skapa, anpassa och avbilda avbildningar. Utelämna eller ange en tom sträng för att använda standardvärdet (Standard_D1_v2 för Gen1-bilder och Standard_D2ds_v4 för Gen2-avbildningar).	sträng
vnetConfig	Valfri konfiguration av det virtuella nätverket som ska användas för att distribuera den virtuella byggdatorn och den virtuella valideringsdatorn i. Utelämna om inget specifikt virtuellt nätverk behöver användas.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Namn	Beskrivning	Värde
Filter	Matris med filter för att välja uppdateringar som ska tillämpas. Utelämna eller ange en tom matris för att använda standardvärdet (inget filter). Se länken ovan för exempel och detaljerad beskrivning av det här fältet.	string[]
searchCriteria	Villkor för att söka efter uppdateringar. Utelämna eller ange en tom sträng för att använda standardvärdet (sök efter alla). Se länken ovan för exempel och detaljerad beskrivning av det här fältet.	sträng
typ	Den typ av anpassningsverktyg som du vill använda på bilden. Till exempel kan "Shell" vara gränssnittsanpassare	"WindowsUpdate" (krävs)
updateLimit	Maximalt antal uppdateringar som ska tillämpas åt gången. Utelämna eller ange 0 för att använda standardvärdet (1 000)	Int Begränsningar: Minsta värde = 0