SftpServerLinkedService Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

SftpServerLinkedService.cs

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

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SftpServerLinkedService+SftpServerLinkedServiceConverter))]
public class SftpServerLinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SftpServerLinkedService+SftpServerLinkedServiceConverter))>]
type SftpServerLinkedService = class
    inherit LinkedService

Public Class SftpServerLinkedService
Inherits LinkedService

Inheritance

Object

LinkedService

SftpServerLinkedService

Attributes

JsonConverterAttribute

Constructors

SftpServerLinkedService(Object)

Initializes a new instance of SftpServerLinkedService.

Properties

AdditionalProperties	Additional Properties. (Inherited from LinkedService)
Annotations	List of tags that can be used for describing the linked service. (Inherited from LinkedService)
AuthenticationType	The authentication type to be used to connect to the FTP server.
ConnectVia	The integration runtime reference. (Inherited from LinkedService)
Description	Linked service description. (Inherited from LinkedService)
EncryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Host	The SFTP server host name. Type: string (or Expression with resultType string).
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).
Parameters	Parameters for linked service. (Inherited from LinkedService)
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.
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.
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.
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.
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).
SkipHostKeyValidation	If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
UserName	The username used to log on to the SFTP server. Type: string (or Expression with resultType string).