Microsoft.VirtualMachineImages imageTemplates

Článek
12/17/2024

nejnovější
2024-02-01
2023-07-01
2022-07-07
2022-02-14
10. 10. 2021
2020-02-14
2019-05-01-Preview
2019-02-01-preview
2018-02-01-Preview

Definice prostředku Bicep

Typ prostředku imageTemplates je možné nasadit s operacemi, které cílí:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.VirtualMachineImages/imageTemplates, přidejte do šablony následující bicep.

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 – objekty

Nastavte typ vlastnost určit typ objektu.

Pro ManagedImagepoužijte:

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

Pro SharedImagepoužijte:

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

Pro virtuálního pevného disku použijte:

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

DistributeVersioner – objekty

Nastavte schéma vlastnost určit typ objektu.

Pro Nejnovějšípoužijte:

{
  major: int
  scheme: 'Latest'
}

Pro zdrojovápoužijte:

{
  scheme: 'Source'
}

ImageTemplateCustomizer – objekty

Nastavte typ vlastnost určit typ objektu.

Prosoubor použijte:

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

Pro PowerShellpoužijte:

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

Proprostředí použijte:

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

Pro windowsRestartpoužijte:

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

Pro WindowsUpdatepoužijte:

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

ImageTemplateInVMValidator – objekty

Nastavte typ vlastnost určit typ objektu.

Prosoubor použijte:

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

Pro PowerShellpoužijte:

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

Proprostředí použijte:

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

ImageTemplateSource – objekty

Nastavte typ vlastnost určit typ objektu.

Pro ManagedImagepoužijte:

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

Pro PlatformImage použijte:

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

Pro SharedImageVersionpoužijte:

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

Hodnoty vlastností

DistributeVersioner

Jméno	Popis	Hodnota
schéma	Pro typ DistributeVersionerLatestna hodnotu Latest . Nastavte na Source pro typ DistributeVersionerSource.	Nejnovější Zdroj (povinné)

DistributeVersionerLatest

Jméno	Popis	Hodnota
major	Hlavní verze pro vygenerované číslo verze Zjistěte, co je nejnovější na základě verzí s touto hodnotou jako hlavní verze. -1 je ekvivalentem ponechání nenasazené sady.	Int Omezení: Minimální hodnota = -1
schéma	Schéma číslování verzí, které se má použít.	Nejnovější (povinné)

DistributeVersionerSource

Jméno	Popis	Hodnota
schéma	Schéma číslování verzí, které se má použít.	Zdroj (povinné)

ImageTemplateAutoRun

Jméno	Popis	Hodnota
stát	Povolením tohoto pole se aktivuje automatické sestavení při vytváření nebo aktualizaci šablony image.	Zakázáno Povoleno

ImageTemplateCustomizer

Jméno	Popis	Hodnota
Jméno	Popisný název, který poskytuje kontext k tomu, co tento krok přizpůsobení dělá	řetězec
typ	Pro typ ImageTemplateFileCustomizernastavte hodnotu File . Nastavte na PowerShell pro typ ImageTemplatePowerShellCustomizer. Nastavte na Shell pro typ ImageTemplateShellCustomizer. Pro typ ImageTemplateRestartCustomizernastavte hodnotu WindowsRestart. Nastavte hodnotu WindowsUpdate pro typ ImageTemplateWindowsUpdateCustomizer.	"Soubor" PowerShell Shell WindowsRestart WindowsUpdate (povinné)

ImageTemplateDistributor

Jméno	Popis	Hodnota
artifactTags	Značky, které se po vytvoření nebo aktualizaci distributora použijí na artefakt.	ImageTemplateDistributorArtifactTags
runOutputName	Název, který se má použít pro přidružený RunOutput.	řetězec Omezení: Model = `^[A-Za-z0-9-_.]{1,64}$` (povinné)
typ	Nastavte na ManagedImage pro typ ImageTemplateManagedImageDistributor. Nastavte na SharedImage pro typ ImageTemplateSharedImageDistributor. Nastavte na VHD pro typ ImageTemplateVhdDistributor.	ManagedImage SharedImage VHD (povinné)

