Skip to content

Improve WAM authentication diagnostics for windowless hosts - #4858

Merged
mdaigle merged 4 commits into
dotnet:mainfrom
priyankatiwari08:priyankatiwari08-dev/automation/wam-windowless-diagnostic
Oct 26, 2026
Merged

mdaigle merged 4 commits into
dotnet:mainfrom
priyankatiwari08:priyankatiwari08-dev/automation/wam-windowless-diagnostic

Conversation

@priyankatiwari08

@priyankatiwari08 priyankatiwari08 commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Description

Provide actionable SqlClient guidance when Windows WAM interactive authentication fails with window_handle_required: supply an application-owned parent window, use Active Directory Default with a configured non-interactive credential, or supply a custom application ID with WAM disabled.

Preserve the original MSAL error code and inner exception. Keep first-party WAM enforcement, silent acquisition, unrelated failures, and non-Windows behavior unchanged. No public API changes. Update XML documentation, the Azure package README, and the custom application ID sample; follow existing Azure extension exception-message conventions.

Suggested release note: Improve WAM missing-parent-window authentication errors with actionable guidance for windowless hosts.

Issues

Fixes #4854.

Testing

Added isolated exception-translation regression tests and conditional Azure SQL integration coverage for both Open and OpenAsync with a zero window handle. Before the fix, the six new exception-translation cases had two expected failures and four passes.

  • dotnet test src\Microsoft.Data.SqlClient.Extensions\Azure\test\Azure.Test.csproj --framework net10.0 -p:UseArtifactsOutput=true --no-restore --filter "FullyQualifiedName~WamBrokerErrorTests|FullyQualifiedName~WamBrokerTests|FullyQualifiedName~AuthorityParsingTests|FullyQualifiedName~WindowlessInteractiveConnectionTests" --verbosity quiet — passed 44, skipped 1 conditional integration theory, failed 0.
  • dotnet test src\Microsoft.Data.SqlClient.Extensions\Azure\test\Azure.Test.csproj --framework net462 -p:UseArtifactsOutput=true --no-restore --filter "FullyQualifiedName~WamBrokerErrorTests|FullyQualifiedName~WamBrokerTests|FullyQualifiedName~AuthorityParsingTests|FullyQualifiedName~WindowlessInteractiveConnectionTests" --verbosity quiet — passed 44, skipped 1 conditional integration theory, failed 0.
  • & .\eng\pipelines\onebranch\scripts\validate-xml-docs.ps1 -SnippetsDirectory .\src\Microsoft.Data.SqlClient.Extensions\Azure\doc -DocumentationPath .\artifacts\Microsoft.Data.SqlClient.Extensions.Azure\Debug — passed.
  • git --no-pager diff --check — passed before commit.

UseArtifactsOutput avoids missing intermediate DLL outputs with the default layout in this long Windows worktree path. Filter discovery was verified on both frameworks. Live Azure SQL integration/customer Functions reproduction was not run because no Azure SQL test connection is configured. Linux/macOS runtime behavior and the standalone sample were not executed.

  • Tests added or updated
  • Public API changes documented (no API changes; behavior clarified)
  • Verified against customer repro (requires configured Azure SQL/Functions environment)
  • Ensure no breaking changes introduced (authentication selection preserved)

Guidelines

Please review the contribution guidelines before submitting a pull request:

Preserve broker requirements while explaining supported authentication alternatives for windowless hosts. Add exception translation regression tests, sync/async integration coverage, and documentation.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ec369fd4-31ce-48fd-94fe-dc893a47a803
Copilot AI balanced review requested due to automatic review settings October 19, 2026 16:13
@priyankatiwari08
priyankatiwari08 requested a review from a team as a code owner October 19, 2026 16:13
@github-project-automation github-project-automation Bot moved this to To triage in SqlClient Board Oct 19, 2026
@priyankatiwari08 priyankatiwari08 added this to the 8.0.0-preview1 milestone Oct 19, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The integration test needs shared MSAL cache isolation to prevent order-dependent failures and interference with other authentication tests.

1 open issue
What changed in this PR

Improves SqlClient’s Windows WAM missing-window diagnostics for windowless hosts without changing authentication selection or public APIs.

Changes:

  • Adds actionable guidance while preserving the MSAL error code and inner exception.
  • Adds exception-translation tests and conditional synchronous/asynchronous connection tests.
  • Documents supported alternatives and updates the custom application ID sample.
