Aktivieren von Azure-VM-Erweiterungen mithilfe einer ARM-Vorlage

Artikel
01/24/2025

In diesem Artikel erfahren Sie, wie Sie eine Azure Resource Manager-Vorlage (ARM-Vorlage) verwenden, um Erweiterungen für Azure-VMs (virtuelle Computer) bereitzustellen, die von Azure Arc-fähigen Servern unterstützt werden.

Sie können einer ARM-Vorlage VM-Erweiterungen hinzufügen und sie beim Bereitstellen der Vorlage ausführen. Mit den von Azure Arc-fähigen Servern unterstützten VM-Erweiterungen können Sie die Erweiterungen mithilfe von Azure PowerShell auf Linux- oder Windows-Computern bereitstellen. Jedes der folgenden Beispiele beinhaltet eine Vorlagendatei und eine Parameterdatei mit Beispielwerten für die Vorlage.

Hinweis

Obwohl Sie mehrere Erweiterungen im Batch-Modus angeben und zusammen verarbeiten können, werden sie seriell installiert. Nachdem die Installation der ersten Erweiterung abgeschlossen ist, wird die nächste Erweiterung installiert.

Das Bereitstellen und Verwalten von VM-Erweiterungen auf Azure-VMs wird auf Servern mit Azure Arc-Unterstützung nicht unterstützt. Informationen zu Azure-VMs finden Sie im Artikel Übersicht über VM-Erweiterungen.

Bereitstellen der Log Analytics-VM-Erweiterung

Um den Log Analytics-Agent einfach bereitzustellen, verwenden Sie eines der folgenden Beispiele zum Installieren des Agents unter Linux oder Windows.

Vorlagendatei für 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')]"
                }
            }
        }
    ]
}

Vorlagendatei für 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')]"
                }
            }
        }
    ]
}

Parameterdatei

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

Speichern Sie die Vorlagen- und die Parameterdatei auf dem Datenträger, und bearbeiten Sie die Parameterdatei mit den passenden Werten für Ihre Bereitstellung. Anschließend können Sie die Erweiterung auf allen verbundenen Computern innerhalb einer Ressourcengruppe installieren, indem Sie den folgenden Befehl verwenden. Der Befehl verwendet den TemplateFile-Parameter zum Angeben der Vorlage und den TemplateParameterFile-Parameter zum Angeben einer Datei, die die Parameter und Parameterwerte enthält.

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

Bereitstellen der Erweiterung für benutzerdefinierte Skripts

Zur Verwendung der benutzerdefinierten Skripterweiterung führen Sie eines der folgenden Beispiele für Linux und Windows aus. Wenn Sie mit der benutzerdefinierten Skripterweiterung nicht vertraut sind, lesen Sie die Informationen unter Benutzerdefinierte Skripterweiterung für Linux oder Benutzerdefinierte Skripterweiterung für Windows. Es gibt einige abweichende Merkmale, die Sie kennen sollten, wenn Sie diese Erweiterung mit Hybridcomputern verwenden:

Die Liste der unterstützten Betriebssysteme für die benutzerdefinierte Skripterweiterung der Azure-VM trifft auf Azure Arc-fähige Server nicht zu. Einzelheiten finden Sie in der Liste der unterstützten Betriebssysteme für Azure Arc-fähige Server.
Konfigurationsdetails für Azure Virtual Machine Scale Sets oder VMs, die über das klassische Bereitstellungsmodell erstellt wurden, sind nicht anwendbar.
Wenn Ihre Computer ein Skript extern herunterladen müssen und nur über einen Proxyserver kommunizieren können, müssen Sie den Connected Machine-Agent so konfigurieren, dass die Umgebungsvariable des Proxyservers festgelegt wird.

In der Konfiguration der benutzerdefinierten Skripterweiterung werden Aspekte wie der Skriptspeicherort und der auszuführende Befehl angegeben. Diese Konfiguration wird in den folgenden Vorlagen angegeben.

Vorlagendatei für 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')]"
        }
      }
    }
  ]
}

Vorlagendatei für 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'))]"
                }
            }
        }
    ]
}

Parameterdatei

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

Bereitstellen der Dependency-Agent-Erweiterung

