When connecting to a default instances in SQL Server, users specify the host name with the port (1433 by default) as the host value in the sqlserver.yaml file. When troubleshooting connection issues with SQL Server, make sure we are connecting to a default instance or a named instance. Named instances can be connected using the
$SERVER\$INSTANCE_NAME syntax, but only if the SQL Server Browser service is enabled since this service will provide the port the instance is on.
Here are the docs from Microsoft with more about the SQL Server Browser service:
The SQL Server Browser service is required to use named instances and this service is disabled by default. We highly recommend the approval of a sys admin before enabling this service.
Once the SQL Server Browser service has been enabled, you can configure the sqlserver.yaml file to connect to a named instance by designating the named instance in the host value. For example:
- host: $SERVER\$INSTANCENAME