Add Azure auth sample app by paulmedynski · Pull Request #3988 · dotnet/SqlClient

paulmedynski · 2026-02-26T20:17:24Z

Description

Adds a sample app for testing Azure authentication with flexibility to supply published and local SqlClient packages.

…ork together to provide EntraID authentication functionality.

Copilot

Pull request overview

This PR adds a new sample console application for testing Azure authentication with Microsoft.Data.SqlClient. The app is designed as a smoke test to verify package compatibility and Azure AD authentication functionality, with support for testing against both published NuGet packages and locally-built packages from the packages/ directory.

Changes:

Adds AzureAuthentication sample app in doc/apps/AzureAuthentication/ with flexible package version configuration
Includes comprehensive documentation with usage examples and build instructions
Updates doc/Directory.Packages.props to reference the latest stable SqlClient version (6.1.4)

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`src/Microsoft.Data.SqlClient.sln`	Adds the new AzureAuthentication project to the solution
`doc/apps/AzureAuthentication/AzureAuthentication.csproj`	Project file targeting net481 and net10.0 with conditional Azure package references
`doc/apps/AzureAuthentication/Program.cs`	Main application implementing command-line interface with connection testing and event logging
`doc/apps/AzureAuthentication/README.md`	Comprehensive documentation covering purpose, usage, examples, and prerequisites
`doc/apps/AzureAuthentication/Directory.Build.props`	Enables Central Package Management for the sample app
`doc/apps/AzureAuthentication/Directory.Packages.props`	Defines default package versions with overridable MSBuild properties
`doc/apps/AzureAuthentication/NuGet.config`	Configures local `packages/` directory as a package source
`doc/apps/AzureAuthentication/GeneratePackageVersions.targets`	MSBuild task to generate code exposing package versions at runtime
`doc/apps/AzureAuthentication/packages/.gitkeep`	Ensures git tracks the empty packages directory
`doc/Directory.Packages.props`	Updates SqlClient reference to latest stable version 6.1.4

Copilot · 2026-02-26T20:22:43Z

doc/apps/AzureAuthentication/Program.cs

+            "Supply specific package versions when building to test different versions of the " +
+            "SqlClient suite, for example:" + Environment.NewLine +
+            Environment.NewLine +
+            "  -p:SqlClientVersion=7.0.0.preview4" + Environment.NewLine +


The version format in the example is incorrect. The example shows 7.0.0.preview4 but valid NuGet version formats use a hyphen, not a period, before the pre-release label (e.g., 7.0.0-preview4).

Suggested change

" -p:SqlClientVersion=7.0.0.preview4" + Environment.NewLine +

" -p:SqlClientVersion=7.0.0-preview4" + Environment.NewLine +

Copilot · 2026-02-26T20:22:44Z

doc/apps/AzureAuthentication/packages/.gitkeep

@@ -0,0 +1,2 @@
+# This presence of this file ensures that git creates the packages/ directory, which must exist


Grammatical error: "This presence of this file" should be "The presence of this file".

Suggested change

# This presence of this file ensures that git creates the packages/ directory, which must exist

# The presence of this file ensures that git creates the packages/ directory, which must exist

doc/apps/AzureAuthentication/AzureAuthentication.csproj

doc/apps/AzureAuthentication/README.md

Copilot · 2026-02-26T20:22:45Z

doc/apps/AzureAuthentication/README.md

+
+  Supply specific package versions when building to test different versions of the SqlClient suite, for example:
+
+    -p:SqlClientVersion=7.0.0.preview4


The version format in the example is incorrect. The example shows 7.0.0.preview4 but valid NuGet version formats use a hyphen, not a period, before the pre-release label (e.g., 7.0.0-preview4). The same issue appears on lines 72 and 145.

Suggested change

-p:SqlClientVersion=7.0.0.preview4

-p:SqlClientVersion=7.0.0-preview4

doc/apps/AzureAuthentication/README.md

paulmedynski · 2026-02-26T20:34:26Z

doc/apps/AzureAuthentication/AzureAuthentication.csproj

+    <PackageReference Include="System.CommandLine" />
+  </ItemGroup>
+
+  <!-- Generate code with the SqlClient package versions. -->


Is there any reason not to make the package version strings that are already embedded in our assemblies available as a public API? It would be nice to just access them as:

Microsoft.Data.SqlClient.VersionInfo.PackageVersion Microsoft.Data.SqlClient.Extensions.Logging.VersionInfo.PackageVersion ...

Thoughts? We would have to make sure each package contains an assembly with a sensible namespace. Avoiding type ambiguity due to using declarations would be an issue though.

