Skip to main content
Properties for Microsoft SQL Server (MSSQL) connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

​
server
string
required
MSSQL server hostname or fully qualified domain name.
​
port
string
required
Port number for the MSSQL server connection. Typically 1433 for SQL Server connections.
​
username
string
required
Username for authenticating to the MSSQL server.
​
password
object
required
Reference to a Prophecy secret containing the MSSQL password.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.
​
kgConfig
object
Knowledge graph configuration settings for the connection. See the Knowledge graph indexer properties for more information.