SftpLinkedService Class

Definition

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

[Microsoft.Azure.Management.DataFactories.Models.AdfTypeName("Sftp")]
public class SftpLinkedService : Microsoft.Azure.Management.DataFactories.Models.LinkedServiceTypeProperties
Inheritance
Attributes

Constructors

SftpLinkedService()

Initializes a new instance of the SftpLinkedService class.

SftpLinkedService(String, String, String)

Initializes a new instance of the SftpLinkedService class with required arguments.

Properties

AuthenticationType

Required. The authentication type to be used to connect to the SFTP server. Must be Basic or SshPublicKey.

EncryptedCredential

Optional. The encrypted credential for Basic or SshPublicKey authentication.

GatewayName

Optional. The on-premises gateway name.

Host

Required. The SFTP server host name.

HostKeyFingerprint

Optional. The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified.

PassPhrase

Optional. The password to decrypt the SSH private key if the SSH private key is encrypted.

Password

Optional. Password to logon the SFTP server for Basic authentication.

Port

Optional. The TCP port number that the SFTP server uses to listen for client connections. Default value is 22.

PrivateKeyContent

Optional. 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.

PrivateKeyPath

Optional. 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.

SkipHostKeyValidation

Optional. If true, skip the SSH host key validation. Default value is false.

Username

Optional. The username used to log on to the SFTP server. It is required when EncryptedCredential is null.

Extension Methods

IsDefined(Object)
IsNull(Object)
IsPrimitive(Object)