Share via

SftpServerLinkedService interface

Package:
@azure/arm-datafactory

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

Extends
LinkedService

Properties

authenticationType

The authentication type to be used to connect to the FTP server.
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).
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).
type

Polymorphic discriminator, which specifies the different types this object can be
userName

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

Inherited Properties

annotations

List of tags that can be used for describing the linked service.
connectVia

The integration runtime reference.
description

Linked service description.
parameters

Parameters for linked service.
version

Version of the linked service.

Property Details

authenticationType

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

authenticationType?: string

Property Value

string

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

string

host

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

host: any

Property Value

any

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

hostKeyFingerprint?: any

Property Value

any

passPhrase

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

passPhrase?: SecretBaseUnion

Property Value

SecretBaseUnion

password

Password to logon the SFTP server for Basic authentication.

password?: SecretBaseUnion

Property Value

SecretBaseUnion

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.

port?: any

Property Value

any

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.

privateKeyContent?: SecretBaseUnion

Property Value

SecretBaseUnion

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

privateKeyPath?: any

Property Value

any

skipHostKeyValidation

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

skipHostKeyValidation?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "Sftp"

Property Value

"Sftp"

userName

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

userName?: any

Property Value

any

Inherited Property Details

annotations

List of tags that can be used for describing the linked service.

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

IntegrationRuntimeReference

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version