Skip to content

Update and restructure Azure PostgreSQL EF Core and Azure SQL Database EF Core integration docs#370

Merged
IEvangelist merged 10 commits intomicrosoft:mainfrom
alistairmatthews:restructure-azure-efcore-integrations
Feb 5, 2026
Merged

Update and restructure Azure PostgreSQL EF Core and Azure SQL Database EF Core integration docs#370
IEvangelist merged 10 commits intomicrosoft:mainfrom
alistairmatthews:restructure-azure-efcore-integrations

Conversation

@alistairmatthews
Copy link
Contributor

The existing EF Core integration documents for Azure PostgreSQL and Azure SQL Database are comprehensive but difficult for beginners. This PR is intended to keep the comprehensive information but make it easier for those who want to get going quickly.

This PR:

  • Splits the large integration doc into two: Hosting and Client.
  • Adds a getting started short tutorial.
  • Adds a Properties of the Azure <databasename> resources section to the client reference docs. This describes what configuration values are injected by the WithReference() method.

Copilot AI and others added 7 commits February 3, 2026 16:26
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
Co-authored-by: alistairmatthews <41286777+alistairmatthews@users.noreply.github.com>
…e-integrations

Restructure Azure PostgreSQL and Azure SQL EF Core integration docs
Copilot AI review requested due to automatic review settings February 4, 2026 15:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Restructures the Azure SQL and Azure PostgreSQL EF Core integration documentation to be more beginner-friendly while keeping reference depth.

Changes:

  • Added new “Get started” guides for Azure SQL and Azure PostgreSQL EF Core integrations.
  • Split Azure SQL documentation into separate Hosting (AppHost) and Client (EF Core) reference pages.
  • Replaced the monolithic Azure PostgreSQL EF Core doc with new, focused pages and updated sidebar + redirects accordingly.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-host.mdx New hosting reference doc for AppHost Azure SQL resource modeling and options.
src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-get-started.mdx New quickstart tutorial for Azure SQL hosting + EF Core client setup.
src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx Refocused into a client reference doc and added “Properties of the Azure SQL resources” section.
src/frontend/src/content/docs/integrations/databases/efcore/azure-postgresql/azure-postgresql-get-started.mdx New quickstart tutorial for Azure PostgreSQL hosting + EF Core client setup.
src/frontend/src/content/docs/integrations/databases/efcore/azure-postgresql/azure-postgresql-client.mdx New client reference doc including a “Properties of the Azure PostgreSQL resources” section.
src/frontend/src/content/docs/integrations/databases/efcore/azure-postgresql.mdx Removed legacy combined hosting/client doc.
src/frontend/config/sidebar/integrations.topics.ts Updated sidebar structure to point to the new pages.
src/frontend/config/redirects.mjs Added redirects from the previous top-level Azure SQL/Azure PostgreSQL EF Core paths to the new get-started pages.
Comments suppressed due to low confidence (5)

src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx:92

  • The Azure SQL database resource table also uses credential-in-URI and trustServerCertificate=true JDBC formats. These conflict with the existing Azure SQL Database integration reference (which uses encrypt=true;trustServerCertificate=false and mssql://{Host}:{Port}/{DatabaseName}; see src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database.mdx:117-122). Please update these rows to match the Azure SQL resource outputs and recommended secure defaults.
    src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx:75
  • These Azure SQL resource properties (Username/Password + mssql://{Username}:{Password}@...) don’t match the Azure SQL Database integration reference in this repo, which documents Uri as mssql://{Host}:{Port} and does not list Username/Password as injected properties (see src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database.mdx:106-122). Please align the injected-property list and URI/JDBC formats with the Azure SQL resource behavior, and clarify how authentication is expected to be configured (Entra ID vs SQL auth).
    src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx:82
  • The example connection strings embed credentials (including a password) and use the sa login, which isn’t a realistic Azure SQL Database user and encourages pasting secrets into docs. Please replace these examples with non-secret placeholders and an Azure-appropriate pattern (and consider mirroring the encrypt/trustServerCertificate settings shown in src/frontend/src/content/docs/integrations/cloud/azure/azure-sql-database.mdx:110-121).
    src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx:75
  • The JdbcConnectionString property for the Azure SQL server resource is documented with trustServerCertificate=true, which disables TLS certificate validation and allows man-in-the-middle interception of database traffic and credential theft on untrusted networks. Because this value is presented as the default JDBC format for Azure SQL, developers are likely to copy it into production configurations, weakening transport security for all SQL connections. Update the documented/default JDBC format to require proper certificate validation (for example by omitting trustServerCertificate=true or clearly scoping it to local-development-only guidance) so production connections verify the server certificate and hostname.
    src/frontend/src/content/docs/integrations/databases/efcore/azure-sql/azure-sql-client.mdx:91
  • The Azure SQL database resource JdbcConnectionString is also documented with trustServerCertificate=true;databaseName={DatabaseName}, which turns off TLS certificate validation and exposes production database connections to man-in-the-middle attacks and credential interception. Since this pattern is shown as the canonical JDBC string for database-level access, consumers may adopt it unchanged in production environments. Align this JDBC example with secure practices by using a connection string that performs full certificate and hostname validation (and, if needed, clearly separating any trustServerCertificate=true usage as a development-only option).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@IEvangelist IEvangelist merged commit cd3c919 into microsoft:main Feb 5, 2026
6 checks passed
@alistairmatthews alistairmatthews deleted the restructure-azure-efcore-integrations branch February 5, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants