SQL Database - SDK Patterns

Node.js (mssql)

const sql = require('mssql');

const config = \{
  server: process.env.SQL_SERVER,
  database: process.env.SQL_DATABASE,
  authentication: \{
    type: 'azure-active-directory-default'
  \},
  options: \{
    encrypt: true
  \}
\};

const pool = await sql.connect(config);

Python (pyodbc)

Auth: DefaultAzureCredential is for local development. See auth-best-practices.md for production patterns.

import pyodbc
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
token = credential.get_token("https://database.windows.net/.default")

conn = pyodbc.connect(
    f"Driver={{ODBC Driver 18 for SQL Server}};"
    f"Server=\{os.environ['SQL_SERVER']\};"
    f"Database=\{os.environ['SQL_DATABASE']\};"
    f"Authentication=ActiveDirectoryMsi"
)

.NET (Entity Framework Core)

Required NuGet Packages:

dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.Data.SqlClient --version 5.1.0
dotnet add package Azure.Identity

Connection string (Entra ID):

Server=tcp:\{server\}.database.windows.net,1433;Database=\{database\};Authentication=Active Directory Default;Encrypt=True;

Configuration:

services.AddDbContext<AppDbContext>(options =>
    options.UseSqlServer(
        Configuration.GetConnectionString("DefaultConnection"),
        sqlOptions => sqlOptions.EnableRetryOnFailure()
    ));

appsettings.json:

\{
  "ConnectionStrings": \{
    "DefaultConnection": "Server=tcp:myserver.database.windows.net,1433;Database=mydb;Authentication=Active Directory Default;Encrypt=True;"
  \}
\}

Connection String Format

Server=tcp:\{server\}.database.windows.net,1433;Database=\{database\};Authentication=Active Directory Default;Encrypt=True;