Package version:

Interface SftpServerLinkedService

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

interface SftpServerLinkedService {
    annotations?: any[];
    authenticationType?: string;
    connectVia?: IntegrationRuntimeReference;
    description?: string;
    encryptedCredential?: string;
    host: any;
    hostKeyFingerprint?: any;
    parameters?: {
        [propertyName: string]: ParameterSpecification;
    };
    passPhrase?: SecretBaseUnion;
    password?: SecretBaseUnion;
    port?: any;
    privateKeyContent?: SecretBaseUnion;
    privateKeyPath?: any;
    skipHostKeyValidation?: any;
    type: "Sftp";
    userName?: any;
    version?: string;
}

Hierarchy (view full)

Properties

annotations? authenticationType? connectVia? description? encryptedCredential? host hostKeyFingerprint? parameters? passPhrase? password? port? privateKeyContent? privateKeyPath? skipHostKeyValidation? type userName? version?

Properties

Optionalannotations

annotations?: any[]

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

OptionalauthenticationType

authenticationType?: string

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

OptionalconnectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optionaldescription

description?: string

Linked service description.

OptionalencryptedCredential

encryptedCredential?: string

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

host

host: any

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

OptionalhostKeyFingerprint

hostKeyFingerprint?: any

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

Optionalparameters

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

Parameters for linked service.

OptionalpassPhrase

passPhrase?: SecretBaseUnion

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

Optionalpassword

password?: SecretBaseUnion

Password to logon the SFTP server for Basic authentication.

Optionalport

port?: any

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.

OptionalprivateKeyContent

privateKeyContent?: SecretBaseUnion

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.

OptionalprivateKeyPath

privateKeyPath?: any

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

OptionalskipHostKeyValidation

skipHostKeyValidation?: any

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

type

type

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

OptionaluserName

userName?: any

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

Optionalversion

version?: string

Version of the linked service.

Settings

Member Visibility