Share via


SftpServerLinkedService Class

Definition

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

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("Sftp")]
public class SftpServerLinkedService : Microsoft.Azure.Management.DataFactory.Models.LinkedService
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("Sftp")>]
type SftpServerLinkedService = class
    inherit LinkedService
Public Class SftpServerLinkedService
Inherits LinkedService
Inheritance
SftpServerLinkedService
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

SftpServerLinkedService()

Initializes a new instance of the SftpServerLinkedService class.

SftpServerLinkedService(Object, IDictionary<String,Object>, IntegrationRuntimeReference, String, IDictionary<String,ParameterSpecification>, IList<Object>, Object, String, Object, SecretBase, Object, Object, SecretBase, SecretBase, Object, Object)

Initializes a new instance of the SftpServerLinkedService class.

Properties

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from LinkedService)
Annotations

Gets or sets list of tags that can be used for describing the linked service.

(Inherited from LinkedService)
AuthenticationType

Gets or sets the authentication type to be used to connect to the FTP server. Possible values include: 'Basic', 'SshPublicKey', 'MultiFactor'

ConnectVia

Gets or sets the integration runtime reference.

(Inherited from LinkedService)
Description

Gets or sets linked service description.

(Inherited from LinkedService)
EncryptedCredential

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

Host

Gets or sets the SFTP server host name. Type: string (or Expression with resultType string).

HostKeyFingerprint

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

Parameters

Gets or sets parameters for linked service.

(Inherited from LinkedService)
PassPhrase

Gets or sets the password to decrypt the SSH private key if the SSH private key is encrypted.

Password

Gets or sets password to logon the SFTP server for Basic authentication.

Port

Gets or sets 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.

PrivateKeyContent

Gets or sets 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

Gets or sets 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).

SkipHostKeyValidation

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

UserName

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

Methods

Validate()

Validate the object.

Applies to