VMAccess-Erweiterung für Linux

Die VMAccess-Erweiterung wird verwendet, um administrative Benutzer zu verwalten, SSH zu konfigurieren und Datenträger auf virtuellen Azure Linux-Computern zu überprüfen oder zu reparieren. Die Erweiterung ist in Azure Resource Manager-Vorlagen integriert. Sie kann auch mithilfe der Azure CLI, Azure PowerShell, des Azure-Portals und der REST-API für virtuelle Azure-Computer aufgerufen werden.

In diesem Artikel wird beschrieben, wie Sie die VMAccess-Erweiterung über die Azure CLI und über eine Azure Resource Manager-Vorlage ausführen. Außerdem enthält dieser Artikel Schritte zur Problembehandlung für Linux-Systeme.

Voraussetzungen

Unterstützte Linux-Distributionen

Tipps

• VMAccess wurde für die Wiederherstellung des Zugriffs auf einen virtuellen Computer entwickelt, da der Zugriff verloren geht. Basierend auf diesem Prinzip gewährt es sudo die Berechtigung zum Konto, das im Benutzernamenfeld angegeben ist. Wenn Sie nicht möchten, dass ein Benutzer sudo-Berechtigungen erhält, melden Sie sich bei der VM an, und verwenden Sie integrierte Tools (z. B. usermod, chage usw.), um nicht privilegierte Benutzer zu verwalten.
• Es kann nur eine Version der Erweiterung auf die VM angewendet werden. Um eine zweite Aktion auszuführen, aktualisieren Sie die vorhandene Erweiterung mit einer neuen Konfiguration.
• Während eines Benutzerupdates ändert VMAccess die sshd_config-Datei und nimmt vorab eine Sicherung der Datei vor. Um die ursprüngliche gesicherte SSH-Konfiguration wiederherzustellen, führen Sie VMAccess mit restore_backup_ssh auf True festgelegt aus.

Erweiterungsschema

Die VMAccess-Erweiterungskonfiguration enthält Einstellungen für Benutzername, Kennwörter, SSH-Schlüssel usw. Sie können diese Informationen in Konfigurationsdateien speichern oder sie in der Befehlszeile oder in einer Azure Resource Manager-Vorlage (ARM-Vorlagen) angeben. Das folgende JSON-Schema enthält alle Eigenschaften, die in öffentlichen und geschützten Einstellungen verwendet werden können.

{
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "name": "<name>",
  "apiVersion": "2023-09-01",
  "location": "<location>",
  "dependsOn": [
          "[concat('Microsoft.Compute/virtualMachines/', <vmName>)]"
  ],
  "properties": {
    "publisher": "Microsoft.OSTCExtensions",
    "type": "VMAccessForLinux",
    "typeHandlerVersion": "1.5",
    "autoUpgradeMinorVersion": true,
    "settings": {
      "check_disk": true,
      "repair_disk": false,
      "disk_name": "<disk-name>",
    },
    "protectedSettings": {
      "username": "<username>",
      "password": "<password>",
      "ssh_key": "<ssh-key>",
      "reset_ssh": false,
      "remove_user": "<username>",
      "expiration": "<expiration>",
      "remove_prior_keys": false,
      "restore_backup_ssh": true
    } 
  }
}

Eigenschaftswerte

Eigenschaftswerte der Einstellungen

Bereitstellung von Vorlagen

Azure VM-Erweiterungen können mithilfe von Azure Resource Manager-Vorlagen (ARM-Vorlagen) bereitgestellt werden. Das im vorherigen Abschnitt beschriebene JSON-Schema kann in einer ARM-Vorlage verwendet werden, um die VMAccess-Erweiterung während der Bereitstellung der Vorlage auszuführen. Eine Beispielvorlage, welche die VMAccess-Erweiterung enthält, finden Sie hier auf GitHub.