paulmedynski · 2026-02-26T20:35:51Z

doc/apps/AzureAuthentication/GeneratePackageVersions.targets

@@ -0,0 +1,111 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">


This is a bunch of Copilot foo that appears to work. I'm not sure if it actually regenerates on every build though.

@paulmedynski Can this be simplified and guaranteed to always generate the C# file?

paulmedynski · 2026-02-26T22:39:53Z

doc/apps/AzureAuthentication/AzureAuthentication.csproj

There didn't seem to be a suitable existing location for things like this other than tools/, which seems a bit cluttered and unfocused. We can discuss where to put this app.

codecov · 2026-02-27T02:40:24Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.05%. Comparing base (a68e00f) to head (66bbe3e).
⚠️ Report is 20 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (a68e00f) and HEAD (66bbe3e). Click for more details.

HEAD has 6 uploads less than BASE

Flag BASE (a68e00f) HEAD (66bbe3e)

netfx 2 0

netcore 2 0

addons 2 0

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3988      +/-   ##
==========================================
- Coverage   75.22%   67.05%   -8.17%     
==========================================
  Files         266      282      +16     
  Lines       42932    67049   +24117     
==========================================
+ Hits        32294    44963   +12669     
- Misses      10638    22086   +11448

Flag	Coverage Δ
PR-SqlClient-Project	`67.05% <ø> (?)`
addons	`?`
netcore	`?`
netfx	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

priyankatiwari08 · 2026-02-27T08:47:02Z

doc/apps/AzureAuthentication/Program.cs

+        }
+
+        // Instantiate the AKV Provider to ensure its assembly is present.
+        #pragma warning disable CA1806


Nit: The only purpose of this instantiation is to force-load the AKV assembly and catch dependency conflicts. Creating a full SqlColumnEncryptionAzureKeyVaultProvider with a DefaultAzureCredential is heavier than needed — it allocates a credential object that's never used and requires suppressing CA1806.

A lighter alternative that makes the intent more explicit:

// Force-load the AKV provider assembly to detect transitive dependency conflicts.
_ = typeof(SqlColumnEncryptionAzureKeyVaultProvider).Assembly;

No warning suppression needed, no credential created, and the comment explains why.

paulmedynski added 4 commits February 26, 2026 11:05

Created sample app to demonstrate how all of the SqlClient packages w…

91c7b8d

…ork together to provide EntraID authentication functionality.

Added the AzureAuthentication sample app to the main solution.

ac29841

Added tracing and logging support.

064bccc

Added .NET Framework support.

66bbe3e

paulmedynski added this to the 7.0.0 milestone Feb 26, 2026

Copilot AI review requested due to automatic review settings February 26, 2026 20:17

paulmedynski requested a review from a team as a code owner February 26, 2026 20:17

paulmedynski added Area\Tests Issues that are targeted to tests or test projects Area\Documentation Use this for issues that requires changes in public documentations/samples. labels Feb 26, 2026

Copilot started reviewing on behalf of paulmedynski February 26, 2026 20:17 View session

Copilot AI reviewed Feb 26, 2026

View reviewed changes

paulmedynski commented Feb 26, 2026

View reviewed changes

priyankatiwari08 self-assigned this Feb 27, 2026

priyankatiwari08 reviewed Feb 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Azure auth sample app#3988

Add Azure auth sample app#3988
paulmedynski wants to merge 4 commits intomainfrom
dev/paul/azure-samples

paulmedynski commented Feb 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Uh oh!

paulmedynski Feb 26, 2026

Uh oh!

paulmedynski Feb 26, 2026

Uh oh!

paulmedynski Feb 26, 2026

Uh oh!

codecov bot commented Feb 27, 2026

Uh oh!

priyankatiwari08 Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	" -p:SqlClientVersion=7.0.0.preview4" + Environment.NewLine +
	" -p:SqlClientVersion=7.0.0-preview4" + Environment.NewLine +

		@@ -0,0 +1,2 @@
		# This presence of this file ensures that git creates the packages/ directory, which must exist

	# This presence of this file ensures that git creates the packages/ directory, which must exist
	# The presence of this file ensures that git creates the packages/ directory, which must exist


		Supply specific package versions when building to test different versions of the SqlClient suite, for example:

		-p:SqlClientVersion=7.0.0.preview4

	-p:SqlClientVersion=7.0.0.preview4
	-p:SqlClientVersion=7.0.0-preview4

		@@ -0,0 +1,111 @@
		<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

Conversation

paulmedynski commented Feb 26, 2026

Description

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paulmedynski Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

paulmedynski Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 27, 2026

Codecov Report

Uh oh!

priyankatiwari08 Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants