Udostępnij przez

Export-AzSshConfig

  • Wersja zapoznawcza
Moduł:
Az.Ssh Module

To polecenie cmdlet jest częścią modułu w wersji zapoznawczej . Wersje zapoznawcze nie są zalecane do użycia w środowiskach produkcyjnych. Aby uzyskać więcej informacji, zobacz https://aka.ms/azps-refstatus.

To polecenie cmdlet eksportuje plik konfiguracji SSH, który może służyć do łączenia się z zasobami platformy Azure za pośrednictwem aplikacji klienckich obsługujących konfigurację i certyfikaty openSSH. Można utworzyć pliki konfiguracji SSH, które używają identyfikatora Entra firmy Microsoft wystawionych certyfikatów lub poświadczeń użytkownika lokalnego.

Składnia

Interactive (domyślnie) 

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>]

Opis

Wyeksportowany plik konfiguracji SSH może służyć do łączenia się z zasobami platformy Azure przez aplikacje klienckie obsługujące konfigurację i certyfikaty protokołu OpenSSH. Aplikacje, takie jak git i rsync, mogą używać pliku konfiguracji, ustawiając polecenie na wartość "ssh -F /path/to/config". Na przykład: rsync -e "ssh -F /path/to/config". Użytkownicy mogą tworzyć pliki konfiguracji ssh, które używają identyfikatora Entra firmy Microsoft wystawionych certyfikatów lub poświadczeń użytkownika lokalnego. Ważna uwaga: podczas nawiązywania połączenia z zasobami usługi Azure Arc to polecenie cmdlet wymaga również zainstalowania modułu Az.Ssh.ArcProxy na komputerze klienckim. Polecenie cmdlet podejmie próbę zainstalowania modułu z galerii programu PowerShell, ale użytkownik ma również możliwość samodzielnego zainstalowania modułu. Ważne jest, aby użytkownik miał również uprawnienia do wykonywania plików proxy w module Az.Ssh.ArcProxy lub połączenie zakończy się niepowodzeniem. Moduł Az.Ssh.ArcServer można znaleźć w Galeria programu PowerShell: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Przykłady

Przykład 1: Wyeksportuj plik konfiguracji SSH na potrzeby nawiązywania połączenia z zasobem przy użyciu identyfikatora Entra firmy Microsoft wystawionych certyfikatów na potrzeby uwierzytelniania.

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

Jeśli nie podano -LocalUser, polecenie cmdlet podejmie próbę utworzenia certyfikatu do logowania przy użyciu identyfikatora Entra firmy Microsoft. Jest to obecnie obsługiwane tylko w przypadku zasobów z systemem operacyjnym Linux. W przypadku logowania do zasobu za pomocą identyfikatora Entra firmy Microsoft nazwa hosta we wpisie konfiguracji będzie mieć wartość "{nazwa grupy zasobów}-{nazwa zasobu}" lub "{adres IP}" dla maszyn wirtualnych platformy Azure.

Przykład 2: Eksportowanie pliku konfiguracji SSH na potrzeby nawiązywania połączenia z publicznym adresem IP maszyny wirtualnej platformy Azure przy użyciu identyfikatora Entra firmy Microsoft wystawionych certyfikatów.

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

Przykład 3: Eksportowanie pliku konfiguracji SSH na potrzeby nawiązywania połączenia z użytkownikiem lokalnym w zasobie platformy Azure przy użyciu certyfikatów SSH na potrzeby uwierzytelniania

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

W przypadku logowania przy użyciu poświadczeń użytkownika lokalnego nazwa hosta we wpisie konfiguracji będzie mieć wartość "{nazwa grupy zasobów}-{nazwa zasobu}-{nazwa_użytkownika}" lub "{adres IP}-{nazwa_użytkownika}" dla maszyn wirtualnych platformy Azure.

Przykład 4. Eksportowanie pliku konfiguracji SSH na potrzeby nawiązywania połączenia z użytkownikiem lokalnym w zasobie platformy Azure przy użyciu klucza prywatnego SSH na potrzeby uwierzytelniania

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

Przykład 5. Eksportowanie pliku konfiguracji SSH na potrzeby nawiązywania połączenia z użytkownikiem lokalnym w zasobie platformy Azure przy użyciu interakcyjnej nazwy użytkownika i hasła na potrzeby uwierzytelniania

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

Przykład 6. Określenie, gdzie będą przechowywane wygenerowane klucze i certyfikaty dla certyfikatu.

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

Wygenerowane klucze i certyfikaty są domyślnie przechowywane w katalogu "az_ssh_config" w tym samym katalogu co plik konfiguracji. Parametr -KeysDestinationFolder umożliwia użytkownikowi podjęcie decyzji, gdzie będą przechowywane klucze.

Przykład 7. Tworzenie ogólnej konfiguracji do użycia z dowolną maszyną wirtualną platformy Azure.

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

Przykład 8. Podaj typ zasobu obiektu docelowego.

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

Ten parametr jest przydatny, gdy istnieje więcej niż jeden obsługiwany zasób o tej samej nazwie w grupie zasobów.

Parametry

-CertificateFile

Certyfikat SSH używany do uwierzytelniania na koncie użytkownika lokalnego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ConfigFilePath

Ścieżka do zapisu konfiguracji SSH do.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Właściwości parametru

Typ:IAzureContextContainer
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Force

Podczas nawiązywania połączenia z zasobami usługi Arc nie monituj o potwierdzenie przed zaktualizowaniem dozwolonego portu dla połączenia SSH w punkcie końcowym połączenia, aby dopasować port docelowy lub zainstalować moduł Az.Ssh.ArcProxy z galerii programu PowerShell, jeśli jest to konieczne.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Ip

Adres IP docelowej maszyny wirtualnej platformy Azure.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

IpAddress
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-KeysDestinationFolder

Katalog, w którym będą przechowywane wygenerowane klucze i certyfikaty.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-LocalUser

Nazwa użytkownika lokalnego w zasobie docelowym.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Name

Nazwa docelowego zasobu platformy Azure.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

Interactive
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Overwrite

Zastąp plik konfiguracji zamiast dołączania nowego wpisu na końcu pliku.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Port

Port do nawiązania połączenia na hoście zdalnym.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PrivateKeyFile

Ścieżka do pliku klucza prywatnego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-PublicKeyFile

Ścieżka do pliku klucza publicznego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-ResourceGroupName

Nazwa grupy zasobów.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

Interactive
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-ResourceId

Identyfikator zasobu docelowego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

ResourceId
Position:Named
Obowiązkowe:True
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-ResourceType

Typ zasobu docelowego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Dopuszczalne wartości:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

Interactive
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-UsePrivateIp

Podczas nawiązywania połączenia z maszyną wirtualną platformy Azure ta flaga określa, że powinna łączyć się z jednym z prywatnych adresów IP maszyny wirtualnej. Wymaga łączności z prywatnym adresem IP.

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

Interactive
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False
ResourceId
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

String

Dane wyjściowe

PSSshConfigEntry