The Azure SQL Synapse enables data synchronization between Azure SQL schema and Syncari entities. After the Synapse is authenticated, a user can activate the Azure SQL Synapse, which enables Syncari to replicate the schema of Azure SQL and make it available within the Unified Data Model. Using Sync Studio, a user can map Azure SQL tables to Syncari entities, and Azure SQL fields to Syncari fields.
If your Azure SQL security requires you to whitelist an IP you can find that here.
Azure SQL Information
You will need the following information from your Azure SQL administrator:
- Cluster Name
- Database Name
- Schema Name
API User Setup
Create Entra Authentication Application
- Ensure Entra authentication is enabled for this server. Go to the SQL Server -> Settings -> Microsoft Entra ID
- To create the application, From Azure Home, go to Microsoft Entra ID or Default Directory. Click on App Registrations
- Click on New Registration
- Enter a Name and select the appropriate account type: (minimum requirement: Single tenant) and click Register
- Copy the Name and the Client ID. Go to Client Credentials, create a new Client secret and copy the Client Secret value.
- Click on API Permissions and add user_impersonation permission for Azure SQL Database
- Go to Endpoints and copy the value for OAuth 2.0 Token Endpoint (v2)
Create Database User
Use the name of the created Entra application
CREATE USER [apiuser] FROM EXTERNAL PROVIDER
Grant access to the schema
GRANT SELECT, INSERT, UPDATE, DELETE ON SCHEMA :: [Schema Name] TO [apiuser];
Synapse Setup
Step 1: Start by logging in to your Syncari subscription
- Navigate to Synapses
- Find Azure SQL in the Synapse Library
- Drag the Azure SQL Synapse to the canvas
Step 2: Configure your Synapse parameters
- Enter
[Synapse Name]
This will be the label name for the Synapse in Syncari - Enter
[Cluster Name]
- Enter
[Schema Name]
- Enter
[Database Name]
- Enter
[Access Token URL]
- Use the value we copied for OAuth 2.0 Token Endpoint (v2)
- Click "Next"
Step 3: Define your authentication parameters and authenticate:
- Enter
[Client ID]
- Enter
[Client Secret]
- Click "Authenticate"
- Click "Next"
Step 4: Activate your Synapse
- Click "Make Synapse Active"
- Click "Close"
Congratulations! You have completed the setup of Azure SQL.
If you receive any errors message after clicking Authenticate, confirm each of the parameters in the previous steps are configured properly. If the error persists, contact one of our Onboarding and Support team members.