Microsoft.VirtualMachineImages imageTemplates

Articolo
12/16/2024

Definizione di risorsa Bicep

Il tipo di risorsa imageTemplates può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.VirtualMachineImages/imageTemplates, aggiungere il bicep seguente al modello.

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

Oggetti ImageTemplateDistributor

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per ManagedImage, usare:

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

Per SharedImage, usare:

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

Per VHD, usare:

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

Oggetti DistributeVersioner

Impostare la proprietà schema per specificare il tipo di oggetto.

Per più recente, usare:

{
  major: int
  scheme: 'Latest'
}

Per origine, usare:

{
  scheme: 'Source'
}

Oggetti ImageTemplateCustomizer

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per File, usare:

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

Per PowerShell, usare:

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

Per Shell, usare:

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

Per WindowsRestart, usare:

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

Per WindowsUpdate, usare:

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

Oggetti ImageTemplateInVMValidator

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per File, usare:

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

Per PowerShell, usare:

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

Per Shell, usare:

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

Oggetti ImageTemplateSource

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per ManagedImage, usare:

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

Per PlatformImage, usare:

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

Per SharedImageVersion, usare:

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

Valori delle proprietà

DistributeVersioner

Nome	Descrizione	Valore
schema	Impostare su 'Latest' per il tipo DistributeVersionerLatest. Impostare su 'Source' per il tipo DistributeVersionerSource.	'Latest' 'Source' (obbligatorio)

DistributeVersionerLatest

Nome	Descrizione	Valore
maggiore	Versione principale per il numero di versione generato. Determinare che cos'è "latest" in base alle versioni con questo valore come versione principale. -1 equivale a lasciarlo non impostato.	Int Vincoli: Valore minimo = -1
schema	Schema di numerazione delle versioni da usare.	'Latest' (obbligatorio)

DistributeVersionerSource

Nome	Descrizione	Valore
schema	Schema di numerazione delle versioni da usare.	'Source' (obbligatorio)

ImageTemplateAutoRun

Nome	Descrizione	Valore
stato	L'abilitazione di questo campo attiverà una compilazione automatica alla creazione o all'aggiornamento del modello di immagine.	'Disabilitato' 'Enabled'

ImageTemplateCustomizer

Nome	Descrizione	Valore
nome	Nome descrittivo per fornire contesto sulle operazioni eseguite da questo passaggio di personalizzazione	corda
digitare	Impostare su 'File' per il tipo ImageTemplateFileCustomizer. Impostare su "PowerShell" per il tipo ImageTemplatePowerShellCustomizer. Impostare su "Shell" per il tipo ImageTemplateShellCustomizer. Impostare su "WindowsRestart" per il tipo ImageTemplateRestartCustomizer. Impostare su "WindowsUpdate" per il tipo ImageTemplateWindowsUpdateCustomizer.	'File' 'PowerShell' 'Shell' 'WindowsRestart' 'WindowsUpdate' (obbligatorio)

ImageTemplateDistributor

Nome	Descrizione	Valore
artifactTags	Tag che verranno applicati all'artefatto dopo che è stato creato/aggiornato dal server di distribuzione.	ImageTemplateDistributorArtifactTags
runOutputName	Nome da utilizzare per l'oggetto RunOutput associato.	corda Vincoli: Pattern = `^[A-Za-z0-9-_.]{1,64}$` (obbligatorio)
digitare	Impostare su 'ManagedImage' per il tipo ImageTemplateManagedImageDistributor. Impostare su 'SharedImage' per il tipo ImageTemplateSharedImageDistributor. Impostare su "VHD" per il tipo ImageTemplateVhdDistributor.	'ManagedImage' 'SharedImage' 'VHD' (obbligatorio)

ImageTemplateDistributorArtifactTags

Nome	Descrizione	Valore

ImageTemplateFileCustomizer

Nome	Descrizione	Valore
destinazione	Percorso assoluto di un file (con strutture di directory annidate già create) in cui il file (da sourceUri) verrà caricato nella macchina virtuale	corda
sha256Checksum	Checksum SHA256 del file fornito nel campo sourceUri precedente	corda
sourceUri	URI del file da caricare per personalizzare la macchina virtuale. Può essere un collegamento github, un URI di firma di accesso condiviso per Archiviazione di Azure e così via	corda
digitare	Tipo di strumento di personalizzazione da usare nell'immagine. Ad esempio, "Shell" può essere un addetto alla personalizzazione della shell	'File' (obbligatorio)

