Delen via

Export-AzSshConfig

  • Preview
Module:
Az.Ssh Module

Deze cmdlet maakt deel uit van een preview-module . Preview-versies worden niet aanbevolen voor gebruik in productieomgevingen. Zie https://aka.ms/azps-refstatus voor meer informatie.

Met deze cmdlet wordt een SSH-configuratiebestand geëxporteerd dat kan worden gebruikt om verbinding te maken met Azure-resources via clienttoepassingen die ondersteuning bieden voor OpenSSH-configuratie en -certificaten. SSH-configuratiebestanden kunnen worden gemaakt die gebruikmaken van door Microsoft Entra ID uitgegeven certificaten of lokale gebruikersreferenties.

Syntax

Interactive (Standaard) 

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

Description

Het geëxporteerde SSH-configuratiebestand kan worden gebruikt om verbinding te maken met Azure-resources door clienttoepassingen die ondersteuning bieden voor OpenSSH-configuratie en -certificaten. Toepassingen zoals git en rsync kunnen configuratiebestand gebruiken door de opdracht in te stellen op 'ssh -F /path/to/config'. Bijvoorbeeld: rsync -e 'ssh -F /path/to/config'. Gebruikers kunnen ssh-configuratiebestanden maken die gebruikmaken van door Microsoft Entra ID uitgegeven certificaten of lokale gebruikersreferenties. Belangrijke opmerking: als u verbinding maakt met Azure Arc-resources, moet de Az.Ssh.ArcProxy-module ook worden geïnstalleerd op de clientcomputer. De cmdlet probeert de module te installeren vanuit de PowerShell Gallery, maar de gebruiker heeft ook de mogelijkheid om deze zelf te installeren. Het is belangrijk dat de gebruiker ook gemachtigd is om de proxybestanden uit te voeren in de Az.Ssh.ArcProxy-module, anders mislukt de verbinding. U vindt de Module Az.Ssh.ArcServer in de PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Voorbeelden

Voorbeeld 1: Een SSH-configuratiebestand exporteren om verbinding te maken met een resource met behulp van Microsoft Entra ID uitgegeven certificaten voor verificatie.

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

Wanneer er geen -LocalUser wordt opgegeven, probeert de cmdlet een certificaat te maken om u aan te melden met behulp van Microsoft Entra-id. Dit wordt momenteel alleen ondersteund voor resources waarop het Linux-besturingssysteem wordt uitgevoerd. Wanneer u Microsoft Entra-id gebruikt om u aan te melden bij de resource, is de hostnaam in de configuratievermelding {resourcegroepnaam}-{resourcenaam}, of {ip-adres} voor Virtuele Azure-machines.

Voorbeeld 2: Een SSH-configuratiebestand exporteren om verbinding te maken met het openbare IP-adres van een virtuele Azure-machine met behulp van Microsoft Entra ID uitgegeven certificaten.

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

Voorbeeld 3: Een SSH-configuratiebestand exporteren om verbinding te maken met lokale gebruiker in Azure Resource met behulp van SSH-certificaten voor verificatie

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

Wanneer u lokale gebruikersreferenties gebruikt om u aan te melden, is de hostnaam in de configuratievermelding '{resourcegroepnaam}-{resourcenaam}-{gebruikersnaam}' of {ip-adres}-{gebruikersnaam} voor Virtuele Azure-machines.

Voorbeeld 4: Een SSH-configuratiebestand exporteren om verbinding te maken met lokale gebruiker in Azure Resource met behulp van een persoonlijke SSH-sleutel voor verificatie

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

Voorbeeld 5: Een SSH-configuratiebestand exporteren om verbinding te maken met lokale gebruiker in Azure Resource met behulp van interactieve gebruikersnaam en wachtwoord voor verificatie

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

Voorbeeld 6: Bepaal waar gegenereerde sleutels en certificaten voor het certificaat worden opgeslagen.

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

Gegenereerde sleutels en certificaten worden standaard opgeslagen in de map 'az_ssh_config' in dezelfde map als het configuratiebestand. Met de parameter -KeysDestinationFolder kan de gebruiker bepalen waar de sleutels worden opgeslagen.

Voorbeeld 7: Een algemene configuratie maken voor gebruik met een virtuele Azure-machine.

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

Voorbeeld 8: Geef het resourcetype van het doel op.

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

Deze parameter is handig wanneer er meer dan één ondersteunde resource is met dezelfde naam in de resourcegroep.

Parameters

-CertificateFile

SSH-certificaat dat moet worden gebruikt voor verificatie bij het lokale gebruikersaccount.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ConfigFilePath

Pad naar het schrijven van SSH-configuratie naar.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Parametereigenschappen

Type:IAzureContextContainer
Default value:None
Ondersteunt jokertekens:False
DontShow:False
Aliassen:AzContext, AzureRmContext, AzureCredential

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Wanneer u verbinding maakt met Arc-resources, vraagt u niet om bevestiging voordat u de toegestane poort voor de SSH-verbinding in het verbindingseindpunt bijwerkt, zodat deze overeenkomt met de doelpoort of om de Az.Ssh.ArcProxy-module te installeren vanuit de PowerShell Gallery, indien nodig.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Ip

IP-adres van azure-doel-VM.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

IpAddress
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-KeysDestinationFolder

Map waarin gegenereerde sleutels en certificaten worden opgeslagen.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-LocalUser

Gebruikersnaam voor een lokale gebruiker in de doelresource.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Name

Naam van de Azure-doelresource.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

Interactive
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-Overwrite

Overschrijf het configuratiebestand in plaats van een nieuwe vermelding toe te voegen aan het einde van het bestand.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Port

Poort om verbinding mee te maken op de externe host.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PrivateKeyFile

Pad naar het bestand met de persoonlijke sleutel.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PublicKeyFile

Pad naar bestand met openbare sleutels.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ResourceGroupName

Naam van de resourcegroep.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

Interactive
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-ResourceId

Resource-id van de doelresource.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

ResourceId
Position:Named
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:True
Waarde van resterende argumenten:False

-ResourceType

Resourcetype van de doelresource.

Parametereigenschappen

Type:String
Default value:None
Geaccepteerde waarden:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Ondersteunt jokertekens:False
DontShow:False

Parametersets

Interactive
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-UsePrivateIp

Wanneer u verbinding maakt met een Azure-VM, geeft deze vlag aan dat deze verbinding moet maken met een van de privé-IP-adressen van de virtuele machine. Hiervoor is verbinding met het privé-IP-adres vereist.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

Interactive
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False
ResourceId
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

String

Uitvoerwaarden

PSSshConfigEntry