Export-AzSshConfig

Modul:

Az.Ssh Module

Dieses Cmdlet ist Teil eines Vorschaumoduls . Vorschauversionen werden nicht für die Verwendung in Produktionsumgebungen empfohlen. Weitere Informationen finden Sie unter .

Dieses Cmdlet exportiert eine SSH-Konfigurationsdatei, die zum Herstellen einer Verbindung mit Azure Ressourcen über Clientanwendungen verwendet werden kann, die OpenSSH-Konfiguration und -Zertifikate unterstützen. SSH-Konfigurationsdateien können erstellt werden, die Microsoft Entra ID ausgestellten Zertifikate oder lokalen Benutzeranmeldeinformationen verwenden.

Syntax

Interactive (Standard)

Export-AzSshConfig
    -ResourceGroupName <String>
    -Name <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-UsePrivateIp]
    [-LocalUser <String>]
    [-Port <String>]
    [-ResourceType <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

IpAddress

Export-AzSshConfig
    -Ip <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-LocalUser <String>]
    [-Port <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ResourceId

Export-AzSshConfig
    -ResourceId <String>
    -ConfigFilePath <String>
    [-PublicKeyFile <String>]
    [-PrivateKeyFile <String>]
    [-UsePrivateIp]
    [-LocalUser <String>]
    [-Port <String>]
    [-CertificateFile <String>]
    [-Overwrite]
    [-KeysDestinationFolder <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Beschreibung

Die exportierte SSH-Konfigurationsdatei kann zum Herstellen einer Verbindung mit Azure Ressourcen von Clientanwendungen verwendet werden, die OpenSSH-Konfiguration und -Zertifikate unterstützen. Anwendungen wie Git und rsync können konfigurationsdatei verwenden, indem sie den Befehl auf "ssh -F /path/to/config" festlegen. Beispiel: rsync -e "ssh -F /path/to/config". Benutzer können SSH-Konfigurationsdateien erstellen, die Microsoft Entra ID ausgestellten Zertifikaten oder lokalen Benutzeranmeldeinformationen verwenden. Wichtiger Hinweis: Beim Herstellen einer Verbindung mit Azure Arc Ressourcen muss dieses Cmdlet das Az.Ssh.ArcProxy-Modul auch auf dem Clientcomputer installiert werden. Das Cmdlet versucht, das Modul aus dem PowerShell Gallery zu installieren, aber der Benutzer hat auch die Möglichkeit, es selbst zu installieren. Es ist wichtig, dass der Benutzer auch über die Berechtigung zum Ausführen der Proxydateien im Az.Ssh.ArcProxy-Modul verfügt oder die Verbindung fehlschlägt. Sie finden das Az.Ssh.ArcServer-Modul im PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Beispiele

Beispiel 1: Exportieren einer SSH-Konfigurationsdatei zum Herstellen einer Verbindung mit einer Ressource mithilfe von Microsoft Entra ID ausgestellten Zertifikaten für die Authentifizierung.

Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config

Wenn kein -LocalUser angegeben wird, versucht das Cmdlet, ein Zertifikat für die Anmeldung mit Microsoft Entra ID zu erstellen. Dies wird derzeit nur für Ressourcen unterstützt, die das Linux-Betriebssystem ausführen. Wenn Sie Microsoft Entra ID zum Anmelden bei der Ressource verwenden, lautet der Hostname im Konfigurationseintrag "{Ressourcengruppenname}-{Ressourcenname}" oder "{ip address}" für Azure VMs.

Beispiel 2: Exportieren einer SSH-Konfigurationsdatei zum Herstellen einer Verbindung mit der öffentlichen IP eines Azure virtuellen Computers mithilfe von Microsoft Entra ID ausgestellten Zertifikaten.

Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config

Beispiel 3: Exportieren einer SSH-Konfigurationsdatei zum Herstellen einer Verbindung mit dem lokalen Benutzer auf Azure Ressource mithilfe von SSH-Zertifikaten für die Authentifizierung

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -CertificateFile ./cert -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

Wenn Sie lokale Benutzeranmeldeinformationen zum Anmelden verwenden, lautet der Hostname im Konfigurationseintrag "{ressourcengruppenname}-{resource name}-{username}" oder "{ip address}-{username}" für Azure VMs.

Beispiel 4: Exportieren einer SSH-Konfigurationsdatei zum Herstellen einer Verbindung mit dem lokalen Benutzer auf Azure Ressource mithilfe eines privaten SSH-Schlüssels für die Authentifizierung

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -PrivateKeyFile ./id_rsa -ConfigFilePath ./sshconfig.config

Beispiel 5: Exportieren einer SSH-Konfigurationsdatei zum Herstellen einer Verbindung mit dem lokalen Benutzer auf Azure Ressource unter Verwendung von interaktivem Benutzernamen und Kennwort für die Authentifizierung

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -LocalUser azureuser -ConfigFilePath ./sshconfig.config

Beispiel 6: Ermitteln, wo generierte Schlüssel und Zertifikate für das Zertifikat gespeichert werden.

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -KeysDestinationFolder /home/user/mykeys -ConfigFilePath ./sshconfig.config

Generierte Schlüssel und Zertifikate werden standardmäßig im Verzeichnis "az_ssh_config" im selben Verzeichnis wie die Konfigurationsdatei gespeichert. Mit dem parameter -KeysDestinationFolder können Benutzer entscheiden, wo die Schlüssel gespeichert werden sollen.

Beispiel 7: Erstellen Einer generischen Konfiguration für die Verwendung mit einem beliebigen Azure virtuellen Computer.

Export-AzSshConfig -Ip * -ConfigFilePath ./sshconfig.config

Beispiel 8: Geben Sie den Ressourcentyp des Ziels an.

Export-AzSshConfig -ResourceGroupName myRg -Name myVm -ResourceType Microsoft.Compute/virtualMachines -ConfigFilePath ./sshconfig.config

Dieser Parameter ist nützlich, wenn mehr als eine unterstützte Ressource mit demselben Namen in der Ressourcengruppe vorhanden ist.

Parameter

-CertificateFile

SSH-Zertifikat, das für die Authentifizierung bei einem lokalen Benutzerkonto verwendet werden soll.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ConfigFilePath

Pfad zum Schreiben der SSH-Konfiguration in.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Parametereigenschaften

Typ:	IAzureContextContainer
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	AzContext, AzureRmContext, AzureCredential

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Force

Wenn Sie eine Verbindung mit Arc-Ressourcen herstellen, werden Sie nicht zur Bestätigung aufgefordert, bevor Sie den zulässigen Port für die SSH-Verbindung im Verbindungsendpunkt aktualisieren, um dem Zielport zu entsprechen oder az.Ssh.ArcProxy-Modul aus dem PowerShell Gallery zu installieren, falls erforderlich.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Ip

IP-Adresse des Ziel-Azure virtuellen Computers.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

IpAddress

Position:	Named
Obligatorisch:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-KeysDestinationFolder

Verzeichnis, in dem generierte Schlüssel und Zertifikate gespeichert werden.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-LocalUser

Benutzername für einen lokalen Benutzer in der Zielressource.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Name

Name des Ziels Azure Ressource.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

Interactive

Position:	Named
Obligatorisch:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-Overwrite

Überschreiben Sie die Konfigurationsdatei, anstatt einen neuen Eintrag am Ende der Datei anzufügen.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Port

Portieren, mit dem eine Verbindung auf dem Remotehost hergestellt werden soll.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-PrivateKeyFile

Pfad zur Privaten Schlüsseldatei.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-PublicKeyFile

Pfad zur Datei mit öffentlichem Schlüssel.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ResourceGroupName

Ressourcengruppenname.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

Interactive

Position:	Named
Obligatorisch:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-ResourceId

Ressourcen-ID der Zielressource.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

ResourceId

Position:	Named
Obligatorisch:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-ResourceType

Ressourcentyp der Zielressource.

Parametereigenschaften

Typ:	String
Standardwert:	None
Zulässige Werte:	Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

Interactive

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-UsePrivateIp

Beim Herstellen einer Verbindung mit einem Azure virtuellen Computer gibt dieses Flag an, dass eine Verbindung mit einem der privaten IP-Adressen der VM hergestellt werden soll. Es ist eine Verbindung mit der privaten IP erforderlich.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

Interactive

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

ResourceId

Position:	Named
Obligatorisch:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

String

Ausgaben

PSSshConfigEntry

Ähnliche Themen

• SSH-Zugriff auf Azure Arc-fähige Server
• Problembehandlung beim SSH-Zugriff auf Azure Arc Aktivierte Server
• Melden Sie sich mit Microsoft Entra ID bei einer Linux-VM an.
• Installieren von OpenSSH für Windows