SftpServerLinkedService Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

SftpServerLinkedService.cs

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

public class SftpServerLinkedService : Azure.ResourceManager.DataFactory.Models.DataFactoryLinkedServiceProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.SftpServerLinkedService>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.SftpServerLinkedService>

type SftpServerLinkedService = class
    inherit DataFactoryLinkedServiceProperties
    interface IJsonModel<SftpServerLinkedService>
    interface IPersistableModel<SftpServerLinkedService>

Public Class SftpServerLinkedService
Inherits DataFactoryLinkedServiceProperties
Implements IJsonModel(Of SftpServerLinkedService), IPersistableModel(Of SftpServerLinkedService)

Inheritance

Object

DataFactoryLinkedServiceProperties

SftpServerLinkedService

Implements

IJsonModel<SftpServerLinkedService> IPersistableModel<SftpServerLinkedService> IPersistableModel<T>

Constructors

SftpServerLinkedService(DataFactoryElement<String>)

Initializes a new instance of SftpServerLinkedService.

Properties

AdditionalProperties	Additional Properties To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryLinkedServiceProperties)
Annotations	List of tags that can be used for describing the linked service. To assign an object to the element of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }. (Inherited from DataFactoryLinkedServiceProperties)
AuthenticationType	The authentication type to be used to connect to the FTP server.
ConnectVia	The integration runtime reference. (Inherited from DataFactoryLinkedServiceProperties)
Description	Linked service description. (Inherited from DataFactoryLinkedServiceProperties)
EncryptedCredential	The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: 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).
LinkedServiceVersion	Version of the linked service. (Inherited from DataFactoryLinkedServiceProperties)
Parameters	Parameters for linked service. (Inherited from DataFactoryLinkedServiceProperties)
PassPhrase	The password to decrypt the SSH private key if the SSH private key is encrypted.
Password	Password to logon the SFTP server for Basic authentication.
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.
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).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DataFactoryLinkedServiceProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<DataFactoryLinkedServiceProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from DataFactoryLinkedServiceProperties)
IJsonModel<SftpServerLinkedService>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SftpServerLinkedService>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DataFactoryLinkedServiceProperties>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<DataFactoryLinkedServiceProperties>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from DataFactoryLinkedServiceProperties)
IPersistableModel<SftpServerLinkedService>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SftpServerLinkedService>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SftpServerLinkedService>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.