Freigeben über

Aktivieren von Azure-VM-Erweiterungen mithilfe von Azure PowerShell

In diesem Artikel wird erläutert, wie Sie Erweiterungen für virtuelle Computer (VM) auf Azure Arc-fähigen Servern mithilfe von Azure PowerShell bereitstellen, aktualisieren und deinstallieren.

Voraussetzungen

  • Einen Computer mit Azure PowerShell. Anweisungen hierzu finden Sie unter Installieren und Konfigurieren von Azure PowerShell.

  • Das Modul Az.ConnectedMachine. Bevor Sie Azure PowerShell zum Verwalten von VM-Erweiterungen auf Ihrem Hybridserver verwenden, der von Azure Arc-fähigen Servern verwaltet wird, müssen Sie dieses Modul installieren.

    Sie können diese Verwaltungsvorgänge von Ihrer Arbeitsstation aus statt auf dem Azure Arc-fähigen Server ausführen.

    Führen Sie den folgenden Befehl aus, um das Az.ConnectedMachine-Modul zu installieren:

    Install-Module -Name Az.ConnectedMachine

Aktivieren einer Erweiterung

Zum Aktivieren einer VM-Erweiterung auf Ihrem Azure Arc-fähigen Server verwenden Sie New-AzConnectedMachineExtension mit den Parametern -Name, -ResourceGroupName, -MachineName, -Location, -Publisher, -ExtensionType und -Settings.

In diesem Beispiel wird die benutzerdefinierte Skripterweiterung auf einem Azure Arc-fähigen Server aktiviert:

$Setting = @{ "commandToExecute" = "powershell.exe -c Get-Process" }
New-AzConnectedMachineExtension -Name "custom" -ResourceGroupName "myResourceGroup" -MachineName "myMachineName" -Location "regionName" -Publisher "Microsoft.Compute"  -Settings $Setting -ExtensionType CustomScriptExtension

In diesem Beispiel wird die Microsoft Antimalware-Erweiterung auf einem Azure Arc-fähigen Windows-Server aktiviert:

$Setting = @{ "AntimalwareEnabled" = $true }
New-AzConnectedMachineExtension -Name "IaaSAntimalware" -ResourceGroupName "myResourceGroup" -MachineName "myMachineName" -Location "regionName" -Publisher "Microsoft.Azure.Security" -Settings $Setting -ExtensionType "IaaSAntimalware"

In diesem Beispiel wird die Vm-Erweiterung Key Vault auf einem Azure Arc-fähigen Server aktiviert:

Warnung

Wenn Sie in der Datei „settings.json“ \ in " hinzufügen, löst akvvm_service den folgenden Fehler aus: [CertificateManagementConfiguration] Failed to parse the configuration settings with:not an object.

Viele PowerShell-Benutzer verwenden zwar die Sequenz \" als Escape-Zeichen für Anführungszeichen in anderen Codeblöcken, Sie sollten diese Formatierung in der Datei „settings.json“ jedoch vermeiden.

# Build settings
    $settings = @{
      secretsManagementSettings = @{
       observedCertificates = @(
        "observedCert1"
       )
      certificateStoreLocation = "myMachineName" # For Linux use "/var/lib/waagent/Microsoft.Azure.KeyVault.Store/"
      certificateStore = "myCertificateStoreName"
      pollingIntervalInS = "pollingInterval"
      }
    authenticationSettings = @{
     msiEndpoint = "http://localhost:40342/metadata/identity"
     }
    }

    $resourceGroup = "resourceGroupName"
    $machineName = "myMachineName"
    $location = "regionName"

    # Start the deployment
    New-AzConnectedMachineExtension -ResourceGroupName $resourceGroup -Location $location -MachineName $machineName -Name "KeyVaultForWindows or KeyVaultforLinux" -Publisher "Microsoft.Azure.KeyVault" -ExtensionType "KeyVaultforWindows or KeyVaultforLinux" -Setting $settings

In diesem Beispiel wird die Datadog-VM-Erweiterung auf einem Azure Arc-fähigen Server aktiviert:

$resourceGroup = "resourceGroupName"
$machineName = "machineName"
$location = "machineRegion"
$osType = "Windows" # change to Linux if appropriate
$settings = @{
    # change to your preferred Datadog site
    site = "us3.datadoghq.com"
}
$protectedSettings = @{
    # change to your Datadog API key
    api_key = "APIKEY"
}

New-AzConnectedMachineExtension -ResourceGroupName $resourceGroup -Location $location -MachineName $machineName -Name "Datadog$($osType)Agent" -Publisher "Datadog.Agent" -ExtensionType "Datadog$($osType)Agent" -Setting $settings -ProtectedSetting $protectedSettings

Tipp

Viele weitere Erweiterungen werden auf Arc-fähigen Servern unterstützt. Ausführliche Informationen finden Sie unter Verwaltung der Erweiterung virtueller Computer mit Azure Arc-fähigen Servern.

Auflisten der Installierten Erweiterungen

Verwenden Sie Get-AzConnectedMachineExtension mit den -MachineName und -ResourceGroupName Parametern, um eine Liste der VM-Erweiterungen auf Ihrem Azure Arc-fähigen Server abzurufen.

Get-AzConnectedMachineExtension -ResourceGroupName myResourceGroup -MachineName myMachineName

Name    Location  PropertiesType        ProvisioningState
----    --------  --------------        -----------------
custom  westus2   CustomScriptExtension Succeeded

Aktualisieren einer Erweiterungskonfiguration

Zur Neukonfiguration einer installierten Erweiterung können Sie das Update-AzConnectedMachineExtension-Cmdlet mit den Parametern -Name, -MachineName, -ResourceGroupName und -Settings verwenden.

Weitere Details finden Sie unter Update-AzConnectedMachineExtension.

Upgraden von Erweiterungen

Wenn eine neue Version einer unterstützten VM-Erweiterung veröffentlicht wird, können Sie diese auf diese neueste Version upgraden. Für ein Upgrade einer VM-Erweiterung verwenden Sie Update-AzConnectedExtension mit den Parametern -MachineName, -ResourceGroupName und -ExtensionTarget.

Für den -ExtensionTarget-Parameter müssen Sie die Erweiterung und die neueste verfügbare Version angeben. Um die neueste verfügbare Version für eine Erweiterung zu ermitteln, gehen Sie zur Seite Erweiterungen für den ausgewählten Azure Arc-fähigen Server im Azure-Portal, oder führen Sie Get-AzVMExtensionImage aus. Sie können mehrere Erweiterungen in einer einzigen Upgradeanforderung angeben, indem Sie beide der folgenden Angaben bereitstellen:

  • Eine durch Trennzeichen getrennte Liste von Erweiterungen, definiert durch ihren Herausgeber und Typ (durch einen Punkt getrennt)
  • Die Zielversion für jede Erweiterung

Sie können die Version der installierten VM-Erweiterungen jederzeit überprüfen, indem Sie den Befehl Get-AzConnectedMachineExtension ausführen. Der TypeHandlerVersion-Eigenschaftswert stellt die Version der Erweiterung dar.

Tipp

Viele VM-Erweiterungen können für automatische Upgrades konfiguriert werden.

Entfernen von Erweiterungen

Zum Entfernen einer installierten VM-Erweiterung auf Ihrem Azure Arc-fähigen Server verwenden Sie Remove-AzConnectedMachineExtension mit den Parametern -Name, -MachineName und -ResourceGroupName.

Zugehöriger Inhalt