Feedback Edit

SftpServerLinkedService Class

  • Reference

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.synapse.artifacts.models._models_py3.LinkedService
SftpServerLinkedService

Constructor

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

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

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

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

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

host
object
Required

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

port
object
Required

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
Required

The authentication type to be used to connect to the FTP server. Possible values include: "Basic", "SshPublicKey".

user_name
object
Required

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

password
SecretBase
Required

Password to logon the SFTP server for Basic authentication.

encrypted_credential
object
Required

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
object
Required

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
Required

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
Required

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

skip_host_key_validation
object
Required

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

host_key_fingerprint
object
Required

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