ImageTemplateDistributorArtifactTags

Jméno	Popis	Hodnota

ImageTemplateFileCustomizer

Jméno	Popis	Hodnota
cíl	Absolutní cesta k souboru (s již vytvořenými vnořenými adresářovými strukturami), do kterého se soubor (ze zdrojového identifikátoruURI) nahraje do virtuálního počítače.	řetězec
sha256Checksum	Kontrolní součet souboru SHA256 uvedený v poli sourceUri výše	řetězec
sourceUri	Identifikátor URI souboru, který se má nahrát pro přizpůsobení virtuálního počítače. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.	řetězec
typ	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.	"Soubor" (povinné)

ImageTemplateFileValidator

Jméno	Popis	Hodnota
cíl	Absolutní cesta k souboru (s již vytvořenými vnořenými adresářovými strukturami), do kterého se soubor (ze zdrojového identifikátoruURI) nahraje do virtuálního počítače.	řetězec
sha256Checksum	Kontrolní součet souboru SHA256 uvedený v poli sourceUri výše	řetězec
sourceUri	Identifikátor URI souboru, který se má nahrát do virtuálního počítače pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage (autorizovaný nebo SAS) atd.	řetězec
typ	Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.	"Soubor" (povinné)

ImageTemplateIdentity

Jméno	Popis	Hodnota
typ	Typ identity používané pro šablonu obrázku. Typ None odebere ze šablony obrázku všechny identity.	None (Žádný) UserAssigned
userAssignedIdentities	Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.	userAssignedIdentities

ImageTemplateInVMValidator

Jméno	Popis	Hodnota
Jméno	Popisný název, který poskytuje kontext k tomu, co tento krok ověření dělá	řetězec
typ	Pro typ ImageTemplateFileValidatorna hodnotu File . Nastavte na PowerShell pro typ ImageTemplatePowerShellValidator. Nastavte na Shell pro typ ImageTemplateShellValidator.	"Soubor" PowerShell Shell (povinné)

ImageTemplateManagedImageDistributor

Jméno	Popis	Hodnota
imageId	ID prostředku image spravovaného disku	string (povinné)
umístění	Umístění Azure pro image by se mělo shodovat, pokud image již existuje.	string (povinné)
typ	Typ distribuce.	ManagedImage (povinné)

ImageTemplateManagedImageSource

Jméno	Popis	Hodnota
imageId	ID prostředku ARM spravované image v předplatném zákazníka	string (povinné)
typ	Určuje typ zdrojové image, se kterou chcete začít.	ManagedImage (povinné)

ImageTemplatePlatformImageSource

Jméno	Popis	Hodnota
nabídnout	Image offer from the Azure Gallery Images.	řetězec
planInfo	Volitelná konfigurace nákupního plánu pro image platformy	PlatformImagePurchasePlan
vydavatel	Image Publisher v imagích galerie Azure.	řetězec
sku	SKU obrázku zimagí galerie Azure .	řetězec
typ	Určuje typ zdrojové image, se kterou chcete začít.	PlatformImage (povinné)
verze	Verze image z image galerie Azure. Pokud je zde zadána hodnota latest, vyhodnotí se verze, když se sestavení image provede, ne při odeslání šablony.	řetězec

ImageTemplatePowerShellCustomizer

Jméno	Popis	Hodnota
vložený	Pole příkazů PowerShellu pro spuštění	string[]
runAsSystem	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními pomocí uživatele místního systému. Může být true pouze v případech, kdy je výše uvedené pole runElevated nastaveno na hodnotu true.	Bool
runElevated	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními.	Bool
scriptUri	Identifikátor URI skriptu PowerShellu, který se má spustit pro přizpůsobení. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.	řetězec
sha256Checksum	Kontrolní součet SHA256 skriptu power shellu uvedený v poli scriptUri výše	řetězec
typ	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.	PowerShell (povinné)
validExitCodes	Platné ukončovací kódy pro skript PowerShellu [Výchozí: 0]	int[]

