Microsoft.VirtualMachineImages imageTemplates 2020-02-14

Artikel
12/17/2024

Bicep-resourcedefinitie

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

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

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@2020-02-14' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    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
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
    vmProfile: {
      osDiskSizeGB: int
      vmSize: 'string'
      vnetConfig: {
        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'
  type: 'SharedImage'
}

Gebruik voor VHD-:

{
  type: 'VHD'
}

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

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
}

Eigenschapswaarden

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam	Beschrijving	Waarde

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)

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 lijst met gebruikersidentiteiten die zijn gekoppeld aan de afbeeldingssjabloon. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Naam	Beschrijving	Waarde

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. Het opgeven van 'nieuwste' kan ROUNDTRIP_INCONSISTENT_PROPERTY probleem veroorzaken dat wordt opgelost.	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[]

ImageTemplateProperties

Naam	Beschrijving	Waarde
buildTimeoutInMinutes	Maximale duur die moet worden gewacht tijdens het bouwen van de afbeeldingssjabloon. 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)
bron	Hiermee geeft u de eigenschappen op die worden gebruikt om de broninstallatiekopieën te beschrijven.	ImageTemplateSource (vereist)
vmProfile	Beschrijft hoe de virtuele machine is ingesteld voor het bouwen van installatiekopieën	ImageTemplateVmProfile

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 installatiekopieëngalerie met gedeelde installatiekopieën	tekenreeks (vereist)
replicationRegions	Een lijst met regio's waarnaar de installatiekopieën worden gerepliceerd	tekenreeks[] (vereist)
storageAccountType	Het type opslagaccount dat moet worden gebruikt voor het opslaan van de gedeelde installatiekopie. Laat het gebruik van de standaardwaarde weg (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'
type	Type distributie.	SharedImage (vereist)

ImageTemplateSharedImageVersionSource

Naam	Beschrijving	Waarde
imageVersionId	ARM-resource-id van de versie van de installatiekopieën in de galerie met gedeelde installatiekopieën	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)

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)

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
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 virtuele buildmachine 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