Skip to main content
Properties for Synapse 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
Azure Synapse Analytics server hostname or fully qualified domain name.
​
port
string
required
Port number for the Synapse server connection. Typically 1433 for SQL Server connections.
​
username
string
required
Username for authenticating to the Synapse server.
​
password
object
required
Reference to a Prophecy secret containing the 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.
​
database
string
required
Name of the database on the Synapse server that Prophecy will use by default for writing data.