ImageTemplateFileValidator

Nome	Descrizione	Valore
destinazione	Percorso assoluto di un file (con strutture di directory annidate già create) in cui il file (da sourceUri) verrà caricato nella macchina virtuale	corda
sha256Checksum	Checksum SHA256 del file fornito nel campo sourceUri precedente	corda
sourceUri	URI del file da caricare nella macchina virtuale per la convalida. Può trattarsi di un collegamento github, un URI di Archiviazione di Azure (autorizzato o sas) e così via	corda
digitare	Tipo di convalida da usare nell'immagine. Ad esempio, "Shell" può essere la convalida della shell	'File' (obbligatorio)

ImageTemplateIdentity

Nome	Descrizione	Valore
digitare	Tipo di identità usata per il modello di immagine. Il tipo 'None' rimuoverà le identità dal modello di immagine.	'Nessuno' 'UserAssigned'
userAssignedIdentities	Set di identità assegnate dall'utente associate alla risorsa. Le chiavi del dizionario userAssignedIdentities saranno ID risorsa ARM nel formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. I valori del dizionario possono essere oggetti vuoti ({}) nelle richieste.	UserAssignedIdentities

ImageTemplateInVMValidator

Nome	Descrizione	Valore
nome	Nome descrittivo per fornire contesto sulle operazioni eseguite da questo passaggio di convalida	corda
digitare	Impostare su 'File' per il tipo ImageTemplateFileValidator. Impostare su "PowerShell" per il tipo ImageTemplatePowerShellValidator. Impostare su "Shell" per il tipo ImageTemplateShellValidator.	'File' 'PowerShell' 'Shell' (obbligatorio)

ImageTemplateManagedImageDistributor

Nome	Descrizione	Valore
imageId	ID risorsa dell'immagine del disco gestito	stringa (obbligatorio)
ubicazione	La posizione di Azure per l'immagine deve corrispondere se l'immagine esiste già	stringa (obbligatorio)
digitare	Tipo di distribuzione.	'ManagedImage' (obbligatorio)

ImageTemplateManagedImageSource

Nome	Descrizione	Valore
imageId	ID risorsa ARM dell'immagine gestita nella sottoscrizione del cliente	stringa (obbligatorio)
digitare	Specifica il tipo di immagine di origine da cui iniziare.	'ManagedImage' (obbligatorio)

ImageTemplatePlatformImageSource

Nome	Descrizione	Valore
offerta	Offerta di immagine dalla immagini della raccolta di Azure.	corda
planInfo	Configurazione facoltativa del piano di acquisto per l'immagine della piattaforma.	PlatformImagePurchasePlan
editore	Image Publisher in Azure Gallery Images.	corda
Sku	Sku dell'immagine dall'immagini della raccolta di Azure.	corda
digitare	Specifica il tipo di immagine di origine da cui iniziare.	'PlatformImage' (obbligatorio)
Versione	Versione dell'immagine dalla immagini della raccolta di Azure. Se in questo caso viene specificato "latest", la versione viene valutata quando viene eseguita la compilazione dell'immagine, non quando viene inviato il modello.	corda

ImageTemplatePowerShellCustomizer

Nome	Descrizione	Valore
Inline	Matrice di comandi di PowerShell da eseguire	string[]
runAsSystem	Se specificato, lo script di PowerShell verrà eseguito con privilegi elevati usando l'utente sistema locale. Può essere true solo quando il campo runElevated precedente è impostato su true.	Bool
runElevated	Se specificato, lo script di PowerShell verrà eseguito con privilegi elevati	Bool
scriptUri	URI dello script di PowerShell da eseguire per la personalizzazione. Può essere un collegamento github, un URI di firma di accesso condiviso per Archiviazione di Azure e così via	corda
sha256Checksum	Checksum SHA256 dello script power shell fornito nel campo scriptUri precedente	corda
digitare	Tipo di strumento di personalizzazione da usare nell'immagine. Ad esempio, "Shell" può essere un addetto alla personalizzazione della shell	'PowerShell' (obbligatorio)
validExitCodes	Codici di uscita validi per lo script di PowerShell. [Impostazione predefinita: 0]	int[]

