Skip to content
DocsTry Aspire
DocsTry

SftpSettings Properties

ClassProperties8 members
Provides the client configuration settings for connecting to an SFTP server using SSH.NET.
ConnectionStringSection titled ConnectionStringnullablestring?
Gets or sets the connection string in the format "sftp://host:port".
public string? ConnectionString { get; set; }
DisableHealthChecksSection titled DisableHealthChecksbool
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; }
HealthCheckTimeoutSection titled HealthCheckTimeoutnullableTimeSpan?
Gets or sets the timeout duration for the health check.
public TimeSpan? HealthCheckTimeout { get; set; }
PasswordSection titled Passwordnullablestring?
Gets or sets the password for SFTP authentication.
public string? Password { get; set; }
PrivateKeyFileSection titled PrivateKeyFilenullablestring?
Gets or sets the path to a private key file for SFTP authentication.
public string? PrivateKeyFile { get; set; }
PrivateKeyPassphraseSection titled PrivateKeyPassphrasestring
Gets or sets the passphrase for the private key file for SFTP authentication.
public string PrivateKeyPassphrase { get; set; }
UsernameSection titled Usernamenullablestring?
Gets or sets the username for SFTP authentication.
public string? Username { get; set; }