Microsoft.Compute virtualMachines/extensions

• Más reciente
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 01-11-2022
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 01-07-2021
• 2021-04-01
• 2021-03-01
• 2020-12-01

Definición de recursos de Bicep

El tipo de recurso virtualMachines/extensions se puede implementar con operaciones destinadas a:

• Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachines/extensions, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

virtualMachines/extensions

Nombre	Descripción	Value
name	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.	string (obligatorio)
ubicación	Ubicación de los recursos	string
etiquetas	Etiquetas del recurso	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario	En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: virtualMachines
properties	Describe las propiedades de una extensión de máquina virtual.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nombre	Descripción	Valor
autoUpgradeMinorVersion	Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.	bool
enableAutomaticUpgrade	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.	bool
forceUpdateTag	Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.	string
instanceView	Vista de instancia de extensión de máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.	Para Bicep, puede usar la función any().
protectedSettingsFromKeyVault	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.	KeyVaultSecretReference
provisionAfterExtensions	Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.	string[]
publisher	Nombre del publicador de controladores de extensión.	string
configuración	Configuración pública con formato JSON para la extensión.	Para Bicep, puede usar la función any().
suppressFailures	Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.	bool
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

VirtualMachineExtensionInstanceView

Nombre	Descripción	Value
name	Nombre de la extensión de máquina virtual.	string
statuses	Información de estado del recurso.	InstanceViewStatus[]
subestados	Información de estado del recurso.	InstanceViewStatus[]
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

InstanceViewStatus

Nombre	Descripción	Valor
código	Código de estado.	string
displayStatus	Etiqueta localizable corta para el estado.	string
Nivel	El código de nivel.	'Error' 'Info' 'Advertencia'
message	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.	string
time	Hora del estado.	string

KeyVaultSecretReference

Nombre	Descripción	Valor
secretUrl	Dirección URL que hace referencia a un secreto en un Key Vault.	string (obligatorio)
sourceVault	Dirección URL relativa del Key Vault que contiene el secreto.	SubResource (obligatorio)

SubResource

Nombre	Descripción	Value
id	Id. de recurso	string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Creación de una máquina virtual Windows con la extensión Antimalware habilitada	Esta plantilla crea una máquina virtual Windows y configura la protección antimalware
Servidor IIS mediante la extensión DSC en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura un servidor IIS mediante la extensión DSC. Tenga en cuenta que el módulo de configuración de DSC necesita que se pase un token de SAS si usa Azure Storage. Para el vínculo del módulo DSC desde GitHub (valor predeterminado en esta plantilla), no es necesario.
Extensión de máquina virtual DE ESET	Crea una máquina virtual con la extensión ESET.
McAfee Endpoint Security (licencia de prueba) en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura una versión de prueba de McAfee Endpoint Security.
Implementación de una máquina virtual Ubuntu con la extensión de OMS	Esta plantilla le permite implementar una máquina virtual Ubuntu con la extensión oms instalada e incorporada a un área de trabajo especificada.
Implementación de una máquina virtual Windows con la extensión oms	Esta plantilla le permite implementar una máquina virtual Windows con la extensión oms instalada e incorporada a un área de trabajo especificada.
Prueba de la extensión symantec Endpoint Protection en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura una versión de prueba de Symantec Endpoint Protection.
Extensión de script personalizado en una máquina virtual Ubuntu	Esta plantilla crea una máquina virtual Ubuntu e instala la extensión CustomScript.
Extensión de aplicación de revisiones del sistema operativo en una máquina virtual Ubuntu	Esta plantilla crea una máquina virtual Ubuntu e instala la extensión OSPatching.
Implementación de una máquina virtual Windows Premium con diagnósticos	Esta plantilla le permite implementar una máquina virtual Windows Premium con algunas opciones diferentes para la versión de Windows, mediante la versión revisada más reciente.
Implementación de una máquina virtual Windows sencilla con supervisión y diagnóstico	Esta plantilla le permite implementar una máquina virtual Windows sencilla junto con la extensión de diagnóstico que permite la supervisión y el diagnóstico de la máquina virtual.
Uso de extensiones de script para instalar Mongo DB en una máquina virtual Ubuntu	Esta plantilla implementa Configurar e instalar Mongo DB en una máquina virtual Ubuntu en dos scripts independientes. Esta plantilla es un buen ejemplo que muestra cómo expresar dependencias entre dos scripts que se ejecutan en la misma máquina virtual. Esta plantilla también implementa una cuenta de almacenamiento, Virtual Network, direcciones IP públicas y una interfaz de red.

Definición de recursos de plantilla de ARM

El tipo de recurso virtualMachines/extensions se puede implementar con operaciones destinadas a:

• Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachines/extensions, agregue el siguiente json a la plantilla.

{
  "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"
  }
}

Valores de propiedad

virtualMachines/extensions

Nombre	Descripción	Value
type	Tipo de recurso	'Microsoft.Compute/virtualMachines/extensions'
apiVersion	La versión de la API de recursos	'2023-09-01'
name	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.	string (obligatorio)
ubicación	Ubicación de los recursos	string
etiquetas	Etiquetas del recurso	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties	Describe las propiedades de una extensión de máquina virtual.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nombre	Descripción	Valor
autoUpgradeMinorVersion	Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.	bool
enableAutomaticUpgrade	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.	bool
forceUpdateTag	Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.	string
instanceView	Vista de instancia de extensión de máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
protectedSettingsFromKeyVault	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.	KeyVaultSecretReference
provisionAfterExtensions	Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.	string[]
publisher	Nombre del publicador de controladores de extensión.	string
configuración	Configuración pública con formato JSON para la extensión.
suppressFailures	Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.	bool
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

VirtualMachineExtensionInstanceView

Nombre	Descripción	Value
name	Nombre de la extensión de máquina virtual.	string
statuses	Información de estado del recurso.	InstanceViewStatus[]
subestados	Información de estado del recurso.	InstanceViewStatus[]
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

InstanceViewStatus

Nombre	Descripción	Valor
código	Código de estado.	string
displayStatus	Etiqueta localizable corta para el estado.	string
Nivel	El código de nivel.	'Error' 'Info' 'Advertencia'
message	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.	string
time	Hora del estado.	string

KeyVaultSecretReference

Nombre	Descripción	Valor
secretUrl	Dirección URL que hace referencia a un secreto en un Key Vault.	string (obligatorio)
sourceVault	Dirección URL relativa del Key Vault que contiene el secreto.	SubResource (obligatorio)

SubResource

Nombre	Descripción	Value
id	Id. de recurso	string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Creación de una máquina virtual Windows con la extensión Antimalware habilitada	Esta plantilla crea una máquina virtual Windows y configura la protección antimalware
Servidor IIS mediante la extensión DSC en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura un servidor IIS mediante la extensión DSC. Tenga en cuenta que el módulo de configuración de DSC necesita que se pase un token de SAS si usa Azure Storage. Para el vínculo del módulo DSC desde GitHub (valor predeterminado en esta plantilla), no es necesario.
Extensión de máquina virtual DE ESET	Crea una máquina virtual con la extensión ESET.
McAfee Endpoint Security (licencia de prueba) en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura una versión de prueba de McAfee Endpoint Security.
Implementación de una máquina virtual Ubuntu con la extensión de OMS	Esta plantilla le permite implementar una máquina virtual Ubuntu con la extensión oms instalada e incorporada a un área de trabajo especificada.
Implementación de una máquina virtual Windows con la extensión oms	Esta plantilla le permite implementar una máquina virtual Windows con la extensión oms instalada e incorporada a un área de trabajo especificada.
Prueba de la extensión symantec Endpoint Protection en una máquina virtual Windows	Esta plantilla crea una máquina virtual Windows y configura una versión de prueba de Symantec Endpoint Protection.
Extensión de script personalizado en una máquina virtual Ubuntu	Esta plantilla crea una máquina virtual Ubuntu e instala la extensión CustomScript.
Extensión de aplicación de revisiones del sistema operativo en una máquina virtual Ubuntu	Esta plantilla crea una máquina virtual Ubuntu e instala la extensión OSPatching.
Implementación de una máquina virtual Windows Premium con diagnósticos	Esta plantilla le permite implementar una máquina virtual Windows Premium con algunas opciones diferentes para la versión de Windows, mediante la versión revisada más reciente.
Implementación de una máquina virtual Windows sencilla con supervisión y diagnóstico	Esta plantilla le permite implementar una máquina virtual Windows sencilla junto con la extensión de diagnóstico que permite la supervisión y el diagnóstico de la máquina virtual.
Uso de extensiones de script para instalar Mongo DB en una máquina virtual Ubuntu	Esta plantilla implementa Configurar e instalar Mongo DB en una máquina virtual Ubuntu en dos scripts independientes. Esta plantilla es un buen ejemplo que muestra cómo expresar dependencias entre dos scripts que se ejecutan en la misma máquina virtual. Esta plantilla también implementa una cuenta de almacenamiento, Virtual Network, direcciones IP públicas y una interfaz de red.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso virtualMachines/extensions se puede implementar con operaciones destinadas a:

• Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.Compute/virtualMachines/extensions, agregue el siguiente terraform a la plantilla.

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"
    }
  })
}

Valores de propiedad

virtualMachines/extensions

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.Compute/virtualMachines/extensions@2023-09-01"
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación de los recursos	string
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: virtualMachines
etiquetas	Etiquetas del recurso	Diccionario de nombres y valores de etiqueta.
properties	Describe las propiedades de una extensión de máquina virtual.	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

Nombre	Descripción	Valor
autoUpgradeMinorVersion	Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.	bool
enableAutomaticUpgrade	Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.	bool
forceUpdateTag	Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.	string
instanceView	Vista de instancia de extensión de máquina virtual.	VirtualMachineExtensionInstanceView
protectedSettings	La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.
protectedSettingsFromKeyVault	Configuración protegida de extensiones que se pasan por referencia y que se consumen desde el almacén de claves.	KeyVaultSecretReference
provisionAfterExtensions	Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.	string[]
publisher	Nombre del publicador de controladores de extensión.	string
configuración	Configuración pública con formato JSON para la extensión.
suppressFailures	Indica si los errores derivados de la extensión se suprimirán (los errores operativos, como no conectarse a la máquina virtual, no se suprimirán independientemente de este valor). El valor predeterminado es false.	bool
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

VirtualMachineExtensionInstanceView

Nombre	Descripción	Value
name	Nombre de la extensión de máquina virtual.	string
statuses	Información de estado del recurso.	InstanceViewStatus[]
subestados	Información de estado del recurso.	InstanceViewStatus[]
tipo	Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".	string
typeHandlerVersion	Especifica la versión del controlador de script.	string

InstanceViewStatus

Nombre	Descripción	Valor
código	Código de estado.	string
displayStatus	Etiqueta localizable corta para el estado.	string
Nivel	El código de nivel.	"Error" "Información" "Warning"
message	Mensaje de estado detallado, incluidas las alertas y los mensajes de error.	string
time	Hora del estado.	string

KeyVaultSecretReference

Nombre	Descripción	Valor
secretUrl	Dirección URL que hace referencia a un secreto en un Key Vault.	string (obligatorio)
sourceVault	Dirección URL relativa del Key Vault que contiene el secreto.	SubResource (obligatorio)

SubResource

Nombre	Descripción	Value
id	Id. de recurso	string