File Description
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​test/​WindowlessInteractiveConnectionTests.cs Tests diagnostics through Open and OpenAsync.
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​test/​WamBrokerErrorTests.cs Tests error translation and unchanged failures.
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​src/​PackageReadme.md Explains windowless authentication alternatives.
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​src/​ActiveDirectoryAuthenticationProvider.cs Adds targeted WAM error guidance.
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​doc/​ActiveDirectoryAuthenticationProviderOptions.xml Clarifies WAM configuration requirements.
src/​Microsoft.Data.SqlClient.Extensions/​Azure/​doc/​ActiveDirectoryAuthenticationProvider.xml Documents parent-window alternatives.
doc/​samples/​ApplicationClientIdAzureAuthenticationProvider.cs Demonstrates disabling WAM with a custom application ID.

Review effort: Balanced

Clear the cached public client applications before and after the windowless test so its zero-window callback is neither bypassed by an earlier cached client nor leaked into later interactive tests. Serialize ActiveDirectoryInteractiveTests with the other provider-mutating tests.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: ec369fd4-31ce-48fd-94fe-dc893a47a803
Copilot AI balanced review requested due to automatic review settings October 19, 2026 16:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Live Windows WAM/Azure SQL integration remains unverified, requiring human validation before approval.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@codecov

codecov Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.03%. Comparing base (7c55ed0) to head (dee0758).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4858      +/-   ##
==========================================
- Coverage   67.62%   66.03%   -1.59%     
==========================================
  Files         295      304       +9     
  Lines       45545    68685   +23140     
==========================================
+ Hits        30798    45359   +14561     
- Misses      14747    23326    +8579     
Flag Coverage Δ
CI-SqlClient ?
PR-SqlClient-Project 66.03% <ø> (?)

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

☔ View full report in Codecov by Harness.
📢 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.

