Microsoft.Compute/virtualMachines/extensions 2022-08-01 - Bicep, ARM template & Terraform AzAPI reference

Définition de ressource Bicep

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

groupes de ressources - Consultez 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 de ressource

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

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2022-08-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'
      }
    }
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Valeurs de propriété

virtualMachines/extensions

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire)
emplacement	Emplacement des ressources	corde
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	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 elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.	Bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension 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é.	corde
instanceView	Vue d’instance d’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.	Pour Bicep, vous pouvez utiliser la fonction any().
protectedSettingsFromKeyVault	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
éditeur	Nom du serveur de publication du gestionnaire d’extensions.	corde
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 la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.	Bool
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
nom	Nom de l’extension de machine virtuelle.	corde
Statuts	Informations d’état de la ressource.	InstanceViewStatus []
sous-état	Informations d’état de la ressource.	InstanceViewStatus []
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

InstanceViewStatus

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

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un coffre de clés.	chaîne (obligatoire)
sourceVault	URL relative du coffre de clés contenant le secret.	subResource (obligatoire)

Sous-ressource

Nom	Description	Valeur
id	ID de ressource	corde

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 anti-programme malveillant
serveur IIS à l’aide de 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 (par défaut dans ce modèle), cela n’est pas nécessaire.
de l’extension de machine virtuelle ANALYTICS	Crée une machine virtuelle avec l’extension ESET
McAfee Endpoint Security (licence d’évaluation) sur les de 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 les de 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 des 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 des de surveillance et de diagnostic	Ce modèle vous permet de déployer une machine virtuelle Windows simple, ainsi que l’extension diagnostics, qui permet la surveillance et les diagnostics de la machine virtuelle
Utiliser des extensions de script pour installer Mongo DB sur une machine virtuelle Ubuntu	Ce modèle déploie Configure 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, un réseau virtuel, des adresses IP publiques et une interface réseau.

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez 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 de ressource

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

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2022-08-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"
      }
    },
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Valeurs de propriété

virtualMachines/extensions

Nom	Description	Valeur
type	Type de ressource	'Microsoft.Compute/virtualMachines/extensions'
apiVersion	Version de l’API de ressource	'2022-08-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire)
emplacement	Emplacement des ressources	corde
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
Propriétés	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 elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.	Bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension 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é.	corde
instanceView	Vue d’instance d’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
protectedSettingsFromKeyVault	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
éditeur	Nom du serveur de publication du gestionnaire d’extensions.	corde
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 la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.	Bool
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
nom	Nom de l’extension de machine virtuelle.	corde
Statuts	Informations d’état de la ressource.	InstanceViewStatus []
sous-état	Informations d’état de la ressource.	InstanceViewStatus []
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

InstanceViewStatus

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

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un coffre de clés.	chaîne (obligatoire)
sourceVault	URL relative du coffre de clés contenant le secret.	subResource (obligatoire)

Sous-ressource

Nom	Description	Valeur
id	ID de ressource	corde

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 anti-programme malveillant
serveur IIS à l’aide de 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 (par défaut dans ce modèle), cela n’est pas nécessaire.
de l’extension de machine virtuelle ANALYTICS	Crée une machine virtuelle avec l’extension ESET
McAfee Endpoint Security (licence d’évaluation) sur les de 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 les de 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 des 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 des de surveillance et de diagnostic	Ce modèle vous permet de déployer une machine virtuelle Windows simple, ainsi que l’extension diagnostics, qui permet la surveillance et les diagnostics de la machine virtuelle
Utiliser des extensions de script pour installer Mongo DB sur une machine virtuelle Ubuntu	Ce modèle déploie Configure 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, un 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 de ressource

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@2022-08-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"
        }
      }
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Valeurs de propriété

virtualMachines/extensions

Nom	Description	Valeur
type	Type de ressource	« Microsoft.Compute/virtualMachines/extensions@2022-08-01 »
nom	Nom de la ressource	chaîne (obligatoire)
emplacement	Emplacement des ressources	corde
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : virtualMachines
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
Propriétés	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 elle est disponible au moment du déploiement. Une fois déployée, toutefois, l’extension ne met pas à niveau les versions mineures, sauf si elle est redéployée, même avec cette propriété définie sur true.	Bool
enableAutomaticUpgrade	Indique si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente de l’extension 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é.	corde
instanceView	Vue d’instance d’extension de machine virtuelle.	VirtualMachineExtensionInstanceView
protectedSettings	L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
protectedSettingsFromKeyVault	Paramètres protégés par extensions passés par référence et consommés à partir du coffre de clés	KeyVaultSecretReference
éditeur	Nom du serveur de publication du gestionnaire d’extensions.	corde
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 la connexion à la machine virtuelle ne seront pas supprimés indépendamment de cette valeur). La valeur par défaut est false.	Bool
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

VirtualMachineExtensionInstanceView

Nom	Description	Valeur
nom	Nom de l’extension de machine virtuelle.	corde
Statuts	Informations d’état de la ressource.	InstanceViewStatus []
sous-état	Informations d’état de la ressource.	InstanceViewStatus []
type	Spécifie le type de l’extension ; un exemple est « CustomScriptExtension ».	corde
typeHandlerVersion	Spécifie la version du gestionnaire de scripts.	corde

InstanceViewStatus

Nom	Description	Valeur
code	Code d’état.	corde
displayStatus	Étiquette localisable courte pour l’état.	corde
niveau	Code de niveau.	« Erreur » « Info » « Avertissement »
Message	Message d’état détaillé, y compris pour les alertes et les messages d’erreur.	corde
Heure	Heure de l’état.	corde

KeyVaultSecretReference

Nom	Description	Valeur
secretUrl	URL référençant un secret dans un coffre de clés.	chaîne (obligatoire)
sourceVault	URL relative du coffre de clés contenant le secret.	subResource (obligatoire)

Sous-ressource

Nom	Description	Valeur
id	ID de ressource	corde

Partager via

Microsoft.Compute virtualMachines/extensions 2022-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

Sous-ressource

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

Sous-ressource

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

Sous-ressource

Commentaires

Ressources supplémentaires