Skip to content

how-to-integrate-sql-database.md

Latest commit

 

History

History
365 lines (271 loc) · 26.3 KB

how-to-integrate-sql-database.md

File metadata and controls

365 lines (271 loc) · 26.3 KB
title Integrate Azure SQL Database with Service Connector
description Learn how to integrate Azure SQL Database into your application with Service Connector by using the supported authentication methods and clients.
author maud-lv
ms.author malev
ms.service service-connector
ms.topic how-to
ms.custom engagement-fy23
ms.date 02/02/2026

Integrate Azure SQL Database with Service Connector

In this article, we cover the supported authentication methods and clients that you can use to connect your apps to Azure SQL Database using Service Connector. For each supported method, we provide sample code and describe the default environment variable names, values, and configuration obtained when creating a service connection.

Supported compute services

Service Connector can be used to connect the following compute services to Azure SQL Database:

  • Azure App Service
  • Azure Container Apps
  • Azure Functions
  • Azure Kubernetes Service (AKS)
  • Azure Spring Apps

Supported authentication types and clients

The following table shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure SQL Database using Service Connector. A Yes indicates that the combination is supported, while a No indicates that it isn't supported.

Client type System-assigned managed identity User-assigned managed identity Secret/connection string Service principal
.NET Yes Yes Yes Yes
Go No No Yes No
Java Yes Yes Yes Yes
Java - Spring Boot Yes Yes Yes Yes
Node.js Yes Yes Yes Yes
PHP No No Yes No
Python Yes Yes Yes Yes
Python - Django No No Yes No
Ruby No No Yes No
None Yes Yes Yes Yes

Note

System-assigned managed identity, user-assigned managed identity and service principal authentication is only supported on Azure CLI.

Default environment variable names or application properties and sample code

Use the following connection details to connect compute services to Azure SQL Database. For each example, replace the placeholder texts <sql-server>, <sql-database>, <sql-username>, and <sql-password> with your own server name, database name, user ID, and password. For more information about naming conventions, check the Service Connector internals article.

System-assigned managed identity

.NET

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string Data Source=<sql-server>.database.windows.net,1433;Initial Catalog=<sql-database>;Authentication=ActiveDirectoryManagedIdentity

Java

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-database>;authentication=ActiveDirectoryMSI;

Spring Boot

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
spring.datasource.url Azure SQL Database datasource URL jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-db>;authentication=ActiveDirectoryMSI;

Python

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATION Azure SQL authentication ActiveDirectoryMsi

NodeJS

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATIONTYPE Azure SQL Database authentication type azure-active-directory-default

Other

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATION Azure SQL Database authentication type azure-active-directory-default

Sample code

To connect to Azure SQL Database using a system-assigned managed identity, refer to the following steps and sample code. [!INCLUDE code sample for sql]

User-assigned managed identity

.NET

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string Data Source=<sql-server>.database.windows.net,1433;Initial Catalog=<sql-database>;User ID=<identity-client-ID>;Authentication=ActiveDirectoryManagedIdentity

Java

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-database>;msiClientId=<msiClientId>;authentication=ActiveDirectoryMSI;

Spring Boot

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
spring.datasource.url Azure SQL Database datasource URL jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-db>;msiClientId=<msiClientId>;authentication=ActiveDirectoryMSI;

Python

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USER Azure SQL Database user Object (principal) ID
AZURE_SQL_AUTHENTICATION Azure SQL authentication ActiveDirectoryMsi

NodeJS

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATIONTYPE Azure SQL Database authentication type azure-active-directory-default
AZURE_SQL_CLIENTID Azure SQL Database client ID <identity-client-ID>

Other

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATION Azure SQL Database authentication type azure-active-directory-default
AZURE_SQL_USERNAME Azure SQL Database client ID <your Client ID>

Sample code

To connect to Azure SQL Database using a user-assigned managed identity, refer to the following steps and sample code. [!INCLUDE code sample for sql]

Connection string

Warning

