Microsoft.VirtualMachineImages imageTemplates 2021-10-01

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@2021-10-01' = {
  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
      userAssignedIdentities: [
        'string'
      ]
      vmSize: 'string'
      vnetConfig: {
        proxyVmSize: 'string'
        subnetId: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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'
  type: 'SharedImage'
}

Per VHD, usare:

{
  type: 'VHD'
}

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
}

Valori delle proprietà

ComponentsVrq145SchemasImagetemplateidentityPropertiesUserassignedidentitiesAdditionalproperties

Nome	Descrizione	Valore

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)

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	Elenco di identità utente associate al modello di immagine. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ImageTemplateIdentityUserAssignedIdentities

ImageTemplateIdentityUserAssignedIdentities

Nome	Descrizione	Valore

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[]

ImageTemplateProperties

Nome	Descrizione	Valore
buildTimeoutInMinutes	Durata massima di attesa durante la compilazione del modello di immagine. 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)
fonte	Specifica le proprietà utilizzate per descrivere l'immagine di origine.	ImageTemplateSource (obbligatorio)
vmProfile	Viene descritto come viene configurata la macchina virtuale per la compilazione di immagini	ImageTemplateVmProfile

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 raccolta immagini condivise	stringa (obbligatorio)
replicationRegions	Elenco di aree in cui verrà replicata l'immagine	string[] (obbligatorio)
storageAccountType	Tipo di account di archiviazione da usare per archiviare l'immagine condivisa. Omettere di usare il valore predefinito (Standard_LRS).	'Standard_LRS' 'Standard_ZRS'
digitare	Tipo di distribuzione.	'SharedImage' (obbligatorio)

ImageTemplateSharedImageVersionSource

Nome	Descrizione	Valore
imageVersionId	ID risorsa ARM della versione dell'immagine nella raccolta di immagini condivise	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)

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)

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. 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_D2ds_v4).	corda
vnetConfig	Configurazione facoltativa della rete virtuale da usare per distribuire la macchina virtuale di compilazione 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