Zur Verwendung der Erweiterung für den Azure Monitor Dependency-Agent führen Sie eines der folgenden Beispiele für Linux und Windows aus. Wenn Sie mit dem Dependency-Agent nicht vertraut sind, informieren Sie sich in der Übersicht zu Azure Monitor-Agents.

Vorlagendatei für 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": {
  }
}

Vorlagendatei für 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": {
  }
}

Bereitstellung von Vorlagen

Speichern Sie die Vorlagendatei auf dem Datenträger. Anschließend können Sie die Erweiterung mit dem folgenden Befehl auf dem verbundenen Computer bereitstellen:

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

Bereitstellen der Azure Key Vault-VM-Erweiterung (Vorschau)

Im folgenden JSON-Code ist das Schema für die Key Vault-VM-Erweiterung (Vorschau) dargestellt. Für die Erweiterung sind keine geschützten Einstellungen erforderlich, da alle ihre Einstellungen als öffentliche Informationen betrachtet werden. Für die Erweiterung werden eine Liste der überwachten Zertifikate, die Abrufhäufigkeit und ein Zielzertifikatspeicher benötigt.

Vorlagendatei für 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"
        }
      }
    }
  }
 ]
}

Vorlagendatei für 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"
        }
      }
    }
  }
 ]
}

Hinweis

Die URLs der überwachten Zertifikate müssen das folgende Format haben: https://myVaultName.vault.azure.net/secrets/myCertName. Grund hierfür ist, dass der Pfad /secrets das vollständige Zertifikat einschließlich des privaten Schlüssels zurückgibt, der Pfad /certificates hingegen nicht. Weitere Informationen zu Zertifikaten finden Sie in der Übersicht über Schlüssel, Geheimnisse und Zertifikate in Azure Key Vault.

Bereitstellung von Vorlagen

Speichern Sie die Vorlagendatei auf dem Datenträger. Anschließend können Sie die Erweiterung mit dem folgenden Befehl auf dem verbundenen Computer bereitstellen.

Hinweis

Die VM-Erweiterung erfordert, dass eine systemseitig zugewiesene Identität für die Authentifizierung bei Key Vault zugewiesen wird. Lesen Sie die Informationen unter Authentifizieren bei Azure-Ressourcen mit Azure Arc-fähigen Servern für Azure Arc-fähige Server unter Linux und Windows.

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

Sie können VM-Erweiterungen mit Azure PowerShell, über das Azure-Portal oder mithilfe der Azure-Befehlszeilenschnittstelle bereitstellen, verwalten und entfernen.
Weitere Informationen zur Problembehandlung finden Sie im Leitfaden zur Problembehandlung von VM-Erweiterungen.

Freigeben über

Aktivieren von Azure-VM-Erweiterungen mithilfe einer ARM-Vorlage

Bereitstellen der Log Analytics-VM-Erweiterung

Vorlagendatei für Linux

Vorlagendatei für Windows

Parameterdatei

Bereitstellen der Erweiterung für benutzerdefinierte Skripts

Vorlagendatei für Linux

Vorlagendatei für Windows

Parameterdatei

Bereitstellen der Dependency-Agent-Erweiterung

Vorlagendatei für Linux

Vorlagendatei für Windows

Bereitstellung von Vorlagen

Bereitstellen der Azure Key Vault-VM-Erweiterung (Vorschau)

Vorlagendatei für Linux

Vorlagendatei für Windows

Bereitstellung von Vorlagen

Feedback

Zusätzliche Ressourcen

Freigeben über

Aktivieren von Azure-VM-Erweiterungen mithilfe einer ARM-Vorlage

Bereitstellen der Log Analytics-VM-Erweiterung

Vorlagendatei für Linux

Vorlagendatei für Windows

Parameterdatei

Bereitstellen der Erweiterung für benutzerdefinierte Skripts

Vorlagendatei für Linux

Vorlagendatei für Windows

Parameterdatei

Bereitstellen der Dependency-Agent-Erweiterung

Vorlagendatei für Linux

Vorlagendatei für Windows

Bereitstellung von Vorlagen

Bereitstellen der Azure Key Vault-VM-Erweiterung (Vorschau)

Vorlagendatei für Linux

Vorlagendatei für Windows

Bereitstellung von Vorlagen

Zugehöriger Inhalt

Feedback

Zusätzliche Ressourcen