Partager via

Microsoft.Compute virtualMachineScaleSets/virtualMachines/extensions 2023-03-01

  • Article

Définition de ressource Bicep

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

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/virtualMachineScaleSets/virtualMachines/extensions, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01' = {
  name: 'string'
  location: 'string'
  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

virtualMachineScaleSets/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 l’extension. string
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 ; 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'
'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

Définition de ressources de modèle ARM

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

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions",
  "apiVersion": "2023-03-01",
  "name": "string",
  "location": "string",
  "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

virtualMachineScaleSets/virtualMachines/extensions

Nom Description Valeur
type Type de ressource « Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions »
apiVersion Version de l’API de ressource '2023-03-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.		 chaîne (obligatoire)
location Emplacement de l’extension. string
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é à mettre à jour même si la configuration de l’extension n’a pas changé. string
instanceView L’extension de machine virtuelle instance vue. VirtualMachineExtensionInstanceView
protectedSettings L’extension peut contenir protectedSettings ou protectedSettingsFromKeyVault ou aucun paramètre protégé du tout.
protectedSettingsFromKeyVault Les extensions ont protégé les paramètres qui sont transmis par référence et consommés à partir du coffre de clés KeyVaultSecretReference
provisionAfterExtensions Collection de noms d’extensions après lesquels cette extension doit être provisionnée. string[]
publisher Nom du serveur de publication du gestionnaire d’extensions. string
paramètres Paramètres publics au format Json pour l’extension.
suppressFailures Indique si les échecs liés à 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. string (obligatoire)
sourceVault URL relative du Key Vault contenant le secret. SubResource (obligatoire)

SubResource

Nom Description Valeur
id ID de ressource string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource virtualMachineScaleSets/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 d’API, consultez journal des modifications.

Format des ressources

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  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

virtualMachineScaleSets/virtualMachines/extensions

Nom Description Valeur
type Type de ressource « Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions@2023-03-01 »
name Nom de la ressource string (obligatoire)
location Emplacement de l’extension. string
parent_id ID de la ressource qui est le parent de cette ressource. ID de 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é.
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