Habilitación de las extensiones de máquina virtual de Azure mediante una plantilla de ARM

Artículo
01/19/2025

En este artículo se muestra cómo usar una plantilla de Azure Resource Manager (plantilla de ARM) para implementar extensiones de máquina virtual de Azure compatibles con los servidores habilitados para Azure Arc.

Puede agregar extensiones de máquina virtual a una plantilla de ARM y ejecutarlas con la implementación de la plantilla. En el caso de las extensiones de máquina virtual compatibles con servidores habilitados para Azure Arc, puede implementar las extensiones en máquinas Linux o Windows mediante Azure PowerShell. Cada ejemplo siguiente incluye un archivo de plantilla y un archivo de parámetro con valores de ejemplo para la plantilla.

Nota:

Aunque puede procesar varias extensiones por lotes y procesarlas juntas, se instalan en serie. Una vez completada la instalación de la primera extensión, se instala la siguiente extensión.

Los servidores habilitados para Azure Arc no admiten la implementación y administración de extensiones de VM en máquinas virtuales de Azure. Para las máquinas virtuales de Azure, consulte el artículo de información general sobre la extensión de máquina virtual.

Implementación de la extensión de máquina virtual de Log Analytics

Para implementar fácilmente el agente de Log Analytics, use uno de los ejemplos siguientes para instalar el agente en Linux o Windows.

Archivo de plantilla para Linux

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "workspaceId": {
            "type": "string"
        },
        "workspaceKey": {
            "type": "string"
        }
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/OMSAgentForLinux')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "OmsAgentForLinux",
                "enableAutomaticUpgrade": true,
                "settings": {
                    "workspaceId": "[parameters('workspaceId')]"
                },
                "protectedSettings": {
                    "workspaceKey": "[parameters('workspaceKey')]"
                }
            }
        }
    ]
}

Archivo de plantilla para Windows

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "workspaceId": {
            "type": "string"
        },
        "workspaceKey": {
            "type": "string"
        }
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/MicrosoftMonitoringAgent')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.EnterpriseCloud.Monitoring",
                "type": "MicrosoftMonitoringAgent",
                "autoUpgradeMinorVersion": true,
                "enableAutomaticUpgrade": true,
                "settings": {
                    "workspaceId": "[parameters('workspaceId')]"
                },
                "protectedSettings": {
                    "workspaceKey": "[parameters('workspaceKey')]"
                }
            }
        }
    ]
}

Archivo de parámetros

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "value": "<vmName>"
        },
        "location": {
            "value": "<region>"
        },
        "workspaceId": {
            "value": "<MyWorkspaceID>"
        },
        "workspaceKey": {
            "value": "<MyWorkspaceKey>"
        }
    }
}

Guarde la plantilla y el archivo de parámetro en el disco y edite el archivo de parámetro con los valores adecuados para su implementación. Después, podrá instalar la extensión en todas las máquinas conectadas dentro de un grupo de recursos mediante el siguiente comando. El comando usa el parámetro TemplateFile para especificar la plantilla y el parámetro TemplateParameterFile para especificar un archivo que contenga los parámetros y sus valores correspondientes.

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\LogAnalyticsAgent.json" -TemplateParameterFile "D:\Azure\Templates\LogAnalyticsAgentParms.json"

Implementación de la extensión de script personalizado

Para usar la extensión de script personalizado, ejecute uno de los ejemplos siguientes para Linux y Windows. Si no está familiarizado con la extensión de script personalizado, consulte Extensión de script personalizado para Linux o Extensión de script personalizado para Windows. Hay algunas características distintas que debe comprender al usar esta extensión con máquinas híbridas:

La lista de sistemas operativos compatibles con la extensión de script personalizado para máquina virtual de Azure no se aplica a servidores habilitados para Azure Arc. Consulte la lista de sistemas operativos compatibles para servidores habilitados para Azure Arc.
Los detalles de configuración relacionados con los conjuntos de escalado de máquinas virtuales de Azure o las máquinas virtuales creadas a través del modelo de implementación clásico no son aplicables.
Si las máquinas necesitan descargar un script de forma externa y solo se pueden comunicar a través de un servidor proxy, debe configurar el agente de Connected Machine para establecer la variable de entorno del servidor proxy.

La configuración de la extensión de script personalizado especifica aspectos como la ubicación del script y el comando que se ejecutará. Esta configuración se especifica en las plantillas siguientes.

Archivo de plantilla para Linux

{
  "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string"
    },
    "location": {
      "type": "string"
    },
    "fileUris": {
      "type": "array"
    },
    "commandToExecute": {
      "type": "securestring"
    }
  },
  "resources": [
    {
      "name": "[concat(parameters('vmName'),'/CustomScript')]",
      "type": "Microsoft.HybridCompute/machines/extensions",
      "location": "[parameters('location')]",
      "apiVersion": "2022-03-10",
      "properties": {
        "publisher": "Microsoft.Azure.Extensions",
        "type": "CustomScript",
        "autoUpgradeMinorVersion": true,
        "settings": {},
        "protectedSettings": {
          "commandToExecute": "[parameters('commandToExecute')]",
          "fileUris": "[parameters('fileUris')]"
        }
      }
    }
  ]
}

Archivo de plantilla para Windows

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "fileUris": {
            "type": "string"
        },
        "arguments": {
            "type": "securestring",
            "defaultValue": " "
        }
    },
    "variables": {
        "UriFileNamePieces": "[split(parameters('fileUris'), '/')]",
        "firstFileNameString": "[variables('UriFileNamePieces')[sub(length(variables('UriFileNamePieces')), 1)]]",
        "firstFileNameBreakString": "[split(variables('firstFileNameString'), '?')]",
        "firstFileName": "[variables('firstFileNameBreakString')[0]]"
    },
    "resources": [
        {
            "name": "[concat(parameters('vmName'),'/CustomScriptExtension')]",
            "type": "Microsoft.HybridCompute/machines/extensions",
            "location": "[parameters('location')]",
            "apiVersion": "2022-03-10",
            "properties": {
                "publisher": "Microsoft.Compute",
                "type": "CustomScriptExtension",
                "autoUpgradeMinorVersion": true,
                "settings": {
                    "fileUris": "[split(parameters('fileUris'), ' ')]"
                },
                "protectedSettings": {
                    "commandToExecute": "[concat ('powershell -ExecutionPolicy Unrestricted -File ', variables('firstFileName'), ' ', parameters('arguments'))]"
                }
            }
        }
    ]
}

Archivo de parámetros

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.1.2-preview",
  "parameters": {
    "basics": [
      {}
    ],
    "steps": [
      {
        "name": "customScriptExt",
        "label": "Add Custom Script Extension",
        "elements": [
          {
            "name": "fileUris",
            "type": "Microsoft.Common.FileUpload",
            "label": "Script files",
            "toolTip": "The script files that will be downloaded to the virtual machine.",
            "constraints": {
              "required": false
            },
            "options": {
              "multiple": true,
              "uploadMode": "url"
            },
            "visible": true
          },
          {
            "name": "commandToExecute",
            "type": "Microsoft.Common.TextBox",
            "label": "Command",
            "defaultValue": "sh script.sh",
            "toolTip": "The command to execute, for example: sh script.sh",
            "constraints": {
              "required": true
            },
            "visible": true
          }
        ]
      }
    ],
    "outputs": {
      "vmName": "[vmName()]",
      "location": "[location()]",
      "fileUris": "[steps('customScriptExt').fileUris]",
      "commandToExecute": "[steps('customScriptExt').commandToExecute]"
    }
  }
}

Implementación de la extensión del agente de dependencia

Para usar la extensión Dependency Agent de Azure Monitor, ejecute uno de los ejemplos siguientes para Linux y Windows. Si no está familiarizado con Dependency Agent, consulte Información general sobre los agentes de Azure Monitor.

Archivo de plantilla para Linux

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of existing Linux machine."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "2022-03-10",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentLinux",
        "enableAutomaticUpgrade": true
      }
    }
  ],
  "outputs": {
  }
}

Archivo de plantilla para Windows

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of existing Windows machine."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/DAExtension')]",
      "apiVersion": "2022-03-10",
      "location": "[resourceGroup().location]",
      "dependsOn": [
      ],
      "properties": {
        "publisher": "Microsoft.Azure.Monitoring.DependencyAgent",
        "type": "DependencyAgentWindows",
        "enableAutomaticUpgrade": true
      }
    }
  ],
  "outputs": {
  }
}

Implementación de plantilla

Guarde el archivo de plantilla en el disco. Después, puede implementar la extensión a la máquina conectada mediante el siguiente comando:

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\DependencyAgent.json"

Implementar la extensión de máquina virtual de Azure Key Vault (versión preliminar)

El siguiente código JSON muestra el esquema para la extensión de máquina virtual de Key Vault (versión preliminar). La extensión no requiere configuración protegida, ya que todas sus opciones se consideran información pública. La extensión requiere una lista de certificados supervisados, frecuencia de sondeo y el almacén de certificados de destino.

Archivo de plantilla para Linux

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "autoUpgradeMinorVersion":{
            "type": "bool"
        },
        "pollingIntervalInS":{
          "type": "int"
        },
        "certificateStoreName":{
          "type": "string"
        },
        "certificateStoreLocation":{
          "type": "string"
        },
        "observedCertificates":{
          "type": "string"
        },
        "msiEndpoint":{
          "type": "string"
        },
        "msiClientId":{
          "type": "string"
        }
},
"resources": [
   {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/KVVMExtensionForLinux')]",
      "apiVersion": "2022-03-10",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForLinux",
      "enableAutomaticUpgrade": true,
      "settings": {
          "secretsManagementSettings": {
          "pollingIntervalInS": <polling interval in seconds, e.g. "3600">,
          "certificateStoreName": <ignored on linux>,
          "certificateStoreLocation": <disk path where certificate is stored, default: "/var/lib/waagent/Microsoft.Azure.KeyVault">,
          "observedCertificates": <list of KeyVault URIs representing monitored certificates, e.g.: "https://myvault.vault.azure.net/secrets/mycertificate"
          },
          "authenticationSettings": {
                "msiEndpoint":  "http://localhost:40342/metadata/identity"
        }
      }
    }
  }
 ]
}

Archivo de plantilla para Windows

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string"
        },
        "location": {
            "type": "string"
        },
        "autoUpgradeMinorVersion":{
            "type": "bool"
        },
        "pollingIntervalInS":{
          "type": "int"
        },
        "certificateStoreName":{
          "type": "string"
        },
        "linkOnRenewal":{
          "type": "bool"
        },
        "certificateStoreLocation":{
          "type": "string"
        },
        "requireInitialSync":{
          "type": "bool"
        },
        "observedCertificates":{
          "type": "string"
        },
        "msiEndpoint":{
          "type": "string"
        },
        "msiClientId":{
          "type": "string"
        }
},
"resources": [
   {
      "type": "Microsoft.HybridCompute/machines/extensions",
      "name": "[concat(parameters('vmName'),'/KVVMExtensionForWindows')]",
      "apiVersion": "2022-03-10",
      "location": "[parameters('location')]",
      "properties": {
      "publisher": "Microsoft.Azure.KeyVault",
      "type": "KeyVaultForWindows",
      "enableAutomaticUpgrade": true,
      "settings": {
        "secretsManagementSettings": {
          "pollingIntervalInS": "3600",
          "certificateStoreName": <certificate store name, e.g.: "MY">,
          "linkOnRenewal": <Only Windows. This feature ensures s-channel binding when certificate renews, without necessitating a re-deployment.  e.g.: false>,
          "certificateStoreLocation": <certificate store location, currently it works locally only e.g.: "LocalMachine">,
          "requireInitialSync": <initial synchronization of certificates e.g.: true>,
          "observedCertificates": <list of KeyVault URIs representing monitored certificates, e.g.: "https://myvault.vault.azure.net"
        },
        "authenticationSettings": {
                "msiEndpoint": "http://localhost:40342/metadata/identity"
        }
      }
    }
  }
 ]
}

Nota:

Las direcciones URL del certificado observado deben tener el formato https://myVaultName.vault.azure.net/secrets/myCertName. Esto se debe a que la ruta de acceso /secrets devuelve el certificado completo, incluida la clave privada, mientras que la ruta de acceso /certificates no. Puede encontrar más información acerca de los certificados en Introducción a las claves, secretos y certificados de Azure Key Vault.

Implementación de plantilla

Guarde el archivo de plantilla en el disco. Después, puede implementar la extensión a la máquina conectada mediante el siguiente comando.

Nota:

La extensión de VM requeriría la asignación de una identidad administrada por el sistema para autenticarse en Key Vault. Consulte Autenticación en recursos de Azure con servidores habilitados para Azure Arc para servidores habilitados para Azure Arc de Linux y Windows.

New-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\KeyVaultExtension.json"

Puede implementar, administrar y eliminar extensiones de máquina virtual mediante Azure PowerShell, Azure Portal o la CLI de Azure.
Puede encontrar información de solución de problemas en la guía de solución de problemas de extensiones de máquina virtual.

Compartir vía

Habilitación de las extensiones de máquina virtual de Azure mediante una plantilla de ARM

Implementación de la extensión de máquina virtual de Log Analytics

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Archivo de parámetros

Implementación de la extensión de script personalizado

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Archivo de parámetros

Implementación de la extensión del agente de dependencia

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Implementación de plantilla

Implementar la extensión de máquina virtual de Azure Key Vault (versión preliminar)

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Implementación de plantilla

Comentarios

Recursos adicionales

Compartir vía

Habilitación de las extensiones de máquina virtual de Azure mediante una plantilla de ARM

Implementación de la extensión de máquina virtual de Log Analytics

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Archivo de parámetros

Implementación de la extensión de script personalizado

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Archivo de parámetros

Implementación de la extensión del agente de dependencia

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Implementación de plantilla

Implementar la extensión de máquina virtual de Azure Key Vault (versión preliminar)

Archivo de plantilla para Linux

Archivo de plantilla para Windows

Implementación de plantilla

Contenido relacionado

Comentarios

Recursos adicionales