Skip to content
Docs Try Aspire

SftpSettings Properties

Class Properties 8 members
Provides the client configuration settings for connecting to an SFTP server using SSH.NET.
ConnectionString Section titled ConnectionString nullable string?
Gets or sets the connection string in the format "sftp://host:port".
public string? ConnectionString { get; set; }
DisableHealthChecks Section titled DisableHealthChecks bool
Gets or sets a boolean value that indicates whether the SFTP health check is disabled or not.
public bool DisableHealthChecks { get; set; }
Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
public bool DisableTracing { get; set; }
HealthCheckTimeout Section titled HealthCheckTimeout nullable TimeSpan?
Gets or sets the timeout duration for the health check.
public TimeSpan? HealthCheckTimeout { get; set; }
Password Section titled Password nullable string?
Gets or sets the password for SFTP authentication.
public string? Password { get; set; }
PrivateKeyFile Section titled PrivateKeyFile nullable string?
Gets or sets the path to a private key file for SFTP authentication.
public string? PrivateKeyFile { get; set; }
PrivateKeyPassphrase Section titled PrivateKeyPassphrase string
Gets or sets the passphrase for the private key file for SFTP authentication.
public string PrivateKeyPassphrase { get; set; }
Username Section titled Username nullable string?
Gets or sets the username for SFTP authentication.
public string? Username { get; set; }