Condividi tramite


Export-AzSshConfig

Questo cmdlet fa parte di un modulo di anteprima . Le versioni di anteprima non sono consigliate per l'uso negli ambienti di produzione. Per altre informazioni, vedere .

Questo cmdlet esporta un file di configurazione SSH che può essere usato per connettersi alle risorse Azure tramite applicazioni client che supportano la configurazione e i certificati OpenSSH. È possibile creare file di configurazione SSH che usano Microsoft Entra ID certificati rilasciati o credenziali utente locali.

Sintassi

Interactive (Impostazione predefinita)

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

Descrizione

Il file di configurazione SSH esportato può essere usato per connettersi alle risorse Azure dalle applicazioni client che supportano la configurazione e i certificati OpenSSH. Le applicazioni come git e rsync possono usare il file di configurazione impostando il comando su "ssh -F /path/to/config". Ad esempio: rsync -e 'ssh -F /path/to/config'. Gli utenti possono creare file di configurazione ssh che usano Microsoft Entra ID certificati rilasciati o credenziali utente locali. Nota importante: quando ci si connette alle risorse di Azure Arc, questo cmdlet richiede l'installazione anche del modulo Az.Ssh.ArcProxy nel computer client. Il cmdlet tenterà di installare il modulo dal PowerShell Gallery, ma l'utente ha anche la possibilità di installarlo autonomamente. È importante che l'utente disponga anche dell'autorizzazione per eseguire i file proxy nel modulo Az.Ssh.ArcProxy oppure la connessione avrà esito negativo. Il modulo Az.Ssh.ArcServer è disponibile nel PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Esempio

Esempio 1: esportare un file di configurazione SSH per la connessione a una risorsa usando Microsoft Entra ID certificati rilasciati per l'autenticazione.

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

Quando non viene specificata una -LocalUser, il cmdlet tenterà di creare un certificato per l'accesso tramite Microsoft Entra ID. Questa opzione è attualmente supportata solo per le risorse che eseguono il sistema operativo Linux. Quando si usa Microsoft Entra ID per accedere alla risorsa, il nome host nella voce di configurazione sarà "{nome gruppo di risorse}-{nome risorsa}" o "{indirizzo IP}" per le macchine virtuali Azure.

Esempio 2: Esportare un file di configurazione SSH per la connessione all'indirizzo IP pubblico di una macchina virtuale Azure usando Microsoft Entra ID certificati rilasciati.

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

Esempio 3: Esportare un file di configurazione SSH per la connessione all'utente locale in Azure risorsa usando i certificati SSH per l'autenticazione

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

Quando si usano le credenziali utente locali per accedere, il nome host nella voce di configurazione sarà "{nome gruppo di risorse}-{nome risorsa}-{nomeutente}" o "{indirizzo IP}-{nomeutente}" per le macchine virtuali Azure.

Esempio 4: Esportare un file di configurazione SSH per la connessione all'utente locale in Azure risorsa usando la chiave privata SSH per l'autenticazione

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

Esempio 5: Esportare un file di configurazione SSH per la connessione all'utente locale in Azure risorsa usando nome utente interattivo e password per l'autenticazione

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

Esempio 6: determinare dove verranno archiviati chiavi e certificati generati per il certificato.

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

Le chiavi generate e i certificati sono, per impostazione predefinita, archiviati nella directory "az_ssh_config" nella stessa directory del file di configurazione. Il parametro -KeysDestinationFolder consente all'utente di decidere dove verranno archiviate le chiavi.

Esempio 7: Creare una configurazione generica da usare con qualsiasi macchina virtuale Azure.

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

Esempio 8: specificare il tipo di risorsa della destinazione.

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

Questo parametro è utile quando nel gruppo di risorse sono presenti più risorse supportate con lo stesso nome.

Parametri

-CertificateFile

Certificato SSH da usare per l'autenticazione all'account utente locale.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ConfigFilePath

Percorso in cui scrivere la configurazione SSH.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Proprietà dei parametri

Tipo:IAzureContextContainer
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Force

Quando ci si connette alle risorse arc, non richiedere conferma prima di aggiornare la porta consentita per la connessione SSH nell'endpoint di connessione in modo che corrisponda alla porta di destinazione o installare il modulo Az.Ssh.ArcProxy dal PowerShell Gallery, se necessario.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Ip

Indirizzo IP della macchina virtuale Azure di destinazione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

IpAddress
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-KeysDestinationFolder

Directory in cui verranno archiviati chiavi e certificati generati.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-LocalUser

Nome utente per un utente locale nella risorsa di destinazione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Name

Nome del Azure risorsa di destinazione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

Interactive
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Overwrite

Sovrascrivere il file di configurazione, invece di aggiungere una nuova voce alla fine del file.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Port

Porta a cui connettersi nell'host remoto.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PrivateKeyFile

Percorso del file di chiave privata.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PublicKeyFile

Percorso del file di chiave pubblica.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-ResourceGroupName

Nome del gruppo di risorse.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

Interactive
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-ResourceId

ID risorsa della risorsa di destinazione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

ResourceId
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-ResourceType

Tipo di risorsa della risorsa di destinazione.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Valori accettati:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

Interactive
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-UsePrivateIp

Quando ci si connette a una macchina virtuale Azure, questo flag specifica che deve connettersi a uno degli indirizzi IP privati della macchina virtuale. Richiede la connettività all'INDIRIZZO IP privato.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

Interactive
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False
ResourceId
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

String

Output

PSSshConfigEntry