ImageTemplatePowerShellValidator

Jméno	Popis	Hodnota
vložený	Pole příkazů PowerShellu pro spuštění	string[]
runAsSystem	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními pomocí uživatele místního systému. Může být true pouze v případech, kdy je výše uvedené pole runElevated nastaveno na hodnotu true.	Bool
runElevated	Pokud je zadáno, skript PowerShellu se spustí se zvýšenými oprávněními.	Bool
scriptUri	Identifikátor URI skriptu PowerShellu, který se má spustit pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage atd.	řetězec
sha256Checksum	Kontrolní součet SHA256 skriptu power shellu uvedený v poli scriptUri výše	řetězec
typ	Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.	PowerShell (povinné)
validExitCodes	Platné ukončovací kódy pro skript PowerShellu [Výchozí: 0]	int[]

ImageTemplateProperties

Jméno	Popis	Hodnota
automatické spuštění	Určuje, zda se má šablona image automaticky spouštět při vytváření nebo aktualizaci šablony.	ImageTemplateAutoRun
buildTimeoutInMinutes	Maximální doba čekání při sestavování šablony image (zahrnuje všechna přizpůsobení, optimalizaci, ověřování a distribuce). Vynecháte nebo zadejte hodnotu 0, která se má použít jako výchozí (4 hodiny).	Int Omezení: Minimální hodnota = 0 Maximální hodnota = 960
přizpůsobit	Určuje vlastnosti použité k popisu kroků přizpůsobení obrázku, jako je zdroj image atd.	ImageTemplateCustomizer[]
distribuovat	Distribuční cíle, kam je potřeba výstup obrázku přejít.	ImageTemplateDistributor[] (povinné)
errorHandling	Možnosti zpracování chyb při selhání sestavení	imageTemplatePropertiesErrorHandling
managedResourceTags	Značky, které se použijí pro skupinu prostředků nebo prostředky vytvořené službou.	ImageTemplatePropertiesManagedResourceTags
optimalizovat	Určuje optimalizaci, která se má provést na imagi.	ImageTemplatePropertiesOptimize
zdroj	Určuje vlastnosti použité k popisu zdrojové image.	imageTemplateSource (povinné)
stagingResourceGroup	ID pracovní skupiny prostředků ve stejném předplatném jako šablona image, která se použije k sestavení image. Pokud je toto pole prázdné, vytvoří se skupina prostředků s náhodným názvem. Pokud skupina prostředků zadaná v tomto poli neexistuje, vytvoří se se stejným názvem. Pokud zadaná skupina prostředků existuje, musí být prázdná a ve stejné oblasti jako šablona obrázku. Vytvořená skupina prostředků se odstraní během odstraňování šablony, pokud je toto pole prázdné nebo zadaná skupina prostředků neexistuje, ale pokud zadaná skupina prostředků existuje, odstraní se prostředky vytvořené ve skupině prostředků během odstranění šablony a skupina prostředků zůstane sama.	řetězec
ověřit	Možnosti konfigurace a seznam ověření, která se mají provést na výsledné imagi.	imageTemplatePropertiesValidate
vmProfile	Popisuje, jak je virtuální počítač nastavený tak, aby se sestavily image.	imageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Jméno	Popis	Hodnota
onCustomizerError	Pokud dojde k chybě úpravce a toto pole je nastavené na vyčištění, virtuální počítač sestavení a přidružené síťové prostředky se vyčistí. Toto je výchozí chování. Pokud dojde k chybě úpravce a toto pole je nastavené na přerušení, zachová se virtuální počítač sestavení.	"přerušeno" "vyčištění"
onValidationError	Pokud dojde k chybě ověření a toto pole je nastavené na vyčištění, virtuální počítač sestavení a přidružené síťové prostředky se vyčistí. Toto je výchozí chování. Pokud dojde k chybě ověření a toto pole je nastavené na přerušení, zachová se virtuální počítač sestavení.	"přerušeno" "vyčištění"

