## Description Migrates the standalone [azure-postgresql-auth](https://github.com/Azure/postgres-entra-auth/tree/main/javascript) library into the monorepo as `@azure/postgresql-auth` - a new Azure SDK client package providing Entra ID authentication for PostgreSQL connections via both `pg` (node-postgres) and Sequelize clients. ### Key changes: - **Source:** TypeScript implementation with full type safety - `getEntraTokenPassword()` - acquires Entra ID token for use as PostgreSQL password - `configureEntraIdAuth()` - registers Sequelize `beforeConnect` hook for automatic token-based auth - **Build:** Uses `warp` build system with 4 targets (browser, react-native, esm, commonjs) - **Tests:** 19 unit tests with vitest (all passing) - **Peer deps:** `pg` (>=8.0.0) and `sequelize` (>=6.0.0) as optional peer dependencies - **CI:** New `sdk/postgresql/ci.yml` data-plane pipeline - **CODEOWNERS:** Updated ### References - Standalone source: https://github.com/Azure/postgres-entra-auth/tree/main/javascript - .NET reference: https://github.com/Azure/azure-sdk-for-net/pull/55231 ## Release Plan Details - Release Plan: https://web.powerapps.com/apps/821ab569-ae60-420d-8264-d7b5d5ef734c?release-plan-id=0213048b-d1f0-f011-8407-000d3a3b8d97 - Work Item Link: https://dev.azure.com/azure-sdk/fe81d705-3c06-41e5-bf7c-5ebea18efe89/_workitems/edit/30201 - Spec Pull Request: - Spec API version: 1.0.0 --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Matthew Boentoro <[email protected]> Co-authored-by: Jeremy Meng <[email protected]>
2.2 KiB
Azure PostgreSQL Auth client library samples for JavaScript (Beta)
These sample programs show how to use the JavaScript client libraries for Azure PostgreSQL Entra ID authentication in some common scenarios.
| File Name | Description |
|---|---|
| pgConnection.js | Connect to Azure Database for PostgreSQL using Entra ID auth with the pg library |
| sequelizeConnection.js | Connect to Azure Database for PostgreSQL using Entra ID auth with Sequelize ORM |
Prerequisites
The sample programs are compatible with LTS versions of Node.js.
You need access to an Azure Database for PostgreSQL Flexible Server configured for Microsoft Entra ID authentication.
Setup
To run the samples using the published version of the package:
- Install the dependencies using
npm:
npm install
-
Edit the file
sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file fromsample.envto just.env. The sample programs will read this file automatically. -
Run whichever samples you like (note that some samples may require additional setup, see the table above):
node pgConnection.js
Next Steps
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.