Package version:

Interface SftpServerLinkedService

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

Hierarchy

Properties

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

Properties

Optional annotations

annotations?: any[]

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

Optional authenticationType

authenticationType?: string

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

Optional connectVia

connectVia?: IntegrationRuntimeReference

The integration runtime reference.

Optional description

description?: string

Linked service description.

Optional encryptedCredential

encryptedCredential?: any

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

host

host: any

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

Optional hostKeyFingerprint

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

Optional parameters

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

Parameters for linked service.

Type declaration

Optional passPhrase

passPhrase?: SecretBaseUnion

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

Optional password

password?: SecretBaseUnion

Password to logon the SFTP server for Basic authentication.

Optional port

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.

Optional privateKeyContent

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.

Optional privateKeyPath

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

Optional skipHostKeyValidation

skipHostKeyValidation?: any

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

type

type: "Sftp"

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

Optional userName

userName?: any

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

Settings

Member Visibility

Theme

Generated using TypeDoc