Compartilhar via

Export-AzSshConfig

Módulo:
Az.Ssh Module

Esse cmdlet exporta um arquivo de configuração SSH que pode ser usado para se conectar a recursos Azure por meio de aplicativos cliente que dão suporte a certificados e configurações OpenSSH. Arquivos de configuração SSH podem ser criados que usam Microsoft Entra ID certificados emitidos ou credenciais de usuário local.

Sintaxe

Interactive (Default) 

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

O arquivo de configuração SSH exportado pode ser usado para se conectar a recursos Azure por aplicativos cliente que dão suporte à configuração e certificados OpenSSH. Aplicativos como git e rsync podem usar o arquivo de configuração definindo o comando como 'ssh -F /path/to/config'. Por exemplo: rsync -e 'ssh -F /path/to/config'. Os usuários podem criar arquivos de configuração ssh que usam Microsoft Entra ID certificados emitidos ou credenciais de usuário local. Observação importante: ao se conectar a Azure Arc recursos, esse cmdlet requer que o módulo Az.Ssh.ArcProxy também seja instalado no computador cliente. O cmdlet tentará instalar o módulo do Galeria do PowerShell, mas o usuário também tem a opção de instalá-lo por conta própria. É importante que o usuário também tenha permissão para executar os arquivos Proxy no módulo Az.Ssh.ArcProxy ou a conexão falhará. Você pode encontrar o módulo Az.Ssh.ArcServer no Galeria do PowerShell: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Exemplos

Exemplo 1: exportar um arquivo de configuração SSH para se conectar a um recurso usando Microsoft Entra ID certificados emitidos para autenticação.

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

Quando um -LocalUser não for fornecido, o cmdlet tentará criar um certificado para fazer logon usando Microsoft Entra ID. Atualmente, só há suporte para recursos que executam o sistema operacional Linux. Ao usar Microsoft Entra ID para fazer logon no recurso, o nome do host na entrada de configuração será "{nome do grupo de recursos}-{nome do recurso}" ou "{endereço ip}" para Azure VMs.

Exemplo 2: exportar um arquivo de configuração SSH para se conectar ao Ip público de uma máquina virtual Azure usando Microsoft Entra ID certificados emitidos.

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

Exemplo 3: Exportar um arquivo de configuração SSH para se conectar ao Usuário Local no recurso Azure usando certificados SSH para autenticação

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

Ao usar credenciais de usuário local para fazer logon, o nome do host na entrada de configuração será "{nome do grupo de recursos}-{nome de recurso}-{nome de usuário}" ou "{endereço ip}-{nome de usuário}" para Azure VMs.

Exemplo 4: Exportar um arquivo de configuração SSH para se conectar ao Usuário Local no recurso Azure usando a chave privada SSH para autenticação

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

Exemplo 5: exportar um arquivo de configuração SSH para se conectar ao Usuário Local no recurso Azure usando o nome de usuário interativo e a senha para autenticação

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

Exemplo 6: determinar onde as chaves e certificados gerados para o certificado serão armazenados.

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

Chaves e certificados gerados são, por padrão, armazenados no diretório "az_ssh_config" no mesmo diretório que o arquivo de configuração. O parâmetro -KeysDestinationFolder permite que o usuário decida onde as chaves serão armazenadas.

Exemplo 7: criar uma configuração genérica para uso com qualquer VM Azure.

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

Exemplo 8: forneça o tipo de recurso do destino.

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

Esse parâmetro é útil quando há mais de um recurso com suporte com o mesmo nome no Grupo de Recursos.

Parâmetros

-CertificateFile

Certificado SSH a ser usado para autenticar na conta de usuário local.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ConfigFilePath

Caminho para o qual gravar a configuração do SSH.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Ao se conectar aos recursos do Arc, não solicite confirmação antes de atualizar a porta permitida para conexão SSH no Ponto de Extremidade de Conexão para corresponder à porta de destino ou instalar o módulo Az.Ssh.ArcProxy do Galeria do PowerShell, se necessário.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Ip

Endereço IP da VM de Azure de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IpAddress
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-KeysDestinationFolder

Diretório em que as chaves e certificados gerados serão armazenados.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-LocalUser

Nome de usuário para um usuário local no recurso de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

Nome do recurso de Azure de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Interactive
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Overwrite

Substitua o arquivo de configuração, em vez de acrescentar uma nova entrada ao final do arquivo.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Port

Porta à qual se conectar no host remoto.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PrivateKeyFile

Caminho para o arquivo de chave privada.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PublicKeyFile

Caminho para o arquivo de chave pública.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

Nome do grupo de recursos.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Interactive
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceId

ID do recurso de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ResourceId
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceType

Tipo de recurso do recurso de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Interactive
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UsePrivateIp

Ao se conectar a uma VM Azure, esse sinalizador especifica que ele deve se conectar a um dos IPs privados da VM. Ele requer conectividade com o IP privado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Interactive
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
ResourceId
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Saídas

PSSshConfigEntry