@azure/postgresql-auth package

配置一个 Sequelize 实例以使用 Entra ID 认证。

该函数在 Sequelize 实例上注册一个 beforeConnect 钩子，在每次新的数据库连接前自动获取一个 Entra ID 令牌。 钩子从JWT令牌声明中提取用户名（upn 或 appid），并在连接配置中设置用户名和密码。

Example

import { DefaultAzureCredential } from "@azure/identity";

const { configureEntraAuthentication } = await import("@azure/postgresql-auth");
const { Sequelize } = await import("sequelize");
const sequelize = new Sequelize({
  dialect: "postgres",
  host: process.env.PGHOST,
  port: Number(process.env.PGPORT || 5432),
  database: process.env.PGDATABASE,
});
const credential = new DefaultAzureCredential();
configureEntraAuthentication(sequelize, credential);
await sequelize.authenticate();

function configureEntraAuthentication(sequelizeInstance: SequelizeBeforeConnectHook, credential: TokenCredential, options?: ConfigureEntraAuthenticationOptions)

参数

创建密码提供者函数，获取适合用作 PostgreSQL 密码的 Entra ID 访问令牌。

该函数返回回调，调用时会利用Azure Database for PostgreSQL作用域从提供的 <xref:TokenCredential> 请求一个令牌。 返回的回调可以直接作为 password 选项传递给 pg.Client、 pg.Pool或类似的 PostgreSQL 客户端配置。

Example

import { DefaultAzureCredential } from "@azure/identity";

const { entraTokenProvider } = await import("@azure/postgresql-auth");
const pg = await import("pg");
const credential = new DefaultAzureCredential();
const pool = new pg.Pool({
  host: process.env.PGHOST,
  port: Number(process.env.PGPORT || 5432),
  database: process.env.PGDATABASE,
  user: process.env.PGUSER,
  password: entraTokenProvider(credential),
  ssl: { rejectUnauthorized: true },
});

function entraTokenProvider(credential: TokenCredential, options?: EntraTokenProviderOptions): () => Promise<string>

参数

返回

一个函数，调用时返回一个承诺，解析为访问令牌字符串。