ImageTemplatePropertiesManagedResourceTags

Jméno	Popis	Hodnota

ImageTemplatePropertiesOptimize

Jméno	Popis	Hodnota
vmBoot	Optimalizace se použije na imagi pro rychlejší spuštění virtuálního počítače.	ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Jméno	Popis	Hodnota
stát	Povolením tohoto pole se zlepší doba spouštění virtuálního počítače optimalizací konečného přizpůsobeného výstupu image.	Zakázáno Povoleno

ImageTemplatePropertiesValidate

Jméno	Popis	Hodnota
continueDistributeOnFailure	Pokud se ověření nezdaří a toto pole je nastavené na false, výstupní image nebudou distribuovány. Toto je výchozí chování. Pokud se ověření nezdaří a toto pole je nastavené na true, výstupní image se budou dál distribuovat. Tuto možnost použijte s opatrností, protože může vést k distribuci špatných obrázků pro použití. V oboupřípadechch kódech se zobrazí v obou případech [Poznámka: Toto pole nemá žádný vliv, pokud bude ověření úspěšné.]	Bool
inVMValidations	Seznam ověření, která se mají provést.	ImageTemplateInVMValidator[]
sourceValidationOnly	Pokud je toto pole nastaveno na true, obrázek zadaný ve zdrojové části se ověří přímo. K vygenerování a ověření přizpůsobené image se nespustí žádné samostatné sestavení.	Bool

ImageTemplateRestartCustomizer