ImageTemplatePowerShellValidator

Nome	Descrizione	Valore
Inline	Matrice di comandi di PowerShell da eseguire	string[]
runAsSystem	Se specificato, lo script di PowerShell verrà eseguito con privilegi elevati usando l'utente sistema locale. Può essere true solo quando il campo runElevated precedente è impostato su true.	Bool
runElevated	Se specificato, lo script di PowerShell verrà eseguito con privilegi elevati	Bool
scriptUri	URI dello script di PowerShell da eseguire per la convalida. Può essere un collegamento github, un URI di Archiviazione di Azure e così via	corda
sha256Checksum	Checksum SHA256 dello script power shell fornito nel campo scriptUri precedente	corda
digitare	Tipo di convalida da usare nell'immagine. Ad esempio, "Shell" può essere la convalida della shell	'PowerShell' (obbligatorio)
validExitCodes	Codici di uscita validi per lo script di PowerShell. [Impostazione predefinita: 0]	int[]

ImageTemplateProperties

Nome	Descrizione	Valore
Esecuzione automatica	Indica se eseguire o meno automaticamente la compilazione del modello di immagine durante la creazione o l'aggiornamento del modello.	ImageTemplateAutoRun
buildTimeoutInMinutes	Durata massima di attesa durante la compilazione del modello di immagine (include tutte le personalizzazioni, l'ottimizzazione, le convalide e le distribuzioni). Omettere o specificare 0 per usare il valore predefinito (4 ore).	Int Vincoli: Valore minimo = 0 Valore massimo = 960
Personalizza	Specifica le proprietà usate per descrivere i passaggi di personalizzazione dell'immagine, ad esempio Origine immagine e così via	ImageTemplateCustomizer[]
distribuire	Le destinazioni di distribuzione in cui l'output dell'immagine deve passare.	ImageTemplateDistributor[] (obbligatorio)
errorHandling	Opzioni di gestione degli errori in caso di errore di compilazione	ImageTemplatePropertiesErrorHandling
managedResourceTags	Tag che verranno applicati al gruppo di risorse e/o alle risorse create dal servizio.	ImageTemplatePropertiesManagedResourceTags
ottimizzare	Specifica l'ottimizzazione da eseguire sull'immagine.	ImageTemplatePropertiesOptimize
fonte	Specifica le proprietà utilizzate per descrivere l'immagine di origine.	ImageTemplateSource (obbligatorio)
stagingResourceGroup	ID del gruppo di risorse di staging nella stessa sottoscrizione del modello di immagine che verrà usato per compilare l'immagine. Se questo campo è vuoto, verrà creato un gruppo di risorse con un nome casuale. Se il gruppo di risorse specificato in questo campo non esiste, verrà creato con lo stesso nome. Se il gruppo di risorse specificato esiste, deve essere vuoto e nella stessa area del modello di immagine. Il gruppo di risorse creato verrà eliminato durante l'eliminazione del modello se questo campo è vuoto o il gruppo di risorse specificato non esiste, ma se il gruppo di risorse specificato esiste le risorse create nel gruppo di risorse verrà eliminato durante l'eliminazione del modello e il gruppo di risorse stesso rimarrà.	corda
convalidare	Opzioni di configurazione e elenco di convalide da eseguire sull'immagine risultante.	ImageTemplatePropertiesValidate
vmProfile	Viene descritto come viene configurata la macchina virtuale per la compilazione di immagini	ImageTemplateVmProfile

ImageTemplatePropertiesErrorHandling

Nome	Descrizione	Valore
onCustomizerError	Se si verifica un errore di personalizzazione e questo campo è impostato su "cleanup", la macchina virtuale di compilazione e le risorse di rete associate verranno pulite. Si tratta del comportamento predefinito. Se si verifica un errore di personalizzazione e questo campo è impostato su "abort", la macchina virtuale di compilazione verrà mantenuta.	'abort' 'cleanup'
onValidationError	Se si verifica un errore di convalida e questo campo è impostato su "cleanup", la macchina virtuale di compilazione e le risorse di rete associate verranno pulite. Si tratta del comportamento predefinito. Se si verifica un errore di convalida e questo campo è impostato su "abort", la macchina virtuale di compilazione verrà mantenuta.	'abort' 'cleanup'

ImageTemplatePropertiesManagedResourceTags

Nome	Descrizione	Valore

ImageTemplatePropertiesOptimize

Nome	Descrizione	Valore
vmBoot	L'ottimizzazione viene applicata all'immagine per un avvio di macchina virtuale più veloce.	ImageTemplatePropertiesOptimizeVmBoot

ImageTemplatePropertiesOptimizeVmBoot

Nome	Descrizione	Valore
stato	L'abilitazione di questo campo migliorerà il tempo di avvio della macchina virtuale ottimizzando l'output finale dell'immagine personalizzata.	'Disabilitato' 'Enabled'

ImageTemplatePropertiesValidate

Nome	Descrizione	Valore
continueDistributeOnFailure	Se la convalida ha esito negativo e questo campo è impostato su false, le immagini di output non verranno distribuite. Si tratta del comportamento predefinito. Se la convalida ha esito negativo e questo campo è impostato su true, le immagini di output verranno comunque distribuite. Usare questa opzione con cautela perché potrebbe causare la distribuzione di immagini non dannose per l'uso. In entrambi i casi (true o false), l'esecuzione dell'immagine end-to-end verrà segnalata come non riuscita in caso di errore di convalida. [Nota: questo campo non ha alcun effetto se la convalida ha esito positivo.]	Bool
inVMValidations	Elenco delle convalide da eseguire.	ImageTemplateInVMValidator[]
sourceValidationOnly	Se questo campo è impostato su true, l'immagine specificata nella sezione 'source' verrà convalidata direttamente. Non verrà eseguita alcuna compilazione separata per generare e quindi convalidare un'immagine personalizzata.	Bool

ImageTemplateRestartCustomizer

Nome	Descrizione	Valore
restartCheckCommand	Comando per verificare se il riavvio è riuscito [Impostazione predefinita: '']	corda
restartCommand	Comando per eseguire il riavvio [Impostazione predefinita: 'shutdown /r /f /t 0 /c "packer restart"']	corda
restartTimeout	Timeout di riavvio specificato come stringa di grandezza e unità, ad esempio '5m' (5 minuti) o '2h' (2 ore) [Impostazione predefinita: '5m']	corda
digitare	Tipo di strumento di personalizzazione da usare nell'immagine. Ad esempio, "Shell" può essere un addetto alla personalizzazione della shell	'WindowsRestart' (obbligatorio)

ImageTemplateSharedImageDistributor

Nome	Descrizione	Valore
excludeFromLatest	Flag che indica se la versione dell'immagine creata deve essere esclusa dalla versione più recente. Omettere di usare il valore predefinito (false).	Bool
galleryImageId	ID risorsa dell'immagine della raccolta di calcolo di Azure	stringa (obbligatorio)
replicationRegions	[Deprecato] Elenco di aree in cui verrà replicata l'immagine. Questo elenco può essere specificato solo se targetRegions non è specificato. Questo campo è deprecato: usare invece targetRegions.	string[]
storageAccountType	[Deprecato] Tipo di account di archiviazione da usare per archiviare l'immagine condivisa. Omettere di usare il valore predefinito (Standard_LRS). Questo campo può essere specificato solo se si specifica replicationRegions. Questo campo è deprecato: usare invece targetRegions.	'Premium_LRS' 'Standard_LRS' 'Standard_ZRS'
targetRegions	Le aree di destinazione in cui verrà replicata la versione dell'immagine distribuita. Questo oggetto sostituisce replicationRegions e può essere specificato solo se replicationRegions non è specificato.	TargetRegion[]
digitare	Tipo di distribuzione.	'SharedImage' (obbligatorio)
controllo delle versioni	Viene descritto come generare il nuovo numero di versione x.y.z per la distribuzione.	DistributeVersioner

ImageTemplateSharedImageVersionSource

Nome	Descrizione	Valore
imageVersionId	ID risorsa ARM della versione dell'immagine. Quando il nome della versione dell'immagine è 'latest', la versione viene valutata quando viene eseguita la compilazione dell'immagine.	stringa (obbligatorio)
digitare	Specifica il tipo di immagine di origine da cui iniziare.	'SharedImageVersion' (obbligatorio)

ImageTemplateShellCustomizer

Nome	Descrizione	Valore
Inline	Matrice di comandi della shell da eseguire	string[]
scriptUri	URI dello script della shell da eseguire per la personalizzazione. Può essere un collegamento github, un URI di firma di accesso condiviso per Archiviazione di Azure e così via	corda
sha256Checksum	Checksum SHA256 dello script della shell fornito nel campo scriptUri	corda
digitare	Tipo di strumento di personalizzazione da usare nell'immagine. Ad esempio, "Shell" può essere un addetto alla personalizzazione della shell	'Shell' (obbligatorio)

ImageTemplateShellValidator

Nome	Descrizione	Valore
Inline	Matrice di comandi della shell da eseguire	string[]
scriptUri	URI dello script della shell da eseguire per la convalida. Può essere un collegamento github, un URI di Archiviazione di Azure e così via	corda
sha256Checksum	Checksum SHA256 dello script della shell fornito nel campo scriptUri	corda
digitare	Tipo di convalida da usare nell'immagine. Ad esempio, "Shell" può essere la convalida della shell	'Shell' (obbligatorio)

ImageTemplateSource

Nome	Descrizione	Valore
digitare	Impostare su 'ManagedImage' per il tipo ImageTemplateManagedImageSource. Impostare su 'PlatformImage' per il tipo ImageTemplatePlatformImageSource. Impostare su 'SharedImageVersion' per il tipo ImageTemplateSharedImageVersionSource.	'ManagedImage' 'PlatformImage' 'SharedImageVersion' (obbligatorio)

ImageTemplateVhdDistributor

Nome	Descrizione	Valore
digitare	Tipo di distribuzione.	'VHD' (obbligatorio)
Uri	URI facoltativo di Archiviazione di Azure per il BLOB VHD distribuito. Omettere di usare la stringa predefinita (stringa vuota), nel qual caso il disco rigido virtuale verrà pubblicato nell'account di archiviazione nel gruppo di risorse di staging.	corda

ImageTemplateVmProfile

Nome	Descrizione	Valore
osDiskSizeGB	Dimensioni del disco del sistema operativo in GB. Omettere o specificare 0 per usare le dimensioni predefinite del disco del sistema operativo di Azure.	Int Vincoli: Valore minimo = 0
userAssignedIdentities	Matrice facoltativa di ID risorsa di identità gestite assegnate dall'utente da configurare nella macchina virtuale di compilazione e nella macchina virtuale di convalida. Ciò può includere l'identità del modello di immagine.	string[]
vmSize	Dimensioni della macchina virtuale usata per compilare, personalizzare e acquisire immagini. Omettere o specificare una stringa vuota per usare il valore predefinito (Standard_D1_v2 per le immagini Gen1 e Standard_D2ds_v4 per le immagini Gen2).	corda
vnetConfig	Configurazione facoltativa della rete virtuale da usare per distribuire la macchina virtuale di compilazione e la macchina virtuale di convalida in . Omettere se non è necessario usare una rete virtuale specifica.	VirtualNetworkConfig

ImageTemplateWindowsUpdateCustomizer

Nome	Descrizione	Valore
filtri	Matrice di filtri per selezionare gli aggiornamenti da applicare. Omettere o specificare una matrice vuota per usare il valore predefinito (nessun filtro). Fare riferimento al collegamento precedente per esempi e descrizione dettagliata di questo campo.	string[]
searchCriteria	Criteri per la ricerca degli aggiornamenti. Omettere o specificare una stringa vuota per usare il valore predefinito (cerca tutto). Fare riferimento al collegamento precedente per esempi e descrizione dettagliata di questo campo.	corda
digitare	Tipo di strumento di personalizzazione da usare nell'immagine. Ad esempio, "Shell" può essere un addetto alla personalizzazione della shell	'WindowsUpdate' (obbligatorio)
updateLimit	Numero massimo di aggiornamenti da applicare alla volta. Omettere o specificare 0 per usare il valore predefinito (1000)	Int Vincoli: Valore minimo = 0