Compartir a través de

Export-AzSshConfig

  • Vista previa
Módulo:
Az.Ssh Module

Este cmdlet forma parte de un módulo de versión preliminar . No se recomienda usar versiones preliminares en entornos de producción. Para obtener más información, consulte .

Este cmdlet exporta un archivo de configuración SSH que se puede usar para conectarse a Azure Recursos a través de aplicaciones cliente que admiten certificados y configuración de OpenSSH. Los archivos de configuración ssh se pueden crear que usen certificados emitidos Microsoft Entra ID o credenciales de usuario local.

Sintaxis

Interactive (valor predeterminado) 

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

El archivo de configuración de SSH exportado se puede usar para conectarse a Azure Resources mediante aplicaciones cliente que admiten certificados y configuración de OpenSSH. Las aplicaciones como git y rsync pueden usar el archivo de configuración estableciendo el comando en "ssh -F /path/to/config". Por ejemplo: rsync -e "ssh -F /path/to/config". Los usuarios pueden crear archivos de configuración ssh que usen certificados emitidos Microsoft Entra ID o credenciales de usuario local. Nota importante: Al conectarse a recursos de Azure Arc, este cmdlet requiere que el módulo Az.Ssh.ArcProxy también esté instalado en el equipo cliente. El cmdlet intentará instalar el módulo desde el PowerShell Gallery, pero el usuario también tiene la opción de instalarlo por sí mismos. Es importante que el usuario también tenga permiso para ejecutar los archivos proxy en el módulo Az.Ssh.ArcProxy o se producirá un error en la conexión. Puede encontrar el módulo Az.Ssh.ArcServer en el PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.

Ejemplos

Ejemplo 1: Exportación de un archivo de configuración SSH para conectarse a un recurso mediante Microsoft Entra ID certificados emitidos para la autenticación.

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

Cuando no se proporciona un -LocalUser, el cmdlet intentará crear un certificado para iniciar sesión mediante Microsoft Entra ID. Actualmente solo se admite para los recursos que ejecutan el sistema operativo Linux. Al usar Microsoft Entra ID para iniciar sesión en el recurso, el nombre de host de la entrada de configuración será "{nombre del grupo de recursos}-{nombre de recurso}" o "{dirección IP}" para Azure máquinas virtuales.

Ejemplo 2: Exportación de un archivo de configuración SSH para conectarse a la dirección IP pública de una máquina virtual de Azure mediante certificados emitidos Microsoft Entra ID.

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

Ejemplo 3: Exportación de un archivo de configuración ssh para conectarse al usuario local en Azure recurso mediante certificados SSH para la autenticación

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

Al usar credenciales de usuario local para iniciar sesión, el nombre de host de la entrada de configuración será "{nombre del grupo de recursos}-{nombre de recurso}-{nombredeusuario}" o "{dirección ip}-{nombredeusuario}" para Azure máquinas virtuales.

Ejemplo 4: Exportación de un archivo de configuración SSH para conectarse al usuario local en Azure recurso mediante la clave privada SSH para la autenticación

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

Ejemplo 5: Exportación de un archivo de configuración SSH para conectarse al usuario local en Azure recurso mediante el nombre de usuario interactivo y la contraseña para la autenticación

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

Ejemplo 6: determine dónde se almacenarán las claves y los certificados generados para el certificado.

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

Las claves y certificados generados se almacenan de forma predeterminada en el directorio "az_ssh_config" en el mismo directorio que el archivo de configuración. El parámetro -KeysDestinationFolder permite al usuario decidir dónde se almacenarán las claves.

Ejemplo 7: Creación de una configuración genérica para su uso con cualquier máquina virtual de Azure.

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

Ejemplo 8: Proporcione el tipo de recurso del destino.

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

Este parámetro es útil cuando hay más de un recurso admitido con el mismo nombre en el grupo de recursos.

Parámetros

-CertificateFile

Certificado SSH que se usará para autenticarse en la cuenta de usuario local.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ConfigFilePath

Ruta de acceso a la que escribir la configuración de SSH.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Propiedades de parámetro

Tipo:IAzureContextContainer
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Force

Al conectarse a los recursos de Arc, no solicite confirmación antes de actualizar el puerto permitido para la conexión SSH en el punto de conexión para que coincida con el puerto de destino o para instalar el módulo Az.Ssh.ArcProxy desde el PowerShell Gallery, si es necesario.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Ip

Dirección IP de la máquina virtual de Azure de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

IpAddress
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-KeysDestinationFolder

Directorio donde se almacenarán las claves y certificados generados.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-LocalUser

Nombre de usuario de un usuario local en el recurso de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Nombre del Azure recurso de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Interactive
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Overwrite

Sobrescriba el archivo de configuración, en lugar de anexar una nueva entrada al final del archivo.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Port

Puerto al que conectarse en el host remoto.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PrivateKeyFile

Ruta de acceso al archivo de clave privada.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PublicKeyFile

Ruta de acceso al archivo de clave pública.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ResourceGroupName

Nombre del grupo de recursos.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Interactive
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-ResourceId

Identificador de recurso del recurso de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ResourceId
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-ResourceType

Tipo de recurso del recurso de destino.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:Microsoft.HybridCompute/machines, Microsoft.Compute/virtualMachines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Interactive
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-UsePrivateIp

Al conectarse a una máquina virtual de Azure, esta marca especifica que debe conectarse a una de las direcciones IP privadas de la máquina virtual. Requiere conectividad con la dirección IP privada.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Interactive
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ResourceId
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

String

Salidas

PSSshConfigEntry