Microsoft.VirtualMachineImages imageTemplates 2019-02-01-preview

Définition de ressource Bicep

Le type de ressource imageTemplates peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    customize: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ]
    distribute: [
      {
        artifactTags: {}
        runOutputName: 'string'
        type: 'string'
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ]
    source: {
      type: 'string'
      // For remaining properties, see ImageTemplateSource objects
    }
  }
}

Objets ImageTemplateCustomizer

Définissez le type propriété pour spécifier le type d’objet.

Pour PowerShell, utilisez :

  type: 'PowerShell'
  inline: [
    'string'
  ]
  script: 'string'
  validExitCodes: [
    int
  ]

Pour Shell, utilisez :

  type: 'Shell'
  inline: [
    'string'
  ]
  script: 'string'

Pour windowsRestart, utilisez :

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

Objets ImageTemplateDistributor

Définissez le type propriété pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

  type: 'ManagedImage'
  imageId: 'string'
  location: 'string'

Pour SharedImage, utilisez :

  type: 'SharedImage'
  galleryImageId: 'string'
  replicationRegions: [
    'string'
  ]

Pour de disque dur virtuel, utilisez :

  type: 'VHD'

Objets ImageTemplateSource

Définissez le type propriété pour spécifier le type d’objet.

Pour ISO, utilisez :

  type: 'ISO'
  sha256Checksum: 'string'
  sourceURI: 'string'

Pour ManagedImage, utilisez :

  type: 'ManagedImage'
  imageId: 'string'

Pour PlatformImage, utilisez :

  type: 'PlatformImage'
  offer: 'string'
  publisher: 'string'
  sku: 'string'
  version: 'string'

Valeurs de propriété

imageTemplates

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement des ressources chaîne (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Propriétés ImageTemplateProperties

ImageTemplateProperties

Nom Description Valeur
Personnaliser Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source d’image, etc. ImageTemplateCustomizer[]
distribuer Cible de distribution vers laquelle la sortie de l’image doit être générée. ImageTemplateDistributor[] (obligatoire)
source Spécifie les propriétés utilisées pour décrire l’image source. ImageTemplateSource (obligatoire)

ImageTemplateCustomizer

Nom Description Valeur
nom Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation corde
type Définir le type d’objet PowerShell
Shell
windowsRestart (obligatoire)

ImageTemplatePowerShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'PowerShell' (obligatoire)
Inline Tableau de commandes PowerShell à exécuter string[]
script Script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde
validExitCodes Codes de sortie valides pour le script PowerShell. [Par défaut : 0] int[]

ImageTemplateShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'Shell' (obligatoire)
Inline Tableau de commandes shell à exécuter string[]
script Script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde

ImageTemplateRestartCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'WindowsRestart' (obligatoire)
restartCheckCommand Commande pour vérifier si le redémarrage a réussi [Valeur par défaut : ''] corde
restartCommand Commande pour exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"'] corde
restartTimeout Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5 m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m » ] corde

ImageTemplateDistributor

Nom Description Valeur
artifactTags Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution. objet
runOutputName Nom à utiliser pour le RunOutput associé. chaîne (obligatoire)

Contraintes:
Modèle = ^[A-Za-z0-9-_]{1,64}$
type Définir le type d’objet ManagedImage
SharedImage
disque dur virtuel (obligatoire)

ImageTemplateManagedImageDistributor

Nom Description Valeur
type Type de distribution. 'ManagedImage' (obligatoire)
imageId ID de ressource de l’image de disque managé chaîne (obligatoire)
emplacement Emplacement Azure de l’image, doit correspondre si l’image existe déjà chaîne (obligatoire)

ImageTemplateSharedImageDistributor

Nom Description Valeur
type Type de distribution. 'SharedImage' (obligatoire)
galleryImageId ID de ressource de l’image de la galerie d’images partagées chaîne (obligatoire)
replicationRegions string[] (obligatoire)

ImageTemplateVhdDistributor

Nom Description Valeur
type Type de distribution. 'VHD' (obligatoire)

ImageTemplateSource

Nom Description Valeur
type Définir le type d’objet ISO
ManagedImage
PlatformImage (obligatoire)

ImageTemplateIsoSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'ISO' (obligatoire)
sha256Checksum Somme de contrôle SHA256 de l’image ISO. chaîne (obligatoire)
sourceURI URI pour obtenir l’image ISO. Cet URI doit être accessible au fournisseur de ressources au moment de la création du modèle d’image. chaîne (obligatoire)

ImageTemplateManagedImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'ManagedImage' (obligatoire)
imageId ID de ressource ARM de l’image managée dans l’abonnement client chaîne (obligatoire)

ImageTemplatePlatformImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'PlatformImage' (obligatoire)
offrir Offre d’image à partir des images de la galerie Azure . corde
éditeur Éditeur d’images dans Azure Gallery Images. corde
Sku Référence sku d’image à partir des images de la galerie Azure . corde
Version Version d’image à partir des images de la galerie Azure . corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Azure Image Builder avec azure Windows Baseline

Déployer sur Azure
Crée un environnement Azure Image Builder et génère une image Windows Server avec les dernières mises à jour Windows et la base de référence Azure Windows appliquée.
configurer le service Dev Box

Déployer sur Azure
Ce modèle créerait toutes les ressources d’administration Dev Box en fonction du guide de démarrage rapide de Dev Box (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première zone de développement.

Définition de ressource de modèle ARM

Le type de ressource imageTemplates peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.VirtualMachineImages/imageTemplates",
  "apiVersion": "2019-02-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "customize": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateCustomizer objects
      }
    ],
    "distribute": [
      {
        "artifactTags": {},
        "runOutputName": "string",
        "type": "string"
        // For remaining properties, see ImageTemplateDistributor objects
      }
    ],
    "source": {
      "type": "string"
      // For remaining properties, see ImageTemplateSource objects
    }
  }
}

Objets ImageTemplateCustomizer

Définissez le type propriété pour spécifier le type d’objet.

Pour PowerShell, utilisez :

  "type": "PowerShell",
  "inline": [ "string" ],
  "script": "string",
  "validExitCodes": [ "int" ]

Pour Shell, utilisez :

  "type": "Shell",
  "inline": [ "string" ],
  "script": "string"

Pour windowsRestart, utilisez :

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

Objets ImageTemplateDistributor

Définissez le type propriété pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

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

Pour SharedImage, utilisez :

  "type": "SharedImage",
  "galleryImageId": "string",
  "replicationRegions": [ "string" ]

Pour de disque dur virtuel, utilisez :

  "type": "VHD"

Objets ImageTemplateSource

Définissez le type propriété pour spécifier le type d’objet.

Pour ISO, utilisez :

  "type": "ISO",
  "sha256Checksum": "string",
  "sourceURI": "string"

Pour ManagedImage, utilisez :

  "type": "ManagedImage",
  "imageId": "string"

Pour PlatformImage, utilisez :

  "type": "PlatformImage",
  "offer": "string",
  "publisher": "string",
  "sku": "string",
  "version": "string"

Valeurs de propriété

imageTemplates

Nom Description Valeur
type Type de ressource 'Microsoft.VirtualMachineImages/imageTemplates'
apiVersion Version de l’API de ressource '2019-02-01-preview'
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement des ressources chaîne (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Propriétés ImageTemplateProperties

ImageTemplateProperties

Nom Description Valeur
Personnaliser Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source d’image, etc. ImageTemplateCustomizer[]
distribuer Cible de distribution vers laquelle la sortie de l’image doit être générée. ImageTemplateDistributor[] (obligatoire)
source Spécifie les propriétés utilisées pour décrire l’image source. ImageTemplateSource (obligatoire)

ImageTemplateCustomizer

Nom Description Valeur
nom Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation corde
type Définir le type d’objet PowerShell
Shell
windowsRestart (obligatoire)

ImageTemplatePowerShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'PowerShell' (obligatoire)
Inline Tableau de commandes PowerShell à exécuter string[]
script Script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde
validExitCodes Codes de sortie valides pour le script PowerShell. [Par défaut : 0] int[]

ImageTemplateShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'Shell' (obligatoire)
Inline Tableau de commandes shell à exécuter string[]
script Script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde

ImageTemplateRestartCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes 'WindowsRestart' (obligatoire)
restartCheckCommand Commande pour vérifier si le redémarrage a réussi [Valeur par défaut : ''] corde
restartCommand Commande pour exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"'] corde
restartTimeout Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5 m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m » ] corde

ImageTemplateDistributor

Nom Description Valeur
artifactTags Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution. objet
runOutputName Nom à utiliser pour le RunOutput associé. chaîne (obligatoire)

Contraintes:
Modèle = ^[A-Za-z0-9-_]{1,64}$
type Définir le type d’objet ManagedImage
SharedImage
disque dur virtuel (obligatoire)

ImageTemplateManagedImageDistributor

Nom Description Valeur
type Type de distribution. 'ManagedImage' (obligatoire)
imageId ID de ressource de l’image de disque managé chaîne (obligatoire)
emplacement Emplacement Azure de l’image, doit correspondre si l’image existe déjà chaîne (obligatoire)

ImageTemplateSharedImageDistributor

Nom Description Valeur
type Type de distribution. 'SharedImage' (obligatoire)
galleryImageId ID de ressource de l’image de la galerie d’images partagées chaîne (obligatoire)
replicationRegions string[] (obligatoire)

ImageTemplateVhdDistributor

Nom Description Valeur
type Type de distribution. 'VHD' (obligatoire)

ImageTemplateSource

Nom Description Valeur
type Définir le type d’objet ISO
ManagedImage
PlatformImage (obligatoire)

ImageTemplateIsoSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'ISO' (obligatoire)
sha256Checksum Somme de contrôle SHA256 de l’image ISO. chaîne (obligatoire)
sourceURI URI pour obtenir l’image ISO. Cet URI doit être accessible au fournisseur de ressources au moment de la création du modèle d’image. chaîne (obligatoire)

ImageTemplateManagedImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'ManagedImage' (obligatoire)
imageId ID de ressource ARM de l’image managée dans l’abonnement client chaîne (obligatoire)

ImageTemplatePlatformImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. 'PlatformImage' (obligatoire)
offrir Offre d’image à partir des images de la galerie Azure . corde
éditeur Éditeur d’images dans Azure Gallery Images. corde
Sku Référence sku d’image à partir des images de la galerie Azure . corde
Version Version d’image à partir des images de la galerie Azure . corde

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Azure Image Builder avec azure Windows Baseline

Déployer sur Azure
Crée un environnement Azure Image Builder et génère une image Windows Server avec les dernières mises à jour Windows et la base de référence Azure Windows appliquée.
configurer le service Dev Box

Déployer sur Azure
Ce modèle créerait toutes les ressources d’administration Dev Box en fonction du guide de démarrage rapide de Dev Box (https://video2.skills-academy.com/azure/dev-box/quickstart-create-dev-box). Vous pouvez afficher toutes les ressources créées ou accéder directement à DevPortal.microsoft.com pour créer votre première zone de développement.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource imageTemplates peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.VirtualMachineImages/imageTemplates, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customize = [
        {
          name = "string"
          type = "string"
          // For remaining properties, see ImageTemplateCustomizer objects
        }
      ]
      distribute = [
        {
          artifactTags = {}
          runOutputName = "string"
          type = "string"
          // For remaining properties, see ImageTemplateDistributor objects
        }
      ]
      source = {
        type = "string"
        // For remaining properties, see ImageTemplateSource objects
      }
    }
  })
}

Objets ImageTemplateCustomizer

Définissez le type propriété pour spécifier le type d’objet.

Pour PowerShell, utilisez :

  type = "PowerShell"
  inline = [
    "string"
  ]
  script = "string"
  validExitCodes = [
    int
  ]

Pour Shell, utilisez :

  type = "Shell"
  inline = [
    "string"
  ]
  script = "string"

Pour windowsRestart, utilisez :

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

Objets ImageTemplateDistributor

Définissez le type propriété pour spécifier le type d’objet.

Pour ManagedImage, utilisez :

  type = "ManagedImage"
  imageId = "string"
  location = "string"

Pour SharedImage, utilisez :

  type = "SharedImage"
  galleryImageId = "string"
  replicationRegions = [
    "string"
  ]

Pour de disque dur virtuel, utilisez :

  type = "VHD"

Objets ImageTemplateSource

Définissez le type propriété pour spécifier le type d’objet.

Pour ISO, utilisez :

  type = "ISO"
  sha256Checksum = "string"
  sourceURI = "string"

Pour ManagedImage, utilisez :

  type = "ManagedImage"
  imageId = "string"

Pour PlatformImage, utilisez :

  type = "PlatformImage"
  offer = "string"
  publisher = "string"
  sku = "string"
  version = "string"

Valeurs de propriété

imageTemplates

Nom Description Valeur
type Type de ressource « Microsoft.VirtualMachineImages/imageTemplates@2019-02-01-preview »
nom Nom de la ressource chaîne (obligatoire)
emplacement Emplacement des ressources chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
Propriétés ImageTemplateProperties

ImageTemplateProperties

Nom Description Valeur
Personnaliser Spécifie les propriétés utilisées pour décrire les étapes de personnalisation de l’image, telles que la source d’image, etc. ImageTemplateCustomizer[]
distribuer Cible de distribution vers laquelle la sortie de l’image doit être générée. ImageTemplateDistributor[] (obligatoire)
source Spécifie les propriétés utilisées pour décrire l’image source. ImageTemplateSource (obligatoire)

ImageTemplateCustomizer

Nom Description Valeur
nom Nom convivial pour fournir un contexte sur ce que fait cette étape de personnalisation corde
type Définir le type d’objet PowerShell
Shell
windowsRestart (obligatoire)

ImageTemplatePowerShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes « PowerShell » (obligatoire)
Inline Tableau de commandes PowerShell à exécuter string[]
script Script PowerShell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde
validExitCodes Codes de sortie valides pour le script PowerShell. [Par défaut : 0] int[]

ImageTemplateShellCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes « Shell » (obligatoire)
Inline Tableau de commandes shell à exécuter string[]
script Script shell à exécuter pour la personnalisation. Il peut s’agir d’un lien github, d’UN URI SAP pour stockage Azure, etc. corde

ImageTemplateRestartCustomizer

Nom Description Valeur
type Type d’outil de personnalisation que vous souhaitez utiliser sur l’image. Par exemple, « Shell » peut être personnalisateur d’interpréteur de commandes « WindowsRestart » (obligatoire)
restartCheckCommand Commande pour vérifier si le redémarrage a réussi [Valeur par défaut : ''] corde
restartCommand Commande pour exécuter le redémarrage [Par défaut : 'shutdown /r /f /t 0 /c « packer restart"'] corde
restartTimeout Délai de redémarrage spécifié sous la forme d’une chaîne de magnitude et d’unité, par exemple « 5 m » (5 minutes) ou « 2h » (2 heures) [Valeur par défaut : « 5m » ] corde

ImageTemplateDistributor

Nom Description Valeur
artifactTags Balises qui seront appliquées à l’artefact une fois qu’il a été créé/mis à jour par le serveur de distribution. objet
runOutputName Nom à utiliser pour le RunOutput associé. chaîne (obligatoire)

Contraintes:
Modèle = ^[A-Za-z0-9-_]{1,64}$
type Définir le type d’objet ManagedImage
SharedImage
disque dur virtuel (obligatoire)

ImageTemplateManagedImageDistributor

Nom Description Valeur
type Type de distribution. « ManagedImage » (obligatoire)
imageId ID de ressource de l’image de disque managé chaîne (obligatoire)
emplacement Emplacement Azure de l’image, doit correspondre si l’image existe déjà chaîne (obligatoire)

ImageTemplateSharedImageDistributor

Nom Description Valeur
type Type de distribution. « SharedImage » (obligatoire)
galleryImageId ID de ressource de l’image de la galerie d’images partagées chaîne (obligatoire)
replicationRegions string[] (obligatoire)

ImageTemplateVhdDistributor

Nom Description Valeur
type Type de distribution. « VHD » (obligatoire)

ImageTemplateSource

Nom Description Valeur
type Définir le type d’objet ISO
ManagedImage
PlatformImage (obligatoire)

ImageTemplateIsoSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. « ISO » (obligatoire)
sha256Checksum Somme de contrôle SHA256 de l’image ISO. chaîne (obligatoire)
sourceURI URI pour obtenir l’image ISO. Cet URI doit être accessible au fournisseur de ressources au moment de la création du modèle d’image. chaîne (obligatoire)

ImageTemplateManagedImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. « ManagedImage » (obligatoire)
imageId ID de ressource ARM de l’image managée dans l’abonnement client chaîne (obligatoire)

ImageTemplatePlatformImageSource

Nom Description Valeur
type Spécifie le type d’image source à utiliser. « PlatformImage » (obligatoire)
offrir Offre d’image à partir des images de la galerie Azure . corde
éditeur Éditeur d’images dans Azure Gallery Images. corde
Sku Référence sku d’image à partir des images de la galerie Azure . corde
Version Version d’image à partir des images de la galerie Azure . corde