Die JSON-Konfiguration für eine VM-Erweiterung muss im VM-Ressourcenfragment der Vorlage geschachtelt sein – genauer gesagt im Objekt "resources": [] für die VM-Vorlage und bei einer VM-Skalierungsgruppe unter dem Objekt "virtualMachineProfile":"extensionProfile":{"extensions" :[].

Bereitstellung mithilfe der Azure-Befehlszeilenschnittstelle

Verwenden von Azure CLI-VM-Benutzerbefehlen

Die folgenden CLI-Befehle unter az vm-Benutzer verwenden die VMAccess-Erweiterung. Zum Verwenden dieser Befehle müssen Sie die neueste Version der Azure CLI installieren und Sie müssen sich mithilfe von az login bei einem Azure-Konto anmelden.

Aktualisieren eines SSH-Schlüssels

Das folgende Beispiel aktualisiert den SSH-Schlüssel für den Benutzer azureUser auf dem virtuellen Computer myVM:

az vm user update \
  --resource-group myResourceGroup \
  --name myVM \
  --username azureUser \
  --ssh-key-value ~/.ssh/id_rsa.pub

Kennwort zurücksetzen

Das folgende Beispiel setzt das Kennwort für den Benutzer azureUser auf dem virtuellen Computer myVM zurück:

az vm user update \
  --resource-group myResourceGroup \
  --name myVM \
  --username azureUser \
  --password myNewPassword

Neustarten von SSH

Im folgenden Beispiel wird auf einem virtuellen Computer namens myVM der SSH-Daemon neu gestartet und die SSH-Konfiguration auf Standardwerte zurückgesetzt:

az vm user reset-ssh \
  --resource-group myResourceGroup \
  --name myVM

Erstellen eines Administrators/sudo-Benutzers

Im folgenden Beispiel wird ein Benutzer mit dem Namen myNewUser mit sudo-Berechtigungen erstellt. Das Konto verwendet einen SSH-Schlüssel für die Authentifizierung auf der VM mit dem Namen myVM. Mit dieser Methode erhalten Sie wieder Zugriff auf eine VM, falls die aktuellen Anmeldeinformationen verloren gehen oder Sie diese vergessen haben. Als bewährte Methode sollten Konten mit sudo-Berechtigungen beschränkt werden.

az vm user update \
  --resource-group myResourceGroup \
  --name myVM \
  --username myNewUser \
  --ssh-key-value ~/.ssh/id_rsa.pub

Löschen eines Benutzers

Das folgende Beispiel löscht einen Benutzer namens myNewUser vom virtuellen Computer myVM:

az vm user delete \
  --resource-group myResourceGroup \
  --name myVM \
  --username myNewUser

Verwenden von Azure CLI-VM/VMSS-Erweiterungsbefehlen

Sie können auch die Befehle az vm-Erweiterungssatz und az vmss-Erweiterungssatz verwenden, um die VMAccess-Erweiterung mit der angegebenen Konfiguration auszuführen.

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name VMAccessForLinux \
  --publisher Microsoft.OSTCExtensions \
  --version 1.5 \
  --settings '{"check_disk":true}'
  --protected-settings '{"username":"user1","password":"userPassword"}'

Die Parameter --settings und --protected-settings akzeptieren auch JSON-Dateipfade. Um zum Beispiel den öffentlichen SSH-Schlüssel eines Benutzers zu aktualisieren, erstellen Sie eine JSON-Datei namens update_ssh_key.json und fügen ihr Einstellungen im folgenden Format hinzu. Ersetzen Sie die Werte in der Datei durch Ihre eigenen Informationen:

{
  "username":"azureuser",
  "ssh_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ3S7gGp3rcbKmG2Y4vGZFMuMZCwoUzZNGxxxxxx2XV2x9FfAhy8iGD+lF8UdjFX3t5ebMm6BnnMh8fHwkTRdOt3LDQq8o8ElTBrZaKPxZN2thMZnODs5Hlemb2UX0oRIGRcvWqsd4oJmxsXa/Si98Wa6RHWbc9QZhw80KAcOVhmndZAZAGR+Wq6yslNo5TMOr1/ZyQAook5C4FtcSGn3Y+WczaoGWIxG4ZaWk128g79VIeJcIQqOjPodHvQAhll7qDlItVvBfMOben3GyhYTm7k4YwlEdkONm4yV/UIW0la1rmyztSBQIm9sZmSq44XXgjVmDHNF8UfCZ1ToE4r2SdwTmZv00T2i5faeYnHzxiLPA3Enub7xxxxxxwFArnqad7MO1SY1kLemhX9eFjLWN4mJe56Fu4NiWJkR9APSZQrYeKaqru4KUC68QpVasNJHbuxPSf/PcjF3cjO1+X+4x6L1H5HTPuqUkyZGgDO4ynUHbko4dhlanALcriF7tIfQR9i2r2xOyv5gxJEW/zztGqWma/d4rBoPjnf6tO7rLFHXMt/DVTkAfn5wxxtLDwkn5FMyvThRmex3BDf0gujoI1y6cOWLe9Y5geNX0oj+MXg/W0cXAtzSFocstV1PoVqy883hNoeQZ3mIGB3Q0rIUm5d9MA2bMMt31m1g3Sin6EQ== azureuser@myVM"
}

Führen Sie die VMAccess-Erweiterung über den folgenden Befehl aus:

az vm extension set \
  --resource-group myResourceGroup \
  --vm-name myVM \
  --name VMAccessForLinux \
  --publisher Microsoft.OSTCExtensions \
  --version 1.5 \
  --protected-settings update_ssh_key.json

Azure PowerShell-Bereitstellung

Azure PowerShell kann verwendet werden, um die VMAccess-Erweiterung auf einem vorhandenen virtuellen Computer oder in einer VM-Skalierungsgruppe bereitzustellen. Sie können die Erweiterung auf einem virtuellen Computer bereitstellen, indem Sie Folgendes ausführen:

$username = "<username>"
$sshKey = "<cert-contents>"

$settings = @{"check_disk" = $true};
$protectedSettings = @{"username" = $username; "ssh_key" = $sshKey};

Set-AzVMExtension -ResourceGroupName "<resource-group>" `
    -VMName "<vm-name>" `
    -Location "<location>" `
    -Publisher "Microsoft.OSTCExtensions" `
    -ExtensionType "VMAccessForLinux" `
    -Name "VMAccessForLinux" `
    -TypeHandlerVersion "1.5" `
    -Settings $settings `
    -ProtectedSettings $protectedSettings

Sie können Erweiterungseinstellungen auch mithilfe von Zeichenfolgen bereitstellen und ändern:

$username = "<username>"
$sshKey = "<cert-contents>"

$settingsString = '{"check_disk":true}';
$protectedSettingsString = '{"username":"' + $username + '","ssh_key":"' + $sshKey + '"}';

Set-AzVMExtension -ResourceGroupName "<resource-group>" `
    -VMName "<vm-name>" `
    -Location "<location>" `
    -Publisher "Microsoft.OSTCExtensions" `
    -ExtensionType "VMAccessForLinux" `
    -Name "VMAccessForLinux" `
    -TypeHandlerVersion "1.5" `
    -SettingString $settingsString `
    -ProtectedSettingString $protectedSettingsString

Führen Sie den folgenden Befehl aus, um einen Skalierungssatz für virtuelle Computer bereitzustellen:

$resourceGroupName = "<resource-group>"
$vmssName = "<vmss-name>"

$protectedSettings = @{
  "username" = "azureUser"
  "password" = "userPassword"
}

$publicSettings = @{
  "repair_disk" = $true
  "disk_name" = "<disk_name>"
}

$vmss = Get-AzVmss `
            -ResourceGroupName $resourceGroupName `
            -VMScaleSetName $vmssName

Add-AzVmssExtension -VirtualMachineScaleSet $vmss `
    -Name "<extension-name>" `
    -Publisher "Microsoft.OSTCExtensions" `
    -Type "VMAccessForLinux" `
    -TypeHandlerVersion "1.5"" `
    -AutoUpgradeMinorVersion $true `
    -Setting $publicSettings `
    -ProtectedSetting $protectedSettings

Update-AzVmss `
    -ResourceGroupName $resourceGroupName `
    -Name $vmssName `
    -VirtualMachineScaleSet $vmss

Problembehandlung und Support

Die VMAccess-Erweiterungsprotokolle sind nur lokal auf dem virtuellen Computer vorhanden und bei der Problembehandlung am informativsten.

Sie können auch den Ausführungsstatus der VMAccess-Erweiterung zusammen mit anderen Erweiterungen auf einem bestimmten virtuellen Computer abrufen, indem Sie den folgenden Befehl ausführen:

az vm extension list --resource-group myResourceGroup --vm-name myVM -o table

Wenn Sie weitere Hilfe benötigen, wenden Sie sich an die Azure-Experten im Azure-Communitysupport. Alternativ dazu haben Sie die Möglichkeit, einen Azure-Supportfall zu erstellen. Navigieren Sie zum Azure-Support, und wählen Sie Support erhalten aus. Weitere Informationen zum Azure-Support finden Sie in den FAQ zu Azure-Supportprogrammen.

Nächste Schritte

Wenn Sie den Code, die aktuellen Versionen und weitere Dokumentationen sehen möchten, lesen Sie VMAccess Linux – GitHub.