FtpServerLinkedService Class

A FTP server Linked Service.

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

Inheritance

azure.synapse.artifacts.models._models_py3.LinkedService

FtpServerLinkedService

Constructor

FtpServerLinkedService(*, 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.FtpAuthenticationType]] = None, user_name: Optional[object] = None, password: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, encrypted_credential: Optional[object] = None, enable_ssl: Optional[object] = None, enable_server_certificate_validation: 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. Host name of the FTP server. Type: string (or Expression with resultType string).

port

object

Required

The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.

authentication_type

str or FtpAuthenticationType

Required

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

user_name

object

Required

Username to logon the FTP server. Type: string (or Expression with resultType string).

password

SecretBase

Required

Password to logon the FTP server.

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

enable_ssl

object

Required

If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

enable_server_certificate_validation

object

Required

If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).