SftpServerLinkedService Class

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

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

SftpServerLinkedService

Constructor

SftpServerLinkedService(*, host: Any, additional_properties: Optional[Dict[str, Any]] = None, connect_via: Optional[_models.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, port: Optional[Any] = None, authentication_type: Optional[Union[str, _models.SftpAuthenticationType]] = None, user_name: Optional[Any] = None, password: Optional[_models.SecretBase] = None, encrypted_credential: Optional[Any] = None, private_key_path: Optional[Any] = None, private_key_content: Optional[_models.SecretBase] = None, pass_phrase: Optional[_models.SecretBase] = None, skip_host_key_validation: Optional[Any] = None, host_key_fingerprint: Optional[Any] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of linked service.Constant filled by server.

connect_via

IntegrationRuntimeReference

The integration runtime reference.

description

str

Linked service description.

parameters

dict[str, ParameterSpecification]

Parameters for linked service.

annotations

list[any]

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

host

any

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

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.

authentication_type

str or SftpAuthenticationType

The authentication type to be used to connect to the FTP server. Known values are: "Basic", "SshPublicKey", "MultiFactor".

user_name

any

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

password

SecretBase

Password to logon the SFTP server for Basic authentication.

encrypted_credential

any

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

private_key_path

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

private_key_content

SecretBase

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.

pass_phrase

SecretBase

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

skip_host_key_validation

any

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

host_key_fingerprint

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