Delen via


Microsoft.VirtualMachineImages imageTemplates

Bicep-resourcedefinitie

Het resourcetype imageTemplates kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.VirtualMachineImages/imageTemplates wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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'
  }
}

ImageTemplateDistributor-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

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

Gebruik voor SharedImage:

{
  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
  }
}

Gebruik voor VHD-:

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

DistributeVersioner-objecten

Stel het schema in eigenschap om het type object op te geven.

Gebruik voor Meest recente:

{
  major: int
  scheme: 'Latest'
}

Gebruik voor bron:

{
  scheme: 'Source'
}

ImageTemplateCustomizer-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

Gebruik voor WindowsRestart:

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

Gebruik voor WindowsUpdate-:

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

ImageTemplateInVMValidator-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

ImageTemplateSource-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

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

Gebruik voor PlatformImage:

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

Gebruik voor SharedImageVersion:

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

Eigenschapswaarden

DistributeVersioner

Naam Beschrijving Waarde
plan Ingesteld op 'Latest' voor het type DistributeVersionerLatest. Ingesteld op Bron voor het type DistributeVersionerSource. 'Nieuwste'
Bron (vereist)

DistributeVersionerLatest

Naam Beschrijving Waarde
majoor Primaire versie voor het gegenereerde versienummer. Bepaal wat 'nieuwste' is op basis van versies met deze waarde als primaire versie. -1 is gelijk aan het verlaten ervan. Int

Beperkingen:
Minimumwaarde = -1
plan Versienummeringsschema dat moet worden gebruikt. 'Nieuwste' (vereist)

DistributeVersionerSource

Naam Beschrijving Waarde
plan Versienummeringsschema dat moet worden gebruikt. Bron (vereist)

ImageTemplateAutoRun

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt automatisch een build geactiveerd voor het maken of bijwerken van een installatiekopiesjabloon. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplateCustomizer

Naam Beschrijving Waarde
naam Beschrijvende naam om context te geven over wat deze aanpassingsstap doet snaar
type Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. Ingesteld op 'WindowsUpdate' voor het type ImageTemplateWindowsUpdateCustomizer. 'Bestand'
'PowerShell'
'Shell'
'WindowsRestart'
'WindowsUpdate' (vereist)

ImageTemplateDistributor

Naam Beschrijving Waarde
artifactTags Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. ImageTemplateDistributorArtifactTags
runOutputName De naam die moet worden gebruikt voor de bijbehorende RunOutput. string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. ManagedImage
'SharedImage'
VHD (vereist)

ImageTemplateDistributorArtifactTags

Naam Beschrijving Waarde

ImageTemplateFileCustomizer

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Bestand' (vereist)

ImageTemplateFileValidator

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload naar de VIRTUELE machine voor validatie. Het kan een github-koppeling, Azure Storage-URI (geautoriseerd of SAS) zijn, enzovoort snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Bestand' (vereist)

ImageTemplateIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. 'Geen'
UserAssigned
userAssignedIdentities De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. UserAssignedId-entiteiten

ImageTemplateInVMValidator

Naam Beschrijving Waarde
naam Beschrijvende naam om context op te geven over wat deze validatiestap doet snaar
type Ingesteld op Bestand voor het type ImageTemplateFileValidator. Ingesteld op PowerShell voor het type ImageTemplatePowerShellValidator. Ingesteld op Shell voor het type ImageTemplateShellValidator. 'Bestand'
'PowerShell'
'Shell' (vereist)

ImageTemplateManagedImageDistributor

Naam Beschrijving Waarde
imageId Resource-id van de installatiekopieën van de beheerde schijf tekenreeks (vereist)
plaats Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan tekenreeks (vereist)
type Type distributie. ManagedImage (vereist)

ImageTemplateManagedImageSource

Naam Beschrijving Waarde
imageId ARM-resource-id van de beheerde installatiekopieën in het klantabonnement tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. ManagedImage (vereist)

ImageTemplatePlatformImageSource

Naam Beschrijving Waarde
aanbieden Afbeeldingsaanbieding uit de Azure Gallery Images. snaar
planInfo Optionele configuratie van aankoopplan voor platforminstallatiekopieën. PlatformImagePurchasePlan
uitgever Image Publisher in Azure Gallery Images. snaar
Sku Afbeeldingsku uit de Azure Gallery-installatiekopieën. snaar
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. PlatformImage (vereist)
Versie Installatiekopieën van de Azure Gallery-installatiekopieën. Als hier 'nieuwste' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. snaar

ImageTemplatePowerShellCustomizer

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplatePowerShellValidator

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplateProperties

Naam Beschrijving Waarde
autoRun Hiermee wordt aangegeven of de installatiekopiesjabloon automatisch moet worden uitgevoerd bij het maken of bijwerken van een sjabloon. ImageTemplateAutoRun
buildTimeoutInMinutes Maximale duur om te wachten tijdens het bouwen van de afbeeldingssjabloon (inclusief alle aanpassingen, optimalisatie, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
Maximumwaarde = 960
Aanpassen Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort ImageTemplateCustomizer[]
uitdelen De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. ImageTemplateDistributor[] (vereist)
errorHandling Opties voor foutafhandeling bij een buildfout ImageTemplatePropertiesErrorHandling
managedResourceTags Tags die worden toegepast op de resourcegroep en/of resources die door de service zijn gemaakt. ImageTemplatePropertiesManagedResourceTags
optimaliseren Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding. ImageTemplatePropertiesOptimize
bron Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. ImageTemplateSource (vereist)
stagingResourceGroup De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze gemaakt met dezelfde naam. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources verwijderd die in de resourcegroep zijn gemaakt tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf behouden. snaar
valideren Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding. ImageTemplatePropertiesValidate-
vmProfile Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Naam Beschrijving Waarde
onCustomizerError Als er een aanpasserfout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een aanpasserfout optreedt en dit veld is ingesteld op afbreken, blijft de build-VM behouden. 'afgebroken'
'opschonen'
onValidationError Als er een validatiefout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een validatiefout is en dit veld is ingesteld op 'afbreken', blijft de build-VM behouden. 'afgebroken'
'opschonen'

ImageTemplatePropertiesManagedResourceTags

Naam Beschrijving Waarde

ImageTemplatePropertiesOptimize

Naam Beschrijving Waarde
vmBoot Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplatePropertiesValidate

Naam Beschrijving Waarde
continueDistributeOnFailure Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is het standaardgedrag. Als de validatie mislukt en dit veld is ingesteld op true, worden uitvoerafbeeldingen nog steeds gedistribueerd. Gebruik deze optie met voorzichtigheid, omdat dit kan leiden tot slechte installatiekopieën die voor gebruik worden gedistribueerd. In beide gevallen (waar of onwaar) wordt de end-to-end-installatiekopieuitvoering gerapporteerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] Bool
inVMValidations Lijst met validaties die moeten worden uitgevoerd. ImageTemplateInVMValidator[]
sourceValidationOnly Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie Bron rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. Bool

