Azure SQL Connection
Prerequisite:
Gathr application should be allowed to access Azure SQL database resources by adding Gathr IPs 3.13.24.114 and 3.128.81.146 in the public network firewall settings.
In case if you want to utilize a registered cluster to run application, the respective IPs of registered compute environment should be added in the public network firewall settings.
Configuration
Configure the Azure SQL connection by providing the details for each field as per the table below:
Connection Name: Name of the connection to be created.
Authentication Type: Gathr provides two ways to authenticate the Azure SQL connection with the database.
Basic Authentication: Authenticate by providing database username and password.
Service Principal: Create a service principal for Gathr application and provide the Tenant Id, Application (Client) Id and Client Secret to authenticate the connection.
Connection Type: Option to choose between either connecting securely using SSH Tunnel or, proceed with a direct connection.
If Connection Type value is SSH Tunnel, additional fields will be displayed as given below:
To know more about SSH Tunneling with Gathr, see SSH Tunneling.
SSH Key: The SSH key should be provided to authenticate the associated SSH host and SSH user.
SSH Host: Public IP address of your SSH host.
SSH User: Default SSH username.
If Connection Type value is Direct Connection, then proceed by updating the following fields.
Database Type: Choose the database out of Azure SQL or SQL Server that should be connected.
Database Name: Name of the database to be connected should be provided in this field.
Hosts: Database hostname should be provided.
Example:
jdbc:sqlserver://myauthserver.database.windows.net
Port: Database port number should be provided.
Example: 1433
If Authentication Type is selected as Basic Authentication, database username and password will be required.
Username: The username used to connect to the database should be provided.
Example: admin@myauthserver
Password: The password used to connect to the database should be provided.
If Authentication Type is selected as Service Principal, Tenant Id, Application (Client) Id and Client Secret will be required.
To understand the steps for creating Tenant Id and Application (Client) Id, refer to the link below:
To understand the steps for creating Client Secret, refer to the link below:
Create a new application secret
Tenant Id: The unique tenant ID of your Azure account should be provided.
Application (Client) Id: The unique client key of your Azure account should be provided.
Client Secret: The client secret that you created should be provided.
Continue to configure the remaining connection parameters as per the connection strings details configured in your database settings.
Encrypt: Based on the encryption setting in database to be connected, select either true or false.
Trust Server Certificate: Based on the Trust Server Certificate setting in database to be connected, select either true or false.
Host Name In Certificate: Optional. The host name given in the trust service certificate should be provided.
Example: *.database.windows.net
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated. Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!