- Revert sample to the constructor available in the referenced Extensions.Azure package.
- Add SqlAuthenticationProviderCollection.Name and use it in Azure tests.
- Make s_pcaMap internal and remove reflection from WamBrokerErrorTests.
- Add localization TODO (dotnet#4904) and a note on the Windows-only filter.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: ec369fd4-31ce-48fd-94fe-dc893a47a803
Copilot AI balanced review requested due to automatic review settings October 22, 2026 13:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔵 Needs a closer look

The live Windows WAM/Azure SQL scenario remains unvalidated and needs human confirmation before approval.

No open issues 🎉

Review effort: Balanced

@mdaigle mdaigle added Hotfix 7.0.5 PRs targeting main that should be backported to release/7.0 for 7.0.5 Hotfix 6.1.8 Hotfix 7.1.3 PRs targeting main that should be backported to release/7.1 for 7.1.3. labels Oct 22, 2026
Copilot AI balanced review requested due to automatic review settings October 23, 2026 18:05
This was referenced Nov 3, 2026
felipemarcianodev added a commit to felipemarcianodev/rastro-ai that referenced this pull request Nov 15, 2026
Updated [Microsoft.Data.SqlClient](https://github.com/dotnet/sqlclient)
from 6.1.1 to 6.1.8.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Data.SqlClient's
releases](https://github.com/dotnet/sqlclient/releases)._

## 6.1.8

This update brings the following changes since the
[6.1.7](https://github.com/dotnet/SqlClient/releases/tag/v6.1.7)
release:

### Changed

- Updated the `System.Security.Cryptography.Pkcs` dependency to 8.0.2
(was 8.0.1) for .NET Framework 4.6.2, .NET 8.0, and .NET Standard 2.0,
and updated the `Microsoft.Extensions.Caching.Memory`,
`System.Configuration.ConfigurationManager`, and
`System.Security.Cryptography.Pkcs` dependencies to 9.0.21 (was 9.0.11)
for .NET 9.0.
([#​4842](dotnet/SqlClient#4842),
[#​4862](dotnet/SqlClient#4862),
[#​4870](dotnet/SqlClient#4870))

- Improved the error reported when `Active Directory Interactive`
authentication through the Windows Web Account Manager (WAM) broker
fails because the host has no parent window, such as a service or Azure
Functions host. The resulting error now explains the supported
alternatives: supply a parent window with
`SetParentActivityOrWindowFunc`, use `Active Directory Default` with a
configured non-interactive credential, or supply a custom
`ApplicationClientId` with `UseWamBroker` disabled. The original MSAL
error code and inner exception are preserved, and authentication
selection, retry behavior, and other failures are unchanged. (Windows
only)
([#​4854](dotnet/SqlClient#4854),
[#​4858](dotnet/SqlClient#4858),
[#​4918](dotnet/SqlClient#4918))

### Fixed

- Fixed the managed SNI path ignoring `HostNameInCertificate` during
server certificate validation. When `HostNameInCertificate` is set, it
is now the only host name the server certificate is validated against,
and certificates that do not match it are rejected. Default host-name
selection when the property is not set, certificate chain validation,
`ServerCertificate` matching, and the connection destination are
unchanged. (net8.0/net9.0 only)
([#​4905](dotnet/SqlClient#4905),
[#​4909](dotnet/SqlClient#4909))

- Fixed Always Encrypted enclave session caching so that cached enclave
sessions are isolated by attestation protocol. A session established
with one `Attestation Protocol` setting is no longer reused by a
connection to the same server, database, and attestation URL that uses a
different protocol.
([#​4829](dotnet/SqlClient#4829),
[#​4868](dotnet/SqlClient#4868))

- Fixed `SqlDataReader.HasRows` returning `false` when a result set
contains rows but the server sends multiple informational messages, or
an informational message before an `ORDER` token, ahead of the first
row. Empty results still report `false`, and `InfoMessage` delivery is
unchanged.
([#​3018](dotnet/SqlClient#3018),
[#​4773](dotnet/SqlClient#4773),
[#​4898](dotnet/SqlClient#4898))

- Fixed an intermittent `InvalidOperationException` ("Nullable object
must have a value") from statistics bookkeeping when commands complete
concurrently on a MARS connection. This issue was reported as a
regression starting with 6.1.4.
([#​4778](dotnet/SqlClient#4778),
[#​4875](dotnet/SqlClient#4875),
[#​4896](dotnet/SqlClient#4896))

- Fixed Entra ID authentication when the server supplies an authority
URL with an OAuth endpoint suffix, such as
`https://login.microsoftonline.com/<tenant>/oauth2/authorize` returned
by the Dataverse/Dynamics 365 TDS endpoint. The provider now extracts
the tenant from the first path segment and uses the normalized authority
for Azure.Identity credentials, MSAL, and their cache keys. An authority
URL that cannot be parsed now fails with a clear, localized
`ArgumentException` naming the authority. Bare tenant authority URLs
used by Azure SQL and Fabric retain their existing behavior.
([#​4496](dotnet/SqlClient#4496),
[#​4521](dotnet/SqlClient#4521),
[#​4791](dotnet/SqlClient#4791),
[#​4807](dotnet/SqlClient#4807))

## Target Platform Support

- .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64)
- .NET 8.0+ (Windows x86, Windows x64, Windows ARM64, Linux, macOS)
- .NET Standard 2.0+ (Windows x86, Windows x64, Windows ARM64, Linux,
macOS)

Full details:
[release-notes/6.1/6.1.8.md](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.8.md)

## 6.1.7

This update brings the following changes since the [6.1.6](6.1.6.md)
release:

### Changed

- Updated the `Microsoft.Data.SqlClient.SNI` and
`Microsoft.Data.SqlClient.SNI.runtime` dependencies to 6.0.3 (was
6.0.2).
  ([#​4598](dotnet/SqlClient#4598))

### Fixed

- Fixed `ServerCertificate` validation on the managed SNI path so the
configured certificate is compared against the server certificate even
when the server certificate passes chain and host-name validation. When
certificate validation is enabled, a missing, unreadable, or invalid
certificate file, a certificate mismatch, or a missing server
certificate now causes the TLS handshake to fail instead of bypassing
the configured certificate check. (net8.0/net9.0 only)
([#​4445](dotnet/SqlClient#4445),
[#​4584](dotnet/SqlClient#4584))

- Fixed Always Encrypted VSM/HGS enclave attestation to verify that the
enclave public key used to establish a session matches the key committed
to by the signed attestation report. Missing, malformed, or mismatched
key-binding data now causes attestation to fail before the session
secret is derived.
([#​4532](dotnet/SqlClient#4532),
[#​4552](dotnet/SqlClient#4552))

- Fixed `SqlConnection.AccessTokenCallback` not disabling Transparent
Network IP Resolution by default, making it consistent with
`SqlConnection.AccessToken`. An explicitly configured
`TransparentNetworkIPResolution` connection-string value still takes
precedence. (net462 only)
([#​4520](dotnet/SqlClient#4520),
[#​4560](dotnet/SqlClient#4560))

- Fixed token authentication state handling so clearing
`SqlConnection.AccessToken` preserves an existing `AccessTokenCallback`
in the connection pool key, and clearing `AccessTokenCallback` preserves
an existing `AccessToken`. Callback-based authentication now also
follows the same prelogin server-certificate validation rules as an
explicitly supplied access token.
([#​4520](dotnet/SqlClient#4520),
[#​4560](dotnet/SqlClient#4560))

- Fixed configurable retry logic installing a permanent, process-wide
assembly-resolution handler that could interfere with unrelated assembly
loading. The handler is now active only while an explicitly configured
custom retry provider is resolved and constructed, and probes
`AppContext.BaseDirectory` instead of the current working directory.
Place custom retry assemblies in the application base directory;
dependencies loaded after provider construction must be resolvable
through normal application dependency resolution or an
application-provided handler. (net8.0/net9.0 only)
([#​2214](dotnet/SqlClient#2214),
[#​4547](dotnet/SqlClient#4547),
[#​4664](dotnet/SqlClient#4664))

## Target Platform Support

- .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64)
- .NET 8.0+ (Windows x86, Windows x64, Windows ARM64, Linux, macOS)
- .NET Standard 2.0+ (Windows x86, Windows x64, Windows ARM64, Linux,
macOS)

Full details:
[release-notes/6.1/6.1.7.md](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.7.md)

## 6.1.6

This update brings the following changes since the
[6.1.5](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.5.md)
release:

### Added

#### WAM broker support for the supported Entra ID authentication modes
(Windows only)

*What Changed:*

- Added support for the [Web Account Manager
(WAM)](https://learn.microsoft.com/entra/msal/dotnet/acquiring-tokens/desktop-mobile/wam)
broker for the supported Microsoft Entra ID authentication modes. A new
`ActiveDirectoryAuthenticationProviderOptions` options bag and a
corresponding
`ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions
options)` constructor were introduced, exposing a `UseWamBroker`
property (alongside `ApplicationClientId` and `DeviceCodeFlowCallback`).
([#​4288](dotnet/SqlClient#4288),
[#​4387](dotnet/SqlClient#4387))
- Added a cross-platform `SetParentActivityOrWindowFunc(Func<object>
parentActivityOrWindowFunc)` method so callers can supply a parent
window handle on Windows or a parent `Activity`/`UIViewController` on
Android/iOS/MAUI.

*Who Benefits:*

- Applications using `ActiveDirectoryInteractive` and other supported
Entra ID authentication modes on Windows benefit from the WAM broker's
improved security (tokens are brokered by the OS), single sign-on with
the logged-in Windows account, and support for Conditional Access and
Windows Hello.

*Impact:*

- When you supply your `ApplicationClientId`, WAM is opt-in via
`ActiveDirectoryAuthenticationProviderOptions.UseWamBroker`. Consider
enabling it when you want OS-brokered tokens, single sign-on with the
signed-in Windows account, Windows Hello, and Conditional Access
support.
- `UseWamBroker` is a **Windows-only** setting and has no effect on
non-Windows platforms, where interactive Entra ID flows always use the
system browser.
- Prefer the new options-bag constructor over the positional-argument
overloads in new code.

```c#
var options = new ActiveDirectoryAuthenticationProviderOptions
{
    ApplicationClientId = "<your-app-client-id>",
    // Enable WAM (Windows only) for OS-brokered tokens, SSO, Windows Hello, and Conditional Access.
    UseWamBroker = true,
};
var provider = new ActiveDirectoryAuthenticationProvider(options);
// Supply the parent window/activity that owns the interactive sign-in prompt.
provider.SetParentActivityOrWindowFunc(() => parentWindowHandle);
SqlAuthenticationProvider.SetProvider(SqlAuthenticationMethod.ActiveDirectoryInteractive, provider);
```


### Changed

#### Hardened TDS token parsing with data-length bounds checks

*What Changed:*

- Added bounds checking when parsing TDS token data lengths. The parser
now validates the declared length of incoming token data against the
available buffer before reading, rejecting malformed or out-of-range
length values instead of reading past the intended boundary.
([#​4340](dotnet/SqlClient#4340),
[#​4359](dotnet/SqlClient#4359))

*Who Benefits:*

- All consumers benefit from improved resilience against malformed or
hostile TDS responses. A server (or man-in-the-middle) sending an
invalid token length can no longer drive the parser to read beyond the
declared payload.

*Impact:*
 ... (truncated)

## 6.1.5

This update brings the following changes since the
[6.1.4](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.4.md)
release:

### Fixed

- Fixed a connection performance regression where SPN (Service Principal
Name) generation was triggered for non-integrated authentication modes
(e.g., SQL authentication) on the native SNI path, causing unnecessary
DNS lookups and significantly slower connection times. Only affects .NET
on Windows (not .NET Framework).
([#​3523](dotnet/SqlClient#3523),
[#​3946](dotnet/SqlClient#3946))
- Fixed `ExecuteScalar` to properly propagate errors when the server
sends data followed by an error token. Previously, errors such as
conversion failures during `WHERE` clause evaluation were silently
consumed during `SqlDataReader.Close()` instead of being thrown to the
caller, which could result in transactions being unexpectedly zombied.
([#​3736](dotnet/SqlClient#3736),
[#​3947](dotnet/SqlClient#3947))
- Fixed `SqlDataReader.GetFieldType` and
`SqlDataReader.GetProviderSpecificFieldType` to return the correct type
(`SqlVector<float>`) for vector float32 columns. Previously, these
methods did not follow the same type-resolution logic as `GetValue`,
returning an incorrect type for vector columns.
([#​4104](dotnet/SqlClient#4104),
[#​4151](dotnet/SqlClient#4151))

## Target Platform Support

- .NET Framework 4.6.2+ (Windows x86, Windows x64, Windows ARM64)
- .NET 8.0+ (Windows x86, Windows x64, Windows ARM64, Linux, macOS)
- .NET Standard 2.0+ (Windows x86, Windows x64, Windows ARM64, Linux,
macOS)

### Dependencies

#### .NET Framework 4.6.2

- Azure.Core 1.50.0
- Azure.Identity 1.17.1
- Microsoft.Data.SqlClient.SNI 6.0.2
- Microsoft.Extensions.Caching.Memory 8.0.1
- Microsoft.Identity.Client 4.80.0
- Microsoft.IdentityModel.JsonWebTokens 7.7.1
- Microsoft.IdentityModel.Protocols.OpenIdConnect 7.7.1
- System.Buffers 4.6.1
- System.Data.Common 4.3.0
- System.Diagnostics.DiagnosticSource 8.0.1
- System.IdentityModel.Tokens.Jwt 7.7.1
- System.Memory 4.6.3
- System.Security.Cryptography.Pkcs 8.0.1
- System.Text.Json 8.0.6
- System.Text.RegularExpressions 4.3.1

#### .NET 8.0

- Azure.Core 1.50.0
- Azure.Identity 1.17.1
- Microsoft.Data.SqlClient.SNI.runtime 6.0.2
- Microsoft.Extensions.Caching.Memory 8.0.1
- Microsoft.Identity.Client 4.80.0
- Microsoft.IdentityModel.JsonWebTokens 7.7.1
- Microsoft.IdentityModel.Protocols.OpenIdConnect 7.7.1
- Microsoft.SqlServer.Server 1.0.0
- System.Configuration.ConfigurationManager 8.0.1
- System.Diagnostics.DiagnosticSource 8.0.1
- System.IdentityModel.Tokens.Jwt 7.7.1
- System.Security.Cryptography.Pkcs 8.0.1

#### .NET 9.0
 ... (truncated)

## 6.1.4

This update brings the following changes since the
[6.1.3](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.3.md)
release:

### Fixed

- Fixed NullReferenceException issue with `SqlDataAdapter` when
processing batch scenarios where certain SQL RPC calls may not include
system parameters.
  ([#​3877](dotnet/SqlClient#3877))
- Fixed connection pooling issue where extra connection deactivation was
causing active connection counts to go negative.
  ([#​3776](dotnet/SqlClient#3776))

### Added

#### AppContext Switch for enabling MultiSubnetFailover

*What Changed:*

- Added new AppContext switch
`Switch.Microsoft.Data.SqlClient.EnableMultiSubnetFailoverByDefault` to
set `MultiSubnetFailover=true` by default in connection string.
  ([#​3851](dotnet/SqlClient#3851))

*Who Benefits:*

- Applications that need MultiSubnetFailover enabled globally without
modifying connection strings.

*Impact:*

- Applications can now enable MultiSubnetFailover globally using one of
the following methods:

```c#
// In application code
AppContext.SetSwitch("Switch.Microsoft.Data.SqlClient.EnableMultiSubnetFailoverByDefault", true);
```

```json
// In runtimeconfig.json
{
  "configProperties": {
    "Switch.Microsoft.Data.SqlClient.EnableMultiSubnetFailoverByDefault": true
  }
}
```

```xml
<!-- In App.Config -->
<runtime>
  <AppContextSwitchOverrides value="Switch.Microsoft.Data.SqlClient.EnableMultiSubnetFailoverByDefault=true" />
</runtime>
```

### Changed

- Optimized `SqlStatistics` execution timing by using
`Environment.TickCount` instead of more expensive timing mechanisms.
 ... (truncated)

## 6.1.3

This update includes the following changes since the
[6.1.2](https://github.com/dotnet/SqlClient/blob/main/release-notes/6.1/6.1.2.md)
release:

### Added

#### App Context Switch for Ignoring Server-Provided Failover Partner

*What Changed:*

- A new app context switch
`Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner`
was introduced to let the client ignore server-provided failover partner
info in Basic Availability Groups (BAGs). When the switch is enabled,
only the failover partner specified in the connection string is used;
server-supplied partner values are skipped. This context switch was
introduced in PR
[#​3702](dotnet/SqlClient#3702).

*Who Benefits:*

- Applications connecting to SQL Server BAGs using TCP and custom ports,
especially where the server's provided partner name lacks the protocol,
host, or port. This avoids connection failures when the server-provided
partner is incompatible or incomplete.
- Teams who manage availability groups and rely on client-side control
of failover behavior in heterogeneous networking environments.

*Impact:*

- If your environment might be affected (i.e., you operate a BAG with
custom ports, or have experienced failures after failover), you can
enable the new switch in your application:

```c#
AppContext.SetSwitch("Switch.Microsoft.Data.SqlClient.IgnoreServerProvidedFailoverPartner", true);
```

- Then, ensure your connection string includes your preferred failover
partner (with correct `tcp:host,port`) so that the client uses that
instead of the server's suggestion.
- Without enabling this, by default, the client continues to prefer the
server-provided partner, maintaining backwards compatibility.

### Fixed

- Fixed an issue to ensure reliable metrics initialization during
startup, preventing missed telemetry when EventSource is enabled early.
([#​3718](dotnet/SqlClient#3718))

## Target Platform Support

- .NET Framework 4.6.2+ (Windows ARM64, Windows x86, Windows x64)
- .NET 8.0+ (Windows x86, Windows x64, Windows ARM64, Windows ARM,
Linux, macOS)

### Dependencies

#### .NET Framework 4.6.2+

- Azure.Core 1.47.1
- Azure.Identity 1.14.2
- Microsoft.Bcl.Cryptography 8.0.0
- Microsoft.Data.SqlClient.SNI 6.0.2
- Microsoft.Extensions.Caching.Memory 8.0.1
- Microsoft.IdentityModel.JsonWebTokens 7.7.1
- Microsoft.IdentityModel.Protocols.OpenIdConnect 7.7.1
- System.Buffers 4.5.1
- System.Data.Common 4.3.0
- System.Security.Cryptography.Pkcs 8.0.1
- System.Text.Encodings.Web 8.0.0
 ... (truncated)

## 6.1.2

This update brings the below changes over the previous stable release:

### Fixed

- Fixed an issue where initializing PerformanceCounters would throw
`System.InvalidOperationException`
[#​3629](dotnet/SqlClient#3629)
- Fixed an issue where a Custom SqlClientAuthenticationProvider was
being overwritten by default implementation.
[#​3651](dotnet/SqlClient#3651)
- Fixed a concurrency issue in connection pooling where the number of
active connections could be lower than the configured maximum pool size.
[#​3653](dotnet/SqlClient#3653)

Commits viewable in [compare
view](dotnet/SqlClient@v6.1.1...v6.1.8).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Microsoft.Data.SqlClient&package-manager=nuget&previous-version=6.1.1&new-version=6.1.8)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Felipe Santos Marciano <67729798+felipemarcianodev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Hotfix 7.0.5 PRs targeting main that should be backported to release/7.0 for 7.0.5 Hotfix 7.1.3 PRs targeting main that should be backported to release/7.1 for 7.1.3.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

WAM broker integration breaks windowless uses

7 participants