Sdílet prostřednictvím

Export-AzSshConfig

  • Reference
Modul:
Az.Ssh

Tato rutina exportuje konfigurační soubor SSH, který se dá použít pro připojení k prostředkům Azure prostřednictvím klientských aplikací, které podporují konfiguraci a certifikáty OpenSSH. Konfigurační soubory SSH je možné vytvořit, které používají vydané certifikáty microsoft Entra ID nebo přihlašovací údaje místního uživatele.

Syntaxe

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>]
Export-AzSshConfig
      -Ip <String>
      -ConfigFilePath <String>
      [-PublicKeyFile <String>]
      [-PrivateKeyFile <String>]
      [-LocalUser <String>]
      [-Port <String>]
      [-CertificateFile <String>]
      [-Overwrite]
      [-KeysDestinationFolder <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Export-AzSshConfig
      -ResourceId <String>
      -ConfigFilePath <String>
      [-PublicKeyFile <String>]
      [-PrivateKeyFile <String>]
      [-UsePrivateIp]
      [-LocalUser <String>]
      [-Port <String>]
      [-CertificateFile <String>]
      [-Overwrite]
      [-KeysDestinationFolder <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

Exportovaný konfigurační soubor SSH se dá použít k připojení k prostředkům Azure klientskými aplikacemi, které podporují konfiguraci a certifikáty OpenSSH. Aplikace, jako je git a rsync, můžou konfigurační soubor používat nastavením příkazu na ssh -F /path/to/config. Příklad: rsync -e 'ssh -F /path/to/config'. Uživatelé můžou vytvářet konfigurační soubory ssh, které používají vydané certifikáty Microsoft Entra ID nebo místní přihlašovací údaje uživatele. Důležitá poznámka: Při připojování k prostředkům Azure Arc tato rutina vyžaduje, aby se na klientském počítači nainstaloval také modul Az.Ssh.ArcProxy. Rutina se pokusí nainstalovat modul z galerie Prostředí PowerShell, ale uživatel ho může nainstalovat sám. Je důležité, aby uživatel také získal oprávnění ke spuštění proxy souborů v modulu Az.Ssh.ArcProxy nebo připojení selže. Modul Az.Ssh.ArcServer najdete v galerii Prostředí PowerShell: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Příklady

Příklad 1: Export konfiguračního souboru SSH pro připojení k prostředku pomocí vydaných certifikátů Microsoft Entra ID pro ověřování

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

Pokud není zadán -LocalUser, rutina se pokusí vytvořit certifikát pro přihlášení pomocí Microsoft Entra ID. To se v současné době podporuje jenom u prostředků s operačním systémem Linux. Při použití ID Microsoft Entra pro přihlášení k prostředku bude název hostitele v položce konfigurace {název skupiny prostředků}-{název_prostředku} nebo {IP adresa} pro virtuální počítače Azure.

Příklad 2: Export konfiguračního souboru SSH pro připojení k veřejné IP adrese virtuálního počítače Azure pomocí vydaných certifikátů Microsoft Entra ID.

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

Příklad 3: Export konfiguračního souboru SSH pro připojení k místnímu uživateli v prostředku Azure pomocí certifikátů SSH pro ověřování

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

Při přihlašování pomocí přihlašovacích údajů místního uživatele bude název hostitele v položce konfigurace {název skupiny prostředků}-{název_prostředku}-{uživatelské_jméno} nebo {IP adresa}-{uživatelské_jméno} pro virtuální počítače Azure.

Příklad 4: Export konfiguračního souboru SSH pro připojení k místnímu uživateli v prostředku Azure pomocí privátního klíče SSH pro ověřování

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

Příklad 5: Export konfiguračního souboru SSH pro připojení k místnímu uživateli v prostředku Azure pomocí interaktivního uživatelského jména a hesla pro ověřování

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

Příklad 6: Určete, kde se uloží vygenerované klíče a certifikáty pro certifikát.

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

Ve výchozím nastavení jsou vygenerované klíče a certifikáty uložené v adresáři "az_ssh_config" ve stejném adresáři jako konfigurační soubor. Parametr -KeysDestinationFolder umožňuje uživateli rozhodnout, kam se klíče budou ukládat.

Příklad 7: Vytvořte obecnou konfiguraci pro použití s jakýmkoli virtuálním počítačem Azure.

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

Příklad 8: Zadejte typ prostředku cíle.

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

Tento parametr je užitečný, pokud je ve skupině prostředků více než jeden podporovaný prostředek se stejným názvem.

Parametry

-CertificateFile

Certifikát SSH, který se má použít k ověření v místním uživatelském účtu.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ConfigFilePath

Cesta k zápisu konfigurace SSH do.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Při připojování k prostředkům Arc se před aktualizací povoleného portu pro připojení SSH v koncovém bodu připojení k cílovému portu nebo instalaci modulu Az.Ssh.ArcProxy z galerie Prostředí PowerShell v případě potřeby nevyžádejte potvrzení.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Ip

IP adresa cílového virtuálního počítače Azure.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-KeysDestinationFolder

Adresář, kde budou uloženy vygenerované klíče a certifikáty.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-LocalUser

Uživatelské jméno pro místního uživatele v cílovém prostředku.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Name

Název cílového prostředku Azure

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Overwrite

Přepište konfigurační soubor místo připojení nové položky na konec souboru.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Port

Port pro připojení ke vzdálenému hostiteli.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PrivateKeyFile

Cesta k souboru privátního klíče

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PublicKeyFile

Cesta k souboru veřejného klíče

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ResourceGroupName

Název skupiny prostředků

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ResourceId

ID prostředku cílového prostředku.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ResourceType

Typ prostředku cílového prostředku.

Typ:String
Přípustné hodnoty:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-UsePrivateIp

Při připojování k virtuálnímu počítači Azure tento příznak určuje, že se má připojit k některému z privátních IP adres virtuálního počítače. Vyžaduje připojení k privátní IP adrese.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

String

Výstupy

PSSshConfigEntry