Microsoft recommends that you use the most secure authentication flow available. The authentication flow described in this procedure requires a high degree of trust in the application, and carries risks that aren't present in other flows. You should only use this flow when other more secure flows, such as managed identities, aren't viable.

.NET

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string Data Source=<sql-server>.database.windows.net,1433;Initial Catalog=<sql-database>;Password=<sql-password>

Java

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-database>;user=<sql-username>;password=<sql-password>;

Spring Boot

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
spring.datasource.url Azure SQL Database datasource URL jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-db>;
spring.datasource.username Azure SQL Database datasource username <sql-user>
spring.datasource.password Azure SQL Database datasource password <sql-password>

Python

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USER Azure SQL Database user <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

Django

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database host <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_NAME Azure SQL Database name <sql-database>
AZURE_SQL_USER Azure SQL Database user <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

Go

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string server=<sql-server>.database.windows.net;port=1433;database=<sql-database>;user id=<sql-username>;password=<sql-password>;

NodeJS

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USERNAME Azure SQL Database username <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

PHP

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVERNAME Azure SQL Database servername <sql-server>.database.windows.net,1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_UID Azure SQL Database unique identifier (UID) <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

Ruby

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database host <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USERNAME Azure SQL Database username <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

Other

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database host <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USERNAME Azure SQL Database username <sql-username>
AZURE_SQL_PASSWORD Azure SQL Database password <sql-password>

Sample code

To connect to Azure SQL Database using a connection string, refer to the following steps and sample code. [!INCLUDE code sample for sql]

Service principal

.NET

[!div class="mx-tdBreakAll"]

Default environment variable name Description Example value
AZURE_SQL_CLIENTID Your client ID <client-ID>
AZURE_SQL_CLIENTSECRET Your client secret <client-secret>
AZURE_SQL_TENANTID Your tenant ID <tenant-ID>
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string Data Source=<sql-server>.database.windows.net,1433;Initial Catalog=<sql-database>;User ID=<client-Id>;Password=<client-secret>;Authentication=ActiveDirectoryServicePrincipal

Java

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_CONNECTIONSTRING Azure SQL Database connection string jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-database>;user=<client-Id>;password=<client-secret>;authentication=ActiveDirectoryServicePrincipal;

Spring Boot

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
spring.datasource.url Azure SQL Database datasource URL jdbc:sqlserver://<sql-server>.database.windows.net:1433;databaseName=<sql-db>;authentication=ActiveDirectoryServicePrincipal;
spring.datasource.username Azure SQL Database datasource username <client-Id>
spring.datasource.password Azure SQL Database datasource password <client-Secret>

Python

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_USER Azure SQL Database user your Client Id
AZURE_SQL_AUTHENTICATION Azure SQL authentication ActiveDirectoryServerPrincipal
AZURE_SQL_PASSWORD Azure SQL Database password your Client Secret

NodeJS

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_SERVER Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATIONTYPE Azure SQL Database authentication type azure-active-directory-default
AZURE_SQL_CLIENTID Azure SQL Database client ID <your Client ID>
AZURE_SQL_CLIENTSECRET Azure SQL Database client Secret <your Client Secret >
AZURE_SQL_TENANTID Azure SQL Database Tenant ID <your Tenant ID>

Other

[!div class="mx-tdBreakAll"]

Default environment variable name Description Sample value
AZURE_SQL_HOST Azure SQL Database server <sql-server>.database.windows.net
AZURE_SQL_PORT Azure SQL Database port 1433
AZURE_SQL_DATABASE Azure SQL Database database <sql-database>
AZURE_SQL_AUTHENTICATION Azure SQL Database authentication type azure-active-directory-default
AZURE_SQL_USERNAME Azure SQL Database client ID <your Client ID>
AZURE_SQL_PASSWORD Azure SQL Database client Secret <your Client Secret >

Sample code

To connect to Azure SQL Database using a service principal, refer to the following steps and sample code. [!INCLUDE code sample for sql]

Next steps

To learn more about Service Connector, see the following tutorial.

[!div class="nextstepaction"] Learn about Service Connector concepts