Package com.azure.resourcemanager.datafactory.models

Class SftpServerLinkedService

  • public final class SftpServerLinkedService
extends LinkedService
    A linked service for an SSH File Transfer Protocol (SFTP) server.

    • Constructor Detail

      • SftpServerLinkedService

        public SftpServerLinkedService()

    • Method Detail

      • withDescription

        public SftpServerLinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.

      • withAnnotations

        public SftpServerLinkedService withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        withAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.

      • host

        public Object host()
        Get the host property: The SFTP server host name. Type: string (or Expression with resultType string).
        Returns:
        the host value.

      • withHost

        public SftpServerLinkedService withHost​(Object host)
        Set the host property: The SFTP server host name. Type: string (or Expression with resultType string).
        Parameters:
        host - the host value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • port

        public Object port()
        Get the port property: 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.
        Returns:
        the port value.

      • withPort

        public SftpServerLinkedService withPort​(Object port)
        Set the port property: 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.
        Parameters:
        port - the port value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • authenticationType

        public SftpAuthenticationType authenticationType()
        Get the authenticationType property: The authentication type to be used to connect to the FTP server.
        Returns:
        the authenticationType value.

      • withAuthenticationType

        public SftpServerLinkedService withAuthenticationType​(SftpAuthenticationType authenticationType)
        Set the authenticationType property: The authentication type to be used to connect to the FTP server.
        Parameters:
        authenticationType - the authenticationType value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • username

        public Object username()
        Get the username property: The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
        Returns:
        the username value.

      • withUsername

        public SftpServerLinkedService withUsername​(Object username)
        Set the username property: The username used to log on to the SFTP server. Type: string (or Expression with resultType string).
        Parameters:
        username - the username value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • password

        public SecretBase password()
        Get the password property: Password to logon the SFTP server for Basic authentication.
        Returns:
        the password value.

      • withPassword

        public SftpServerLinkedService withPassword​(SecretBase password)
        Set the password property: Password to logon the SFTP server for Basic authentication.
        Parameters:
        password - the password value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • encryptedCredential

        public Object encryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.

      • withEncryptedCredential

        public SftpServerLinkedService withEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • privateKeyPath

        public Object privateKeyPath()
        Get the privateKeyPath property: 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).
        Returns:
        the privateKeyPath value.

      • withPrivateKeyPath

        public SftpServerLinkedService withPrivateKeyPath​(Object privateKeyPath)
        Set the privateKeyPath property: 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).
        Parameters:
        privateKeyPath - the privateKeyPath value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • privateKeyContent

        public SecretBase privateKeyContent()
        Get the privateKeyContent property: 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.
        Returns:
        the privateKeyContent value.

      • withPrivateKeyContent

        public SftpServerLinkedService withPrivateKeyContent​(SecretBase privateKeyContent)
        Set the privateKeyContent property: 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.
        Parameters:
        privateKeyContent - the privateKeyContent value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • passPhrase

        public SecretBase passPhrase()
        Get the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
        Returns:
        the passPhrase value.

      • withPassPhrase

        public SftpServerLinkedService withPassPhrase​(SecretBase passPhrase)
        Set the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.
        Parameters:
        passPhrase - the passPhrase value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • skipHostKeyValidation

        public Object skipHostKeyValidation()
        Get the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
        Returns:
        the skipHostKeyValidation value.

      • withSkipHostKeyValidation

        public SftpServerLinkedService withSkipHostKeyValidation​(Object skipHostKeyValidation)
        Set the skipHostKeyValidation property: If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).
        Parameters:
        skipHostKeyValidation - the skipHostKeyValidation value to set.
        Returns:
        the SftpServerLinkedService object itself.

      • hostKeyFingerprint

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

      • withHostKeyFingerprint

        public SftpServerLinkedService withHostKeyFingerprint​(Object hostKeyFingerprint)
        Set the hostKeyFingerprint property: The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).
        Parameters:
        hostKeyFingerprint - the hostKeyFingerprint value to set.
        Returns:
        the SftpServerLinkedService object itself.