Class SftpServerLinkedServiceTypeProperties
java.lang.Object
com.azure.resourcemanager.datafactory.fluent.models.SftpServerLinkedServiceTypeProperties
Properties specific to this linked service type.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the authenticationType property: The authentication type to be used to connect to the FTP server.Get the encryptedCredential property: The encrypted credential used for authentication.host()
Get the host property: The SFTP server host name.Get the hostKeyFingerprint property: The host key finger-print of the SFTP server.Get the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.password()
Get the password property: Password to logon the SFTP server for Basic authentication.port()
Get the port property: The TCP port number that the SFTP server uses to listen for client connections.Get the privateKeyContent property: Base64 encoded SSH private key content for SshPublicKey authentication.Get the privateKeyPath property: The SSH private key file path for SshPublicKey authentication.Get the skipHostKeyValidation property: If true, skip the SSH host key validation.username()
Get the username property: The username used to log on to the SFTP server.void
validate()
Validates the instance.withAuthenticationType
(SftpAuthenticationType authenticationType) Set the authenticationType property: The authentication type to be used to connect to the FTP server.withEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.Set the host property: The SFTP server host name.withHostKeyFingerprint
(Object hostKeyFingerprint) Set the hostKeyFingerprint property: The host key finger-print of the SFTP server.withPassPhrase
(SecretBase passPhrase) Set the passPhrase property: The password to decrypt the SSH private key if the SSH private key is encrypted.withPassword
(SecretBase password) Set the password property: Password to logon the SFTP server for Basic authentication.Set the port property: The TCP port number that the SFTP server uses to listen for client connections.withPrivateKeyContent
(SecretBase privateKeyContent) Set the privateKeyContent property: Base64 encoded SSH private key content for SshPublicKey authentication.withPrivateKeyPath
(Object privateKeyPath) Set the privateKeyPath property: The SSH private key file path for SshPublicKey authentication.withSkipHostKeyValidation
(Object skipHostKeyValidation) Set the skipHostKeyValidation property: If true, skip the SSH host key validation.withUsername
(Object username) Set the username property: The username used to log on to the SFTP server.
-
Constructor Details
-
SftpServerLinkedServiceTypeProperties
public SftpServerLinkedServiceTypeProperties()
-
-
Method Details
-
host
Get the host property: The SFTP server host name. Type: string (or Expression with resultType string).- Returns:
- the host value.
-
withHost
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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
authenticationType
Get the authenticationType property: The authentication type to be used to connect to the FTP server.- Returns:
- the authenticationType value.
-
withAuthenticationType
public SftpServerLinkedServiceTypeProperties 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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
password
Get the password property: Password to logon the SFTP server for Basic authentication.- Returns:
- the password value.
-
withPassword
Set the password property: Password to logon the SFTP server for Basic authentication.- Parameters:
password
- the password value to set.- Returns:
- the SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
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 SftpServerLinkedServiceTypeProperties 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 SftpServerLinkedServiceTypeProperties object itself.
-
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
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 SftpServerLinkedServiceTypeProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-