ImageTemplateRestartCustomizer

Naam Beschrijving Waarde
restartCheckCommand Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] snaar
restartCommand Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] snaar
restartTimeout Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsRestart' (vereist)

ImageTemplateSharedImageDistributor

Naam Beschrijving Waarde
excludeFromLatest Vlag die aangeeft of de gemaakte installatiekopieënversie moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde (onwaar) te gebruiken. Bool
galleryImageId Resource-id van de azure Compute Gallery-installatiekopieën tekenreeks (vereist)
replicationRegions [Afgeschaft] Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd. Deze lijst kan alleen worden opgegeven als targetRegions niet is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. tekenreeks[]
storageAccountType [Afgeschaft] Het type opslagaccount dat moet worden gebruikt voor het opslaan van de gedeelde installatiekopie. Laat het gebruik van de standaardwaarde weg (Standard_LRS). Dit veld kan alleen worden opgegeven als replicationRegions is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'
targetRegions De doelregio's waarnaar de gedistribueerde versie van de installatiekopieën wordt gerepliceerd. Dit object vervangt replicationRegions en kan alleen worden opgegeven als replicationRegions niet is opgegeven. TargetRegion[]
type Type distributie. SharedImage (vereist)
versiebeheer Hierin wordt beschreven hoe u een nieuw x.y.z-versienummer voor distributie genereert. DistributeVersioner-

ImageTemplateSharedImageVersionSource

Naam Beschrijving Waarde
imageVersionId ARM-resource-id van de versie van de installatiekopieën. Wanneer de naam van de installatiekopieënversie 'nieuwste' is, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd. tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. SharedImageVersion (vereist)

ImageTemplateShellCustomizer

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Shell' (vereist)

ImageTemplateShellValidator

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Shell' (vereist)

ImageTemplateSource

Naam Beschrijving Waarde
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. ManagedImage
'PlatformImage'
SharedImageVersion (vereist)

ImageTemplateVhdDistributor

Naam Beschrijving Waarde
type Type distributie. VHD (vereist)
Uri Optionele Azure Storage-URI voor de gedistribueerde VHD-blob. Laat het gebruik van de standaardwaarde (lege tekenreeks) weg. In dat geval wordt VHD gepubliceerd naar het opslagaccount in de faseringsresourcegroep. snaar

ImageTemplateVmProfile

Naam Beschrijving Waarde
osDiskSizeGB Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardschijfgrootte van het besturingssysteem van Azure te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
userAssignedIdentities Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon zijn. tekenreeks[]
vmSize Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (Standard_D1_v2 voor Gen1-installatiekopieën en Standard_D2ds_v4 voor Gen2-afbeeldingen). snaar
vnetConfig Optionele configuratie van het virtuele netwerk dat moet worden gebruikt voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk moet worden gebruikt. VirtualNetworkConfig-

ImageTemplateWindowsUpdateCustomizer

Naam Beschrijving Waarde
Filters Matrix met filters om updates te selecteren die moeten worden toegepast. Laat de lege matrix weg of geef deze op om de standaardwaarde te gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. tekenreeks[]
searchCriteria Criteria voor het zoeken naar updates. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (zoek alles). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsUpdate' (vereist)
updateLimit Maximum aantal updates dat tegelijk moet worden toegepast. Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (1000) Int

Beperkingen:
Minimumwaarde = 0

Microsoft.VirtualMachineImages/imageTemplates

Naam Beschrijving Waarde
identiteit De identiteit van de afbeeldingssjabloon, indien geconfigureerd. ImageTemplateIdentity (vereist)
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
Eigenschappen De eigenschappen van de afbeeldingssjabloon ImageTemplateProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

PlatformImagePurchasePlan

Naam Beschrijving Waarde
planName Naam van het aankoopplan. tekenreeks (vereist)
planProduct Product van het aankoopplan. tekenreeks (vereist)
planPublisher Uitgever van het aankoopplan. tekenreeks (vereist)

TargetRegion

Naam Beschrijving Waarde
naam De naam van de regio. tekenreeks (vereist)
replicaCount Het aantal replica's van de versie van de installatiekopieën dat in deze regio moet worden gemaakt. Laat het gebruik van de standaardwaarde weg (1). Int

Beperkingen:
Minimumwaarde = 1
storageAccountType Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de installatiekopie in deze regio. Laat het gebruik van de standaardwaarde weg (Standard_LRS). 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

TrackedResourceTags

Naam Beschrijving Waarde

UserAssignedIdentities

Naam Beschrijving Waarde

UserAssignedIdentity

Naam Beschrijving Waarde

VirtualNetworkConfig

