Microsoft.Compute virtualMachines/extensions

Article
03/07/2024

Définition de ressource Bicep

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

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

Pour créer une ressource Microsoft.Compute/virtualMachines/extensions, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    instanceView: {
      name: 'string'
      statuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      substatuses: [
        {
          code: 'string'
          displayStatus: 'string'
          level: 'string'
          message: 'string'
          time: 'string'
        }
      ]
      type: 'string'
      typeHandlerVersion: 'string'
    }
    protectedSettings: any()
    protectedSettingsFromKeyVault: {
      secretUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    provisionAfterExtensions: [
      'string'
    ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Valeurs de propriétés

virtualMachines/extensions

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire)
location	Emplacement de la ressource	string
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : virtualMachines
properties	Décrit les propriétés d’une extension de machine virtuelle.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nom	Description	Valeur
autoUpgradeMinorVersion	Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.	bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est disponible.	bool
forceUpdateTag	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.	string
instanceView	Vue instance de l’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé.	Pour Bicep, vous pouvez utiliser la fonction any().
protectedSettingsFromKeyVault	Les paramètres protégés des extensions qui sont passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
provisionAfterExtensions	Collection de noms d’extension après lesquels cette extension doit être provisionnée.	string[]
publisher	Nom de l’éditeur du gestionnaire d’extensions.	string
paramètres	Paramètres publics au format Json pour l’extension.	Pour Bicep, vous pouvez utiliser la fonction any().
suppressFailures	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que le fait de ne pas se connecter à la machine virtuelle ne seront pas supprimés, quelle que soit cette valeur). La valeur par défaut est false.	bool
type	Spécifie le type de l’extension ; Par exemple, « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
name	Nom de l’extension de machine virtuelle.	string
statuses	La ressource status informations.	InstanceViewStatus[]
sous-état	La ressource status informations.	InstanceViewStatus[]
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

InstanceViewStatus

Nom	Description	Valeur
code	Code d'état.	string
displayStatus	Étiquette courte localisable pour le status.	string
niveau	Code de niveau.	'Erreur' 'Info' 'Avertissement'
message	Message de status détaillé, y compris pour les alertes et les messages d’erreur.	string
time	Heure du status.	string

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un Key Vault.	chaîne (obligatoire)
sourceVault	URL relative du Key Vault contenant le secret.	Sous-ressource (obligatoire)

Sous-ressource

Nom	Description	Valeur
id	ID de ressource	string

Modèles de démarrage rapide

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

Modèle	Description
Créer une machine virtuelle Windows avec l’extension Anti-Programme malveillant activée	Ce modèle crée une machine virtuelle Windows et configure la protection contre les programmes malveillants
Serveur IIS utilisant l’extension DSC sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure un serveur IIS à l’aide de l’extension DSC. Notez que le module de configuration DSC a besoin d’un jeton SAP à transmettre si vous utilisez Stockage Azure. Pour le lien de module DSC à partir de GitHub (valeur par défaut dans ce modèle), cela n’est pas nécessaire.
EXTENSION DE MACHINE VIRTUELLE ESET	Crée une machine virtuelle avec l’extension ESET
McAfee Endpoint Security (licence d’évaluation) sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure une version d’évaluation de McAfee Endpoint Security
Déployer une machine virtuelle Ubuntu avec l’extension OMS	Ce modèle vous permet de déployer une machine virtuelle Ubuntu avec l’extension OMS installée et intégrée à un espace de travail spécifié
Déployer une machine virtuelle Windows avec l’extension OMS	Ce modèle vous permet de déployer une machine virtuelle Windows avec l’extension OMS installée et intégrée à un espace de travail spécifié
Version d’évaluation de l’extension Symantec Endpoint Protection sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure une version d’évaluation de Symantec Endpoint Protection
Extension de script personnalisé sur une machine virtuelle Ubuntu	Ce modèle crée une machine virtuelle Ubuntu et installe l’extension CustomScript
Extension de mise à jour corrective du système d’exploitation sur une machine virtuelle Ubuntu	Ce modèle crée une machine virtuelle Ubuntu et installe l’extension OSPatching
Déployer une machine virtuelle Windows Premium avec diagnostics	Ce modèle vous permet de déployer une machine virtuelle Windows Premium à l’aide de quelques options différentes pour la version de Windows, à l’aide de la dernière version corrigée.
Déployer une machine virtuelle Windows simple avec surveillance et diagnostics	Ce modèle vous permet de déployer une machine virtuelle Windows simple avec l’extension diagnostics qui permet la surveillance et la diagnostics pour la machine virtuelle
Utiliser des extensions de script pour installer Mongo DB sur une machine virtuelle Ubuntu	Ce modèle déploie Configures et installe Mongo DB sur une machine virtuelle Ubuntu dans deux scripts distincts. Ce modèle est un bon exemple qui montre comment exprimer des dépendances entre deux scripts s’exécutant sur la même machine virtuelle. Ce modèle déploie également un compte de stockage, des Réseau virtuel, des adresses IP publiques et une interface réseau.

Définition de ressources de modèle ARM

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

Groupes de ressources - Voir commandes de déploiement de groupes de ressources

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

Format des ressources

Pour créer une ressource Microsoft.Compute/virtualMachines/extensions, ajoutez le json suivant à votre modèle.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "instanceView": {
      "name": "string",
      "statuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "substatuses": [
        {
          "code": "string",
          "displayStatus": "string",
          "level": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "type": "string",
      "typeHandlerVersion": "string"
    },
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Valeurs de propriétés

virtualMachines/extensions

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Compute/virtualMachines/extensions'
apiVersion	Version de l’API de ressource	'2023-09-01'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	string (obligatoire)
location	Emplacement de la ressource	string
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties	Décrit les propriétés d’une extension de machine virtuelle.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nom	Description	Valeur
autoUpgradeMinorVersion	Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.	bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est disponible.	bool
forceUpdateTag	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.	string
instanceView	Vue instance de l’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé.
protectedSettingsFromKeyVault	Les paramètres protégés des extensions qui sont passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
provisionAfterExtensions	Collection de noms d’extension après lesquels cette extension doit être provisionnée.	string[]
publisher	Nom de l’éditeur du gestionnaire d’extensions.	string
paramètres	Paramètres publics au format Json pour l’extension.
suppressFailures	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que le fait de ne pas se connecter à la machine virtuelle ne seront pas supprimés, quelle que soit cette valeur). La valeur par défaut est false.	bool
type	Spécifie le type de l’extension ; Par exemple, « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
name	Nom de l’extension de machine virtuelle.	string
statuses	La ressource status informations.	InstanceViewStatus[]
sous-état	La ressource status informations.	InstanceViewStatus[]
type	Spécifie le type de l’extension ; Par exemple, « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

InstanceViewStatus

Nom	Description	Valeur
code	Code d'état.	string
displayStatus	Étiquette courte localisable pour le status.	string
niveau	Code de niveau.	'Error' 'Info' 'Avertissement'
message	Message de status détaillé, y compris pour les alertes et les messages d’erreur.	string
time	Heure du status.	string

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un Key Vault.	chaîne (obligatoire)
sourceVault	URL relative du Key Vault contenant le secret.	Sous-ressource (obligatoire)

Sous-ressource

Nom	Description	Valeur
id	ID de ressource	string

Modèles de démarrage rapide

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

Modèle	Description
Créer une machine virtuelle Windows avec l’extension Anti-Programme malveillant activée	Ce modèle crée une machine virtuelle Windows et configure la protection contre les programmes malveillants
Serveur IIS utilisant l’extension DSC sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure un serveur IIS à l’aide de l’extension DSC. Notez que le module de configuration DSC a besoin d’un jeton SAP à transmettre si vous utilisez Stockage Azure. Pour le lien de module DSC à partir de GitHub (valeur par défaut dans ce modèle), cela n’est pas nécessaire.
EXTENSION DE MACHINE VIRTUELLE ESET	Crée une machine virtuelle avec l’extension ESET
McAfee Endpoint Security (licence d’évaluation) sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure une version d’évaluation de McAfee Endpoint Security
Déployer une machine virtuelle Ubuntu avec l’extension OMS	Ce modèle vous permet de déployer une machine virtuelle Ubuntu avec l’extension OMS installée et intégrée à un espace de travail spécifié
Déployer une machine virtuelle Windows avec l’extension OMS	Ce modèle vous permet de déployer une machine virtuelle Windows avec l’extension OMS installée et intégrée à un espace de travail spécifié
Version d’évaluation de l’extension Symantec Endpoint Protection sur une machine virtuelle Windows	Ce modèle crée une machine virtuelle Windows et configure une version d’évaluation de Symantec Endpoint Protection
Extension de script personnalisé sur une machine virtuelle Ubuntu	Ce modèle crée une machine virtuelle Ubuntu et installe l’extension CustomScript
Extension de mise à jour corrective du système d’exploitation sur une machine virtuelle Ubuntu	Ce modèle crée une machine virtuelle Ubuntu et installe l’extension OSPatching
Déployer une machine virtuelle Windows Premium avec diagnostics	Ce modèle vous permet de déployer une machine virtuelle Windows Premium à l’aide de quelques options différentes pour la version de Windows, à l’aide de la dernière version corrigée.
Déployer une machine virtuelle Windows simple avec surveillance et diagnostics	Ce modèle vous permet de déployer une machine virtuelle Windows simple avec l’extension diagnostics qui permet la surveillance et la diagnostics pour la machine virtuelle
Utiliser des extensions de script pour installer Mongo DB sur une machine virtuelle Ubuntu	Ce modèle déploie Configures et installe Mongo DB sur une machine virtuelle Ubuntu dans deux scripts distincts. Ce modèle est un bon exemple qui montre comment exprimer des dépendances entre deux scripts s’exécutant sur la même machine virtuelle. Ce modèle déploie également un compte de stockage, des Réseau virtuel, des adresses IP publiques et une interface réseau.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource virtualMachines/extensions 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 des ressources

Pour créer une ressource Microsoft.Compute/virtualMachines/extensions, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      instanceView = {
        name = "string"
        statuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        substatuses = [
          {
            code = "string"
            displayStatus = "string"
            level = "string"
            message = "string"
            time = "string"
          }
        ]
        type = "string"
        typeHandlerVersion = "string"
      }
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Valeurs de propriétés

virtualMachines/extensions

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Compute/virtualMachines/extensions@2023-09-01 »
name	Nom de la ressource	chaîne (obligatoire)
location	Emplacement de la ressource	string
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : virtualMachines
tags	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
properties	Décrit les propriétés d’une extension de machine virtuelle.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nom	Description	Valeur
autoUpgradeMinorVersion	Indique si l’extension doit utiliser une version mineure plus récente si une version est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.	bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme si une version plus récente de l’extension est disponible.	bool
forceUpdateTag	Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.	string
instanceView	Vue instance de l’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé.
protectedSettingsFromKeyVault	Les paramètres protégés des extensions qui sont passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
provisionAfterExtensions	Collection de noms d’extension après lesquels cette extension doit être provisionnée.	string[]
publisher	Nom de l’éditeur du gestionnaire d’extensions.	string
paramètres	Paramètres publics au format Json pour l’extension.
suppressFailures	Indique si les échecs résultant de l’extension seront supprimés (les échecs opérationnels tels que le fait de ne pas se connecter à la machine virtuelle ne seront pas supprimés, quelle que soit cette valeur). La valeur par défaut est false.	bool
type	Spécifie le type de l’extension ; Par exemple, « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
name	Nom de l’extension de machine virtuelle.	string
statuses	La ressource status informations.	InstanceViewStatus[]
sous-état	La ressource status informations.	InstanceViewStatus[]
type	Spécifie le type de l’extension ; Par exemple, « CustomScriptExtension ».	string
typeHandlerVersion	Spécifie la version du gestionnaire de script.	string

InstanceViewStatus

Nom	Description	Valeur
code	Code d'état.	string
displayStatus	Étiquette courte localisable pour le status.	string
niveau	Code de niveau.	« Erreur » « Info » « Warning » (Avertissement)
message	Message de status détaillé, y compris pour les alertes et les messages d’erreur.	string
time	Heure du status.	string

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un Key Vault.	string (obligatoire)
sourceVault	URL relative du Key Vault contenant le secret.	SubResource (obligatoire)

SubResource

Nom	Description	Valeur
id	ID de ressource	string

Microsoft.Compute virtualMachines/extensions

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

Sous-ressource

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

Sous-ressource

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

Commentaires

Commentaires

Ressources supplémentaires