Azure SQL Database API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "azure_sql_db",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"tenant_id": "your_tenant_id",
"connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"update_method": "NATIVE_UPDATE | TELEPORT | BINARY_LOG_READER | MIXED_TELEPORT_CSA",
"always_encrypted": true,
"tunnel_user": "fivetran",
"tunnel_port": 22,
"auth_method": "Password | ActiveDirectory | EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | EntraIDManagedIdentity",
"database": "sqldb",
"password": "test_password",
"port": 1433,
"host": "sqlinstance.mycompany.com",
"tunnel_host": "XXX.XXX.XXX.XXX",
"user": "test_user",
"schema_prefix": "prefix"
},
"auth": {
"access_token": "my_access_token",
"service_principal_client_certificate": "service_principal_client_certificate",
"refresh_token": "my_refresh_token",
"service_principal_client_secret": "service_principal_client_secret",
"service_principal_id": "service_principal_id",
"managed_identity_user_assigned": "managed_identity_user_assigned",
"service_principal_client_cert_pvt_key": "service_principal_client_cert_pvt_key"
}
}
Config parameters
Name | Description |
---|---|
tenant_id | Azure AD tenant ID. |
connection_type | Possible values: Directly , PrivateLink , SshTunnel . SshTunnel is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: tunnel_host , tunnel_port , tunnel_user . Otherwise, Directly is used as a value if the parameter is omitted. |
update_method | (Optional) The incremental update method the connector will use. The possible values are "TELEPORT" or "NATIVE_UPDATE" . The type defaults to "NATIVE_UPDATE" if the value is set to null or not specified. |
always_encrypted | Require TLS through Tunnel. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
auth_method | Authentication Method. |
database | The database name. |
password | The user's password. |
port | The port number. |
host | DB instance host or IP address. |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
user | The user name. For Azure Databases, the format must be user@domain . |
schema_prefix | Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
default: By specifying the values for the
access_token
andrefresh_token
parameters in theauth
section and the value for thetenant_id
parameter in the request.POST https://api.fivetran.com/v1/connections
{ "service": "azure_sql_db", "group_id": "group_id", "config": { "tenant_id": "your_tenant_id" }, "auth": { "access_token": "my_access_token", "refresh_token": "my_refresh_token" } }
Auth Parameters
Name Description access_token
The long-lived Access token carries the information necessary to access API resources. refresh_token
The long-lived Refresh token carries the information necessary to get a new access token for API resources. By using the Connect Card or the Fivetran dashboard.