Naam Beschrijving Waarde
containerInstanceSubnetId Resource-id van een bestaand subnet waarop Azure Container Instance wordt geïmplementeerd voor geïsoleerde builds. Dit veld mag alleen worden opgegeven als subnetId ook is opgegeven en moet zich in hetzelfde virtuele netwerk bevinden als het subnet dat is opgegeven in subnetId. snaar
proxyVmSize De grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Dit mag niet worden opgegeven als containerInstanceSubnetId is opgegeven omdat er in dat geval geen virtuele proxymachine wordt geïmplementeerd. Laat de lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_A1_v2). snaar
subnetId Resource-id van een bestaand subnet waarop de build-VM en validatie-VM worden geïmplementeerd snaar

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand Beschrijving
Azure Image Builder met Azure Windows Baseline Hiermee maakt u een Azure Image Builder-omgeving en bouwt u een Windows Server-installatiekopieën waarop de nieuwste Windows-updates en Azure Windows Baseline zijn toegepast.
Dev Box-service configureren Met deze sjabloon worden alle Dev Box-beheerbronnen gemaakt volgens de Quick Start-handleiding voor Dev Box (/azure/dev-box/quickstart-create-dev-box). U kunt alle gemaakte resources bekijken of rechtstreeks naar DevPortal.microsoft.com gaan om uw eerste Dev Box te maken.

Resourcedefinitie van ARM-sjabloon

Het resourcetype imageTemplates kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.VirtualMachineImages/imageTemplates-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2024-02-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "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"
  }
}

ImageTemplateDistributor-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

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

Gebruik voor SharedImage:

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

Gebruik voor VHD-:

{
  "type": "VHD",
  "uri": "string"
}

DistributeVersioner-objecten

Stel het schema in eigenschap om het type object op te geven.

Gebruik voor Meest recente:

{
  "major": "int",
  "scheme": "Latest"
}

Gebruik voor bron:

{
  "scheme": "Source"
}

ImageTemplateCustomizer-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

Gebruik voor WindowsRestart:

{
  "restartCheckCommand": "string",
  "restartCommand": "string",
  "restartTimeout": "string",
  "type": "WindowsRestart"
}

Gebruik voor WindowsUpdate-:

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

ImageTemplateInVMValidator-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

ImageTemplateSource-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

{
  "imageId": "string",
  "type": "ManagedImage"
}

Gebruik voor PlatformImage:

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

Gebruik voor SharedImageVersion:

{
  "imageVersionId": "string",
  "type": "SharedImageVersion"
}

Eigenschapswaarden

DistributeVersioner

Naam Beschrijving Waarde
plan Ingesteld op 'Latest' voor het type DistributeVersionerLatest. Ingesteld op Bron voor het type DistributeVersionerSource. 'Nieuwste'
Bron (vereist)

DistributeVersionerLatest

Naam Beschrijving Waarde
majoor Primaire versie voor het gegenereerde versienummer. Bepaal wat 'nieuwste' is op basis van versies met deze waarde als primaire versie. -1 is gelijk aan het verlaten ervan. Int

Beperkingen:
Minimumwaarde = -1
plan Versienummeringsschema dat moet worden gebruikt. 'Nieuwste' (vereist)

DistributeVersionerSource

Naam Beschrijving Waarde
plan Versienummeringsschema dat moet worden gebruikt. Bron (vereist)

ImageTemplateAutoRun

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt automatisch een build geactiveerd voor het maken of bijwerken van een installatiekopiesjabloon. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplateCustomizer

Naam Beschrijving Waarde
naam Beschrijvende naam om context te geven over wat deze aanpassingsstap doet snaar
type Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. Ingesteld op 'WindowsUpdate' voor het type ImageTemplateWindowsUpdateCustomizer. 'Bestand'
'PowerShell'
'Shell'
'WindowsRestart'
'WindowsUpdate' (vereist)

ImageTemplateDistributor

Naam Beschrijving Waarde
artifactTags Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. ImageTemplateDistributorArtifactTags
runOutputName De naam die moet worden gebruikt voor de bijbehorende RunOutput. string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. ManagedImage
'SharedImage'
VHD (vereist)

ImageTemplateDistributorArtifactTags

Naam Beschrijving Waarde

ImageTemplateFileCustomizer

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Bestand' (vereist)

ImageTemplateFileValidator

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload naar de VIRTUELE machine voor validatie. Het kan een github-koppeling, Azure Storage-URI (geautoriseerd of SAS) zijn, enzovoort snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Bestand' (vereist)

ImageTemplateIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. 'Geen'
UserAssigned
userAssignedIdentities De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. UserAssignedId-entiteiten

ImageTemplateInVMValidator

Naam Beschrijving Waarde
naam Beschrijvende naam om context op te geven over wat deze validatiestap doet snaar
type Ingesteld op Bestand voor het type ImageTemplateFileValidator. Ingesteld op PowerShell voor het type ImageTemplatePowerShellValidator. Ingesteld op Shell voor het type ImageTemplateShellValidator. 'Bestand'
'PowerShell'
'Shell' (vereist)

ImageTemplateManagedImageDistributor

Naam Beschrijving Waarde
imageId Resource-id van de installatiekopieën van de beheerde schijf tekenreeks (vereist)
plaats Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan tekenreeks (vereist)
type Type distributie. ManagedImage (vereist)

ImageTemplateManagedImageSource

Naam Beschrijving Waarde
imageId ARM-resource-id van de beheerde installatiekopieën in het klantabonnement tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. ManagedImage (vereist)

ImageTemplatePlatformImageSource

Naam Beschrijving Waarde
aanbieden Afbeeldingsaanbieding uit de Azure Gallery Images. snaar
planInfo Optionele configuratie van aankoopplan voor platforminstallatiekopieën. PlatformImagePurchasePlan
uitgever Image Publisher in Azure Gallery Images. snaar
Sku Afbeeldingsku uit de Azure Gallery-installatiekopieën. snaar
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. PlatformImage (vereist)
Versie Installatiekopieën van de Azure Gallery-installatiekopieën. Als hier 'nieuwste' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. snaar

