Class SftpServerLinkedService

A linked service for an SSH File Transfer Protocol (SFTP) server.

Inheritance
System.Object
LinkedService
SftpServerLinkedService
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SftpServerLinkedService/SftpServerLinkedServiceConverter))]
public class SftpServerLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

Constructors

SftpServerLinkedService(Object)

Initializes a new instance of SftpServerLinkedService.

Declaration
public SftpServerLinkedService (object host);
Parameters
System.Object host

The SFTP server host name. Type: string (or Expression with resultType string).
Exceptions
System.ArgumentNullException

host is null.

Properties

AuthenticationType

The authentication type to be used to connect to the FTP server.

Declaration
public Nullable<Azure.Analytics.Synapse.Artifacts.Models.SftpAuthenticationType> AuthenticationType { get; set; }
Property Value
System.Nullable<SftpAuthenticationType>

EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Declaration
public object EncryptedCredential { get; set; }
Property Value
System.Object

Host

The SFTP server host name. Type: string (or Expression with resultType string).

Declaration
public object Host { get; set; }
Property Value
System.Object

HostKeyFingerprint

The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

Declaration
public object HostKeyFingerprint { get; set; }
Property Value
System.Object

PassPhrase

The password to decrypt the SSH private key if the SSH private key is encrypted. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase PassPhrase { get; set; }
Property Value
SecretBase

Password

Password to logon the SFTP server for Basic authentication. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase Password { get; set; }
Property Value
SecretBase

Port

The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.

Declaration
public object Port { get; set; }
Property Value
System.Object

PrivateKeyContent

Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.SecretBase PrivateKeyContent { get; set; }
Property Value
SecretBase

PrivateKeyPath

The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).

Declaration
public object PrivateKeyPath { get; set; }
Property Value
System.Object

SkipHostKeyValidation

If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).

Declaration
public object SkipHostKeyValidation { get; set; }
Property Value
System.Object

UserName

The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

Declaration
public object UserName { get; set; }
Property Value
System.Object