Jméno	Popis	Hodnota
restartCheckCommand	Příkaz, který zkontroluje, jestli restartování proběhlo úspěšně [Výchozí: '']	řetězec
restartCommand	Příkaz pro spuštění restartování [Výchozí: "shutdown /r /f /t 0 /c "packer restart"']	řetězec
restartTimeout	Časový limit restartování zadaný jako řetězec velikosti a jednotky, například 5 min (5 minut) nebo 2h (2 hodiny) [Výchozí hodnota: 5 min]	řetězec
typ	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.	WindowsRestart (povinné)

ImageTemplateSharedImageDistributor

Jméno	Popis	Hodnota
excludeFromLatest	Příznak označující, jestli má být vytvořená verze image vyloučena z nejnovější verze. Vynecháte použití výchozí hodnoty (false).	Bool
galleryImageId	ID prostředku image Galerie výpočetních prostředků Azure	string (povinné)
replicationRegions	[Zastaralé] Seznam oblastí, do kterých se image bude replikovat. Tento seznam lze zadat pouze v případě, že cílové oblasti nejsou zadány. Toto pole je zastaralé – místo toho použijte cílové oblasti.	string[]
storageAccountType	[Zastaralé] Typ účtu úložiště, který se má použít k uložení sdílené image. Vynecháte použití výchozího nastavení (Standard_LRS). Toto pole lze zadat pouze v případě, že je zadána oblast replikace. Toto pole je zastaralé – místo toho použijte cílové oblasti.	"Premium_LRS" "Standard_LRS" "Standard_ZRS"
targetRegions	Cílové oblasti, do kterých se distribuovaná verze image bude replikovat. Tento objekt nahrazuje oblasti replikace a lze jej zadat pouze v případě, že není zadána oblast replikace.	TargetRegion[]
typ	Typ distribuce.	SharedImage (povinné)
správa verzí	Popisuje, jak vygenerovat nové číslo verze x.y.z pro distribuci.	DistributeVersioner

ImageTemplateSharedImageVersionSource

Jméno	Popis	Hodnota
imageVersionId	ID prostředku ARM verze image. Pokud je název verze image "latest", vyhodnotí se verze při sestavení image.	string (povinné)
typ	Určuje typ zdrojové image, se kterou chcete začít.	SharedImageVersion (povinné)

ImageTemplateShellCustomizer

Jméno	Popis	Hodnota
vložený	Pole příkazů prostředí ke spuštění	string[]
scriptUri	Identifikátor URI skriptu prostředí, který se má spustit pro přizpůsobení. Může to být odkaz githubu, identifikátor URI SAS pro Azure Storage atd.	řetězec
sha256Checksum	Kontrolní součet sha256 skriptu prostředí zadaného v poli scriptUri	řetězec
typ	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.	Shell (povinné)

ImageTemplateShellValidator

Jméno	Popis	Hodnota
vložený	Pole příkazů prostředí ke spuštění	string[]
scriptUri	Identifikátor URI skriptu prostředí, který se má spustit pro ověření. Může to být odkaz githubu, identifikátor URI služby Azure Storage atd.	řetězec
sha256Checksum	Kontrolní součet sha256 skriptu prostředí zadaného v poli scriptUri	řetězec
typ	Typ ověření, který chcete použít na obrázku. Například "Shell" může být ověření prostředí.	Shell (povinné)

ImageTemplateSource

Jméno	Popis	Hodnota
typ	Nastavte na ManagedImage pro typ ImageTemplateManagedImageSource. Nastavte na PlatformImage pro typ ImageTemplatePlatformImageSource. Nastavte na SharedImageVersion pro typ ImageTemplateSharedImageVersionSource.	ManagedImage PlatformImage SharedImageVersion (povinné)

ImageTemplateVhdDistributor

Jméno	Popis	Hodnota
typ	Typ distribuce.	VHD (povinné)
identifikátor uri	Volitelný identifikátor URI služby Azure Storage pro distribuovaný objekt blob virtuálního pevného disku Vynecháte použití výchozího (prázdného řetězce), v takovém případě se virtuální pevný disk publikuje do účtu úložiště v pracovní skupině prostředků.	řetězec

ImageTemplateVmProfile

Jméno	Popis	Hodnota
osDiskSizeGB	Velikost disku s operačním systémem v GB Vynecháte nebo zadejte hodnotu 0 pro použití výchozí velikosti disku s operačním systémem Azure.	Int Omezení: Minimální hodnota = 0
userAssignedIdentities	Volitelné pole ID prostředků spravovaných identit přiřazených uživatelem, které se mají nakonfigurovat na virtuálním počítači sestavení a ověření. Může to zahrnovat identitu šablony obrázku.	string[]
vmSize	Velikost virtuálního počítače použitého k sestavení, přizpůsobení a zachycení imagí Vynecháte nebo zadejte prázdný řetězec, který se má použít jako výchozí (Standard_D1_v2 pro image Gen1 a Standard_D2ds_v4 pro image Gen2).	řetězec
vnetConfig	Volitelná konfigurace virtuální sítě, která se má použít k nasazení virtuálního počítače sestavení a ověření virtuálního počítače. Vynecháte, pokud není potřeba použít žádnou konkrétní virtuální síť.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Jméno	Popis	Hodnota
filtruje	Polefiltrůch Vynechání nebo zadání prázdného pole pro použití výchozího pole (bez filtru) Příklady a podrobný popis tohoto pole najdete na výše uvedeném odkazu.	string[]
searchCriteria	Kritéria pro vyhledávání aktualizací Vynecháte nebo zadejte prázdný řetězec, který se má použít jako výchozí (prohledávat vše). Příklady a podrobný popis tohoto pole najdete na výše uvedeném odkazu.	řetězec
typ	Typ nástroje pro přizpůsobení, který chcete použít na obrázku. Například "Shell" může být úpravce prostředí.	WindowsUpdate (povinné)
updateLimit	Maximální početaktualizacích Vynechání nebo zadání hodnoty 0 pro použití výchozího nastavení (1000)	Int Omezení: Minimální hodnota = 0