SftpServerLinkedService Class

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

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

Inheritance

azure.mgmt.datafactory.models._models_py3.LinkedService

SftpServerLinkedService

Constructor

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

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
host	<xref:JSON> The SFTP server host name. Type: string (or Expression with resultType string). Required.
port	<xref:JSON> 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", and "MultiFactor".
user_name	<xref:JSON> 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	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
private_key_path	<xref:JSON> 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	<xref:JSON> If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
host_key_fingerprint	<xref:JSON> The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Type of linked service. Required.
version	str Version of the linked service.
connect_via	IntegrationRuntimeReference The integration runtime reference.
description	str Linked service description.
parameters	dict[str, ParameterSpecification] Parameters for linked service.
annotations	list[<xref:JSON>] List of tags that can be used for describing the linked service.
host	<xref:JSON> The SFTP server host name. Type: string (or Expression with resultType string). Required.
port	<xref:JSON> 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", and "MultiFactor".
user_name	<xref:JSON> 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	str The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
private_key_path	<xref:JSON> 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	<xref:JSON> If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
host_key_fingerprint	<xref:JSON> The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).