PSSshConfigEntry Class

Definition

Namespace:

Microsoft.Azure.Commands.Ssh.Models

Assembly:

Microsoft.Azure.PowerShell.Cmdlets.Ssh.dll

Class that represents an Ssh Configuration file to connect to Azure Resources.

public class PSSshConfigEntry

type PSSshConfigEntry = class

Public Class PSSshConfigEntry

Inheritance

Object

PSSshConfigEntry

Constructors

PSSshConfigEntry(Dictionary<String,String>)

Properties

CertificateFile	Path to certificate file.
ConfigString	String built from the value of this object's properties. Note 1: If LocalUser login, "-{localusername}" is appended to host. Note 2: Azure VMs have two entries if resource name and group are known. One with {rg}-{name} as host, and one with {ip} as host.
Host	Alias of the host in the config file. If we know Resource Name and Resource Group, host will be "{rg}-{name}" If we only know the Ip, host will be "{Ip}"
HostName	Actual host name. Ip address for Azure VMs and resource name for arc servers.
IdentityFile	Path to private key file.
LoginType	Either AAD or LocalUser
Port	Ssh Port.
ProxyCommand	Command to connect to host via Arc Connectivity Proxy.
ResourceType	Microsoft.HybridCompute/machines or Microsoft.Compute/virtualMachines.
User	Username.

Methods

ToString()