ImageTemplatePowerShellCustomizer

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplatePowerShellValidator

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplateProperties

Naam Beschrijving Waarde
autoRun Hiermee wordt aangegeven of de installatiekopiesjabloon automatisch moet worden uitgevoerd bij het maken of bijwerken van een sjabloon. ImageTemplateAutoRun
buildTimeoutInMinutes Maximale duur om te wachten tijdens het bouwen van de afbeeldingssjabloon (inclusief alle aanpassingen, optimalisatie, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
Maximumwaarde = 960
Aanpassen Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort ImageTemplateCustomizer[]
uitdelen De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. ImageTemplateDistributor[] (vereist)
errorHandling Opties voor foutafhandeling bij een buildfout ImageTemplatePropertiesErrorHandling
managedResourceTags Tags die worden toegepast op de resourcegroep en/of resources die door de service zijn gemaakt. ImageTemplatePropertiesManagedResourceTags
optimaliseren Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding. ImageTemplatePropertiesOptimize
bron Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. ImageTemplateSource (vereist)
stagingResourceGroup De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze gemaakt met dezelfde naam. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources verwijderd die in de resourcegroep zijn gemaakt tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf behouden. snaar
valideren Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding. ImageTemplatePropertiesValidate-
vmProfile Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Naam Beschrijving Waarde
onCustomizerError Als er een aanpasserfout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een aanpasserfout optreedt en dit veld is ingesteld op afbreken, blijft de build-VM behouden. 'afgebroken'
'opschonen'
onValidationError Als er een validatiefout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een validatiefout is en dit veld is ingesteld op 'afbreken', blijft de build-VM behouden. 'afgebroken'
'opschonen'

ImageTemplatePropertiesManagedResourceTags

Naam Beschrijving Waarde

ImageTemplatePropertiesOptimize

Naam Beschrijving Waarde
vmBoot Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplatePropertiesValidate

Naam Beschrijving Waarde
continueDistributeOnFailure Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is het standaardgedrag. Als de validatie mislukt en dit veld is ingesteld op true, worden uitvoerafbeeldingen nog steeds gedistribueerd. Gebruik deze optie met voorzichtigheid, omdat dit kan leiden tot slechte installatiekopieën die voor gebruik worden gedistribueerd. In beide gevallen (waar of onwaar) wordt de end-to-end-installatiekopieuitvoering gerapporteerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] Bool
inVMValidations Lijst met validaties die moeten worden uitgevoerd. ImageTemplateInVMValidator[]
sourceValidationOnly Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie Bron rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. Bool

ImageTemplateRestartCustomizer

Naam Beschrijving Waarde
restartCheckCommand Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] snaar
restartCommand Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] snaar
restartTimeout Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsRestart' (vereist)

ImageTemplateSharedImageDistributor

Naam Beschrijving Waarde
excludeFromLatest Vlag die aangeeft of de gemaakte installatiekopieënversie moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde (onwaar) te gebruiken. Bool
galleryImageId Resource-id van de azure Compute Gallery-installatiekopieën tekenreeks (vereist)
replicationRegions [Afgeschaft] Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd. Deze lijst kan alleen worden opgegeven als targetRegions niet is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. tekenreeks[]
storageAccountType [Afgeschaft] Het type opslagaccount dat moet worden gebruikt voor het opslaan van de gedeelde installatiekopie. Laat het gebruik van de standaardwaarde weg (Standard_LRS). Dit veld kan alleen worden opgegeven als replicationRegions is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'
targetRegions De doelregio's waarnaar de gedistribueerde versie van de installatiekopieën wordt gerepliceerd. Dit object vervangt replicationRegions en kan alleen worden opgegeven als replicationRegions niet is opgegeven. TargetRegion[]
type Type distributie. SharedImage (vereist)
versiebeheer Hierin wordt beschreven hoe u een nieuw x.y.z-versienummer voor distributie genereert. DistributeVersioner-

ImageTemplateSharedImageVersionSource

Naam Beschrijving Waarde
imageVersionId ARM-resource-id van de versie van de installatiekopieën. Wanneer de naam van de installatiekopieënversie 'nieuwste' is, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd. tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. SharedImageVersion (vereist)

ImageTemplateShellCustomizer

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Shell' (vereist)

ImageTemplateShellValidator

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Shell' (vereist)

ImageTemplateSource

Naam Beschrijving Waarde
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. ManagedImage
'PlatformImage'
SharedImageVersion (vereist)

ImageTemplateVhdDistributor

Naam Beschrijving Waarde
type Type distributie. VHD (vereist)
Uri Optionele Azure Storage-URI voor de gedistribueerde VHD-blob. Laat het gebruik van de standaardwaarde (lege tekenreeks) weg. In dat geval wordt VHD gepubliceerd naar het opslagaccount in de faseringsresourcegroep. snaar

ImageTemplateVmProfile

Naam Beschrijving Waarde
osDiskSizeGB Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardschijfgrootte van het besturingssysteem van Azure te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
userAssignedIdentities Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon zijn. tekenreeks[]
vmSize Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (Standard_D1_v2 voor Gen1-installatiekopieën en Standard_D2ds_v4 voor Gen2-afbeeldingen). snaar
vnetConfig Optionele configuratie van het virtuele netwerk dat moet worden gebruikt voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk moet worden gebruikt. VirtualNetworkConfig-

ImageTemplateWindowsUpdateCustomizer

Naam Beschrijving Waarde
Filters Matrix met filters om updates te selecteren die moeten worden toegepast. Laat de lege matrix weg of geef deze op om de standaardwaarde te gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. tekenreeks[]
searchCriteria Criteria voor het zoeken naar updates. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (zoek alles). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsUpdate' (vereist)
updateLimit Maximum aantal updates dat tegelijk moet worden toegepast. Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (1000) Int

Beperkingen:
Minimumwaarde = 0

Microsoft.VirtualMachineImages/imageTemplates

Naam Beschrijving Waarde
apiVersion De API-versie '2024-02-01'
identiteit De identiteit van de afbeeldingssjabloon, indien geconfigureerd. ImageTemplateIdentity (vereist)
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
Eigenschappen De eigenschappen van de afbeeldingssjabloon ImageTemplateProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.VirtualMachineImages/imageTemplates'

PlatformImagePurchasePlan

Naam Beschrijving Waarde
planName Naam van het aankoopplan. tekenreeks (vereist)
planProduct Product van het aankoopplan. tekenreeks (vereist)
planPublisher Uitgever van het aankoopplan. tekenreeks (vereist)

TargetRegion

Naam Beschrijving Waarde
naam De naam van de regio. tekenreeks (vereist)
replicaCount Het aantal replica's van de versie van de installatiekopieën dat in deze regio moet worden gemaakt. Laat het gebruik van de standaardwaarde weg (1). Int

Beperkingen:
Minimumwaarde = 1
storageAccountType Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de installatiekopie in deze regio. Laat het gebruik van de standaardwaarde weg (Standard_LRS). 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

TrackedResourceTags

Naam Beschrijving Waarde

UserAssignedIdentities

Naam Beschrijving Waarde

UserAssignedIdentity

Naam Beschrijving Waarde

VirtualNetworkConfig

Naam Beschrijving Waarde
containerInstanceSubnetId Resource-id van een bestaand subnet waarop Azure Container Instance wordt geïmplementeerd voor geïsoleerde builds. Dit veld mag alleen worden opgegeven als subnetId ook is opgegeven en moet zich in hetzelfde virtuele netwerk bevinden als het subnet dat is opgegeven in subnetId. snaar
proxyVmSize De grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Dit mag niet worden opgegeven als containerInstanceSubnetId is opgegeven omdat er in dat geval geen virtuele proxymachine wordt geïmplementeerd. Laat de lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_A1_v2). snaar
subnetId Resource-id van een bestaand subnet waarop de build-VM en validatie-VM worden geïmplementeerd snaar

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
Azure Image Builder met Azure Windows Baseline

implementeren in Azure
Hiermee maakt u een Azure Image Builder-omgeving en bouwt u een Windows Server-installatiekopieën waarop de nieuwste Windows-updates en Azure Windows Baseline zijn toegepast.
Dev Box-service configureren

implementeren in Azure
Met deze sjabloon worden alle Dev Box-beheerbronnen gemaakt volgens de Quick Start-handleiding voor Dev Box (/azure/dev-box/quickstart-create-dev-box). U kunt alle gemaakte resources bekijken of rechtstreeks naar DevPortal.microsoft.com gaan om uw eerste Dev Box te maken.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype imageTemplates kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.VirtualMachineImages/imageTemplates-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
        }
      }
    }
  })
}

ImageTemplateDistributor-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

{
  imageId = "string"
  location = "string"
  type = "ManagedImage"
}

Gebruik voor SharedImage:

{
  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
  }
}

Gebruik voor VHD-:

{
  type = "VHD"
  uri = "string"
}

DistributeVersioner-objecten

Stel het schema in eigenschap om het type object op te geven.

Gebruik voor Meest recente:

{
  major = int
  scheme = "Latest"
}

Gebruik voor bron:

{
  scheme = "Source"
}

ImageTemplateCustomizer-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

Gebruik voor WindowsRestart:

{
  restartCheckCommand = "string"
  restartCommand = "string"
  restartTimeout = "string"
  type = "WindowsRestart"
}

Gebruik voor WindowsUpdate-:

{
  filters = [
    "string"
  ]
  searchCriteria = "string"
  type = "WindowsUpdate"
  updateLimit = int
}

ImageTemplateInVMValidator-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor Bestand:

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

Gebruik voor PowerShell-:

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

Gebruik voor Shell-:

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

ImageTemplateSource-objecten

Stel de eigenschap type in om het type object op te geven.

Gebruik voor ManagedImage:

{
  imageId = "string"
  type = "ManagedImage"
}

Gebruik voor PlatformImage:

{
  offer = "string"
  planInfo = {
    planName = "string"
    planProduct = "string"
    planPublisher = "string"
  }
  publisher = "string"
  sku = "string"
  type = "PlatformImage"
  version = "string"
}

Gebruik voor SharedImageVersion:

{
  imageVersionId = "string"
  type = "SharedImageVersion"
}

Eigenschapswaarden

DistributeVersioner

Naam Beschrijving Waarde
plan Ingesteld op 'Latest' voor het type DistributeVersionerLatest. Ingesteld op Bron voor het type DistributeVersionerSource. 'Nieuwste'
Bron (vereist)

DistributeVersionerLatest

Naam Beschrijving Waarde
majoor Primaire versie voor het gegenereerde versienummer. Bepaal wat 'nieuwste' is op basis van versies met deze waarde als primaire versie. -1 is gelijk aan het verlaten ervan. Int

Beperkingen:
Minimumwaarde = -1
plan Versienummeringsschema dat moet worden gebruikt. 'Nieuwste' (vereist)

DistributeVersionerSource

Naam Beschrijving Waarde
plan Versienummeringsschema dat moet worden gebruikt. Bron (vereist)

ImageTemplateAutoRun

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt automatisch een build geactiveerd voor het maken of bijwerken van een installatiekopiesjabloon. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplateCustomizer

Naam Beschrijving Waarde
naam Beschrijvende naam om context te geven over wat deze aanpassingsstap doet snaar
type Ingesteld op Bestand voor type ImageTemplateFileCustomizer. Ingesteld op PowerShell voor het type ImageTemplatePowerShellCustomizer. Ingesteld op Shell voor het type ImageTemplateShellCustomizer. Ingesteld op 'WindowsRestart' voor het type ImageTemplateRestartCustomizer. Ingesteld op 'WindowsUpdate' voor het type ImageTemplateWindowsUpdateCustomizer. 'Bestand'
'PowerShell'
'Shell'
'WindowsRestart'
'WindowsUpdate' (vereist)

ImageTemplateDistributor

Naam Beschrijving Waarde
artifactTags Tags die worden toegepast op het artefact nadat het is gemaakt/bijgewerkt door de distributeur. ImageTemplateDistributorArtifactTags
runOutputName De naam die moet worden gebruikt voor de bijbehorende RunOutput. string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageDistributor. Ingesteld op SharedImage voor het type ImageTemplateSharedImageDistributor. Ingesteld op VHD voor het type ImageTemplateVhdDistributor. ManagedImage
'SharedImage'
VHD (vereist)

ImageTemplateDistributorArtifactTags

Naam Beschrijving Waarde

ImageTemplateFileCustomizer

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload voor het aanpassen van de VIRTUELE machine. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Bestand' (vereist)

ImageTemplateFileValidator

Naam Beschrijving Waarde
bestemming Het absolute pad naar een bestand (met geneste mapstructuren die al zijn gemaakt) waar het bestand (van sourceUri) naar wordt geüpload in de VIRTUELE machine snaar
sha256Checksum SHA256-controlesom van het bestand dat is opgegeven in het bovenstaande bronuri-veld snaar
sourceUri De URI van het bestand dat moet worden geüpload naar de VIRTUELE machine voor validatie. Het kan een github-koppeling, Azure Storage-URI (geautoriseerd of SAS) zijn, enzovoort snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Bestand' (vereist)

ImageTemplateIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de afbeeldingssjabloon. Met het type None worden alle identiteiten uit de afbeeldingssjabloon verwijderd. 'Geen'
UserAssigned
userAssignedIdentities De set door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De woordenlijstsleutels userAssignedIdentities zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. De waarden van de woordenlijst kunnen lege objecten ({}) zijn in aanvragen. UserAssignedId-entiteiten

ImageTemplateInVMValidator

Naam Beschrijving Waarde
naam Beschrijvende naam om context op te geven over wat deze validatiestap doet snaar
type Ingesteld op Bestand voor het type ImageTemplateFileValidator. Ingesteld op PowerShell voor het type ImageTemplatePowerShellValidator. Ingesteld op Shell voor het type ImageTemplateShellValidator. 'Bestand'
'PowerShell'
'Shell' (vereist)

ImageTemplateManagedImageDistributor

Naam Beschrijving Waarde
imageId Resource-id van de installatiekopieën van de beheerde schijf tekenreeks (vereist)
plaats Azure-locatie voor de installatiekopieën moet overeenkomen als de installatiekopieën al bestaan tekenreeks (vereist)
type Type distributie. ManagedImage (vereist)

ImageTemplateManagedImageSource

Naam Beschrijving Waarde
imageId ARM-resource-id van de beheerde installatiekopieën in het klantabonnement tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. ManagedImage (vereist)

ImageTemplatePlatformImageSource

Naam Beschrijving Waarde
aanbieden Afbeeldingsaanbieding uit de Azure Gallery Images. snaar
planInfo Optionele configuratie van aankoopplan voor platforminstallatiekopieën. PlatformImagePurchasePlan
uitgever Image Publisher in Azure Gallery Images. snaar
Sku Afbeeldingsku uit de Azure Gallery-installatiekopieën. snaar
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. PlatformImage (vereist)
Versie Installatiekopieën van de Azure Gallery-installatiekopieën. Als hier 'nieuwste' is opgegeven, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd, niet wanneer de sjabloon wordt verzonden. snaar

ImageTemplatePowerShellCustomizer

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplatePowerShellValidator

Naam Beschrijving Waarde
Inline Matrix met PowerShell-opdrachten die moeten worden uitgevoerd tekenreeks[]
runAsSystem Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden met behulp van de gebruiker van het lokale systeem. Kan alleen waar zijn wanneer het bovenstaande runElevated-veld is ingesteld op true. Bool
runElevated Als dit is opgegeven, wordt het PowerShell-script uitgevoerd met verhoogde bevoegdheden Bool
scriptUri URI van het PowerShell-script dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het Power Shell-script dat is opgegeven in het bovenstaande scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn PowerShell (vereist)
validExitCodes Geldige afsluitcodes voor het PowerShell-script. [Standaard: 0] int[]

ImageTemplateProperties

Naam Beschrijving Waarde
autoRun Hiermee wordt aangegeven of de installatiekopiesjabloon automatisch moet worden uitgevoerd bij het maken of bijwerken van een sjabloon. ImageTemplateAutoRun
buildTimeoutInMinutes Maximale duur om te wachten tijdens het bouwen van de afbeeldingssjabloon (inclusief alle aanpassingen, optimalisatie, validaties en distributies). Laat 0 weg of geef 0 op om de standaardwaarde (4 uur) te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
Maximumwaarde = 960
Aanpassen Hiermee geeft u de eigenschappen die worden gebruikt voor het beschrijven van de aanpassingsstappen van de afbeelding, zoals afbeeldingsbron, enzovoort ImageTemplateCustomizer[]
uitdelen De distributiedoelen waar de uitvoer van de installatiekopieën naartoe moet gaan. ImageTemplateDistributor[] (vereist)
errorHandling Opties voor foutafhandeling bij een buildfout ImageTemplatePropertiesErrorHandling
managedResourceTags Tags die worden toegepast op de resourcegroep en/of resources die door de service zijn gemaakt. ImageTemplatePropertiesManagedResourceTags
optimaliseren Hiermee geeft u optimalisatie moet worden uitgevoerd op de afbeelding. ImageTemplatePropertiesOptimize
bron Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven. ImageTemplateSource (vereist)
stagingResourceGroup De id van de faseringsresourcegroep in hetzelfde abonnement als de installatiekopieënsjabloon die wordt gebruikt om de installatiekopieën te bouwen. Als dit veld leeg is, wordt er een resourcegroep met een willekeurige naam gemaakt. Als de resourcegroep die in dit veld is opgegeven niet bestaat, wordt deze gemaakt met dezelfde naam. Als de opgegeven resourcegroep bestaat, moet deze leeg zijn en zich in dezelfde regio bevinden als de afbeeldingssjabloon. De gemaakte resourcegroep wordt verwijderd tijdens het verwijderen van de sjabloon als dit veld leeg is of als de opgegeven resourcegroep niet bestaat, maar als de opgegeven resourcegroep bestaat, worden de resources verwijderd die in de resourcegroep zijn gemaakt tijdens het verwijderen van de sjabloon en blijft de resourcegroep zelf behouden. snaar
valideren Configuratieopties en lijst met validaties die moeten worden uitgevoerd op de resulterende afbeelding. ImageTemplatePropertiesValidate-
vmProfile Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Naam Beschrijving Waarde
onCustomizerError Als er een aanpasserfout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een aanpasserfout optreedt en dit veld is ingesteld op afbreken, blijft de build-VM behouden. 'afgebroken'
'opschonen'
onValidationError Als er een validatiefout optreedt en dit veld is ingesteld op op opschonen, worden de build-VM en de bijbehorende netwerkbronnen opgeschoond. Dit is het standaardgedrag. Als er een validatiefout is en dit veld is ingesteld op 'afbreken', blijft de build-VM behouden. 'afgebroken'
'opschonen'

ImageTemplatePropertiesManagedResourceTags

Naam Beschrijving Waarde

ImageTemplatePropertiesOptimize

Naam Beschrijving Waarde
vmBoot Optimalisatie wordt toegepast op de installatiekopie voor een snellere vm-opstartbewerking. ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Naam Beschrijving Waarde
staat Als u dit veld inschakelt, wordt de opstarttijd van de VIRTUELE machine verbeterd door de uiteindelijke aangepaste uitvoer van de installatiekopie te optimaliseren. 'Uitgeschakeld'
'Ingeschakeld'

ImageTemplatePropertiesValidate

Naam Beschrijving Waarde
continueDistributeOnFailure Als de validatie mislukt en dit veld is ingesteld op false, worden de uitvoerafbeeldingen niet gedistribueerd. Dit is het standaardgedrag. Als de validatie mislukt en dit veld is ingesteld op true, worden uitvoerafbeeldingen nog steeds gedistribueerd. Gebruik deze optie met voorzichtigheid, omdat dit kan leiden tot slechte installatiekopieën die voor gebruik worden gedistribueerd. In beide gevallen (waar of onwaar) wordt de end-to-end-installatiekopieuitvoering gerapporteerd als mislukt in het geval van een validatiefout. [Opmerking: dit veld heeft geen effect als de validatie slaagt.] Bool
inVMValidations Lijst met validaties die moeten worden uitgevoerd. ImageTemplateInVMValidator[]
sourceValidationOnly Als dit veld is ingesteld op true, wordt de afbeelding die is opgegeven in de sectie Bron rechtstreeks gevalideerd. Er wordt geen afzonderlijke build uitgevoerd om een aangepaste installatiekopieën te genereren en vervolgens te valideren. Bool

ImageTemplateRestartCustomizer

Naam Beschrijving Waarde
restartCheckCommand Opdracht om te controleren of opnieuw opstarten is geslaagd [Standaard: ''] snaar
restartCommand Opdracht om opnieuw opstarten uit te voeren [Standaard: afsluiten /r /f /t /t 0 /c "packer restart""] snaar
restartTimeout Time-out voor opnieuw opstarten opgegeven als een tekenreeks van grootte en eenheid, bijvoorbeeld '5m' (5 minuten) of '2h' (2 uur) [Standaard: '5m'] snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsRestart' (vereist)

ImageTemplateSharedImageDistributor

Naam Beschrijving Waarde
excludeFromLatest Vlag die aangeeft of de gemaakte installatiekopieënversie moet worden uitgesloten van de meest recente versie. Weglaten om de standaardwaarde (onwaar) te gebruiken. Bool
galleryImageId Resource-id van de azure Compute Gallery-installatiekopieën tekenreeks (vereist)
replicationRegions [Afgeschaft] Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd. Deze lijst kan alleen worden opgegeven als targetRegions niet is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. tekenreeks[]
storageAccountType [Afgeschaft] Het type opslagaccount dat moet worden gebruikt voor het opslaan van de gedeelde installatiekopie. Laat het gebruik van de standaardwaarde weg (Standard_LRS). Dit veld kan alleen worden opgegeven als replicationRegions is opgegeven. Dit veld is afgeschaft. Gebruik in plaats daarvan targetRegions. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'
targetRegions De doelregio's waarnaar de gedistribueerde versie van de installatiekopieën wordt gerepliceerd. Dit object vervangt replicationRegions en kan alleen worden opgegeven als replicationRegions niet is opgegeven. TargetRegion[]
type Type distributie. SharedImage (vereist)
versiebeheer Hierin wordt beschreven hoe u een nieuw x.y.z-versienummer voor distributie genereert. DistributeVersioner-

ImageTemplateSharedImageVersionSource

Naam Beschrijving Waarde
imageVersionId ARM-resource-id van de versie van de installatiekopieën. Wanneer de naam van de installatiekopieënversie 'nieuwste' is, wordt de versie geëvalueerd wanneer de installatiekopieën worden gebouwd. tekenreeks (vereist)
type Hiermee geeft u het type broninstallatiekopie waarmee u wilt beginnen. SharedImageVersion (vereist)

ImageTemplateShellCustomizer

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shell-script dat moet worden uitgevoerd voor het aanpassen. Het kan een github-koppeling, SAS-URI voor Azure Storage, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'Shell' (vereist)

ImageTemplateShellValidator

Naam Beschrijving Waarde
Inline Matrix van shell-opdrachten die moeten worden uitgevoerd tekenreeks[]
scriptUri URI van het shellscript dat moet worden uitgevoerd voor validatie. Dit kan een github-koppeling, Azure Storage-URI, enzovoort zijn snaar
sha256Checksum SHA256-controlesom van het shellscript dat is opgegeven in het scriptUri-veld snaar
type Het type validatie dat u wilt gebruiken op de afbeelding. Shell kan bijvoorbeeld shellvalidatie zijn 'Shell' (vereist)

ImageTemplateSource

Naam Beschrijving Waarde
type Ingesteld op ManagedImage voor het type ImageTemplateManagedImageSource. Ingesteld op PlatformImage voor het type ImageTemplatePlatformImageSource. Ingesteld op SharedImageVersion voor het type ImageTemplateSharedImageVersionSource. ManagedImage
'PlatformImage'
SharedImageVersion (vereist)

ImageTemplateVhdDistributor

Naam Beschrijving Waarde
type Type distributie. VHD (vereist)
Uri Optionele Azure Storage-URI voor de gedistribueerde VHD-blob. Laat het gebruik van de standaardwaarde (lege tekenreeks) weg. In dat geval wordt VHD gepubliceerd naar het opslagaccount in de faseringsresourcegroep. snaar

ImageTemplateVmProfile

Naam Beschrijving Waarde
osDiskSizeGB Grootte van de besturingssysteemschijf in GB. Laat 0 weg of geef 0 op om de standaardschijfgrootte van het besturingssysteem van Azure te gebruiken. Int

Beperkingen:
Minimumwaarde = 0
userAssignedIdentities Optionele matrix van resource-id's van door de gebruiker toegewezen beheerde identiteiten die moeten worden geconfigureerd op de build-VM en validatie-VM. Dit kan de identiteit van de afbeeldingssjabloon zijn. tekenreeks[]
vmSize Grootte van de virtuele machine die wordt gebruikt voor het bouwen, aanpassen en vastleggen van installatiekopieën. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (Standard_D1_v2 voor Gen1-installatiekopieën en Standard_D2ds_v4 voor Gen2-afbeeldingen). snaar
vnetConfig Optionele configuratie van het virtuele netwerk dat moet worden gebruikt voor het implementeren van de build-VM en validatie-VM in. Weglaten als er geen specifiek virtueel netwerk moet worden gebruikt. VirtualNetworkConfig-

ImageTemplateWindowsUpdateCustomizer

Naam Beschrijving Waarde
Filters Matrix met filters om updates te selecteren die moeten worden toegepast. Laat de lege matrix weg of geef deze op om de standaardwaarde te gebruiken (geen filter). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. tekenreeks[]
searchCriteria Criteria voor het zoeken naar updates. Laat de lege tekenreeks weg of geef deze op om de standaardreeks te gebruiken (zoek alles). Raadpleeg de bovenstaande koppeling voor voorbeelden en gedetailleerde beschrijving van dit veld. snaar
type Het type aanpassingsprogramma dat u wilt gebruiken op de afbeelding. 'Shell' kan bijvoorbeeld shell-customizer zijn 'WindowsUpdate' (vereist)
updateLimit Maximum aantal updates dat tegelijk moet worden toegepast. Laat 0 weg of geef 0 op om de standaardwaarde te gebruiken (1000) Int

Beperkingen:
Minimumwaarde = 0

Microsoft.VirtualMachineImages/imageTemplates

Naam Beschrijving Waarde
identiteit De identiteit van de afbeeldingssjabloon, indien geconfigureerd. ImageTemplateIdentity (vereist)
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[A-Za-z0-9-_.]{1,64}$ (vereist)
Eigenschappen De eigenschappen van de afbeeldingssjabloon ImageTemplateProperties-
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.VirtualMachineImages/imageTemplates@2024-02-01"

PlatformImagePurchasePlan

Naam Beschrijving Waarde
planName Naam van het aankoopplan. tekenreeks (vereist)
planProduct Product van het aankoopplan. tekenreeks (vereist)
planPublisher Uitgever van het aankoopplan. tekenreeks (vereist)

TargetRegion

Naam Beschrijving Waarde
naam De naam van de regio. tekenreeks (vereist)
replicaCount Het aantal replica's van de versie van de installatiekopieën dat in deze regio moet worden gemaakt. Laat het gebruik van de standaardwaarde weg (1). Int

Beperkingen:
Minimumwaarde = 1
storageAccountType Hiermee geeft u het type opslagaccount op dat moet worden gebruikt voor het opslaan van de installatiekopie in deze regio. Laat het gebruik van de standaardwaarde weg (Standard_LRS). 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

TrackedResourceTags

Naam Beschrijving Waarde

UserAssignedIdentities

Naam Beschrijving Waarde

UserAssignedIdentity

Naam Beschrijving Waarde

VirtualNetworkConfig

Naam Beschrijving Waarde
containerInstanceSubnetId Resource-id van een bestaand subnet waarop Azure Container Instance wordt geïmplementeerd voor geïsoleerde builds. Dit veld mag alleen worden opgegeven als subnetId ook is opgegeven en moet zich in hetzelfde virtuele netwerk bevinden als het subnet dat is opgegeven in subnetId. snaar
proxyVmSize De grootte van de virtuele proxymachine die wordt gebruikt om verkeer door te geven aan de build-VM en validatie-VM. Dit mag niet worden opgegeven als containerInstanceSubnetId is opgegeven omdat er in dat geval geen virtuele proxymachine wordt geïmplementeerd. Laat de lege tekenreeks weg of geef deze op om de standaardwaarde te gebruiken (Standard_A1_v2). snaar
subnetId Resource-id van een bestaand subnet waarop de build-VM en validatie-VM worden geïmplementeerd snaar