Microsoft SQL Server Connector > Microsoft SQL Server connections > Microsoft SQL Server connection properties
  

Microsoft SQL Server connection properties

When you set up a Microsoft SQL Server connection, you must configure the connection properties.
The following table describes the Microsoft SQL Server connection properties:
Connection property
Description
Runtime Environment
The name of the runtime environment where you want to run the tasks.
Specify a Secure Agent, Hosted Agent, or serverless runtime environment.
SQL Server Version
Microsoft SQL Server database version.
Authentication Mode
Authentication method to access Microsoft SQL Server. Select one of the following methods:
  • - SQL Server Authetication: Enter your Microsoft SQL Server user name and password to access Microsoft SQL Server.
  • - Windows Authentication (Deprecated): Use the Microsoft Windows authentication to access Microsoft SQL Server. This option is available when you access Data Integration by using Microsoft Windows. When you choose this option, you do not need to enter credentials to access Microsoft SQL Server. To use Windows authentication in an SQL Server connection, ensure that the user account that starts the Secure Agent service is available in the Microsoft SQL Server database.
  • Note: Windows authentication is not certified for Microsoft SQL Server 2017 version hosted on Linux. You cannot configure Windows Authentication when you use a serverless runtime environment.
  • - Active Directory Password: Enter the Azure Active Directory user name and password to authenticate and access the Microsoft Azure SQL Database.
  • - Windows Authentication v2: Use this authentication method to access Microsoft SQL Server from Data Integration using the Secure Agent hosted on a Linux or Windows machine. When you choose the Windows Authentication v2 mode, enter your domain name and your Microsoft Windows credentials to access Microsoft SQL Server. To use Windows Authentication v2 in an SQL Server connection using the Windows agent, ensure that the user account that starts the Secure Agent service is available in the Microsoft SQL Server database.
  • Note: You cannot configure Windows Authentication when you use a serverless runtime environment.
Domain
Required for Windows Authentication v2.
The domain name of the Windows user.
User Name
User name for the database login. The user name cannot contain a semicolon.
To connect to Microsoft Azure SQL Database, you must specify the user name in the following format: username@host
For Windows Authentication v2, you must specify the Windows NT user name.
Note: This property is not applicable if you use the Windows Authentication mode to access Microsoft SQL Server.
Password
Password for the database login. The password cannot contain a semicolon.
For Windows Authentication v2, you must specify the Windows NT password.
Note: This property is not applicable if you use the Windows Authentication mode to access Microsoft SQL Server.
Host
Name of the machine hosting the database server.
To connect to Microsoft Azure SQL Database, specify the fully qualified host name. For example, vmjcmwxsfboheng.westus.cloudapp.azure.com
Port
Network port number used to connect to the database server. Default port number is 1433.
Instance Name
Instance name of the Microsoft SQL Server database.
Database Name
Database name for the Microsoft SQL Server target. Database name is case sensitive if the database is case sensitive. Maximum length is 100 characters.
Database names can include alphanumeric and underscore characters.
Schema
Schema used for the target connection.
Code Page
The code page of the database server.
Encryption Method
The method that the Secure Agent uses to encrypt the data sent between the driver and the database server. You can use the encryption method to connect to Microsoft Azure SQL Database.
Note: When you use a serverless runtime environment, you cannot configure a Microsoft SQL Server connection to use SSL to securely communicate with the Microsoft SQL Server database.
Crypto Protocol Version
Cryptographic protocols to use when you enable SSL encryption.
Validate Server Certificate
When set to True, Secure Agent validates the certificate that is sent by the database server.
If you specify the HostNameInCertificate parameter, Secure Agent also validates the host name in the certificate.
When set to false, the Secure Agent does not validate the certificate that is sent by the database server.
Trust Store
The location and name of the trust store file. The trust store file contains a list of Certificate Authorities (CAs) that the driver uses for SSL server authentication.
For the serverless runtime environment, specify the following certificate path in the serverless agent directory:
data2/home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<TrustStore_filename>
Trust Store Password
The password to access the contents of the trust store file.
Host Name in Certificate
Host name of the machine that hosts the secure database. If you specify a host name, the Secure Agent validates the host name included in the connection with the host name in the SSL certificate.
Metadata Advanced Connection Properties
The additional properties for the JDBC driver to fetch the metadata. If you specify more than one property, separate each key-value pair with a semicolon.
Runtime Advanced Connection Properties
The additional properties for the ODBC driver for running mappings. If you specify more than one property, separate each key-value pair with a semicolon.