ActiveDirectoryAuthenticationProvider Class

Definition

Namespace:: Microsoft.Data.SqlClient

Assembly:: Microsoft.Data.SqlClient.dll

Assembly:: Microsoft.Data.SqlClient.Extensions.Azure.dll

Package:: Microsoft.Data.SqlClient v2.1.4

Package:: Microsoft.Data.SqlClient v3.0.1

Package:: Microsoft.Data.SqlClient v3.1.0

Package:: Microsoft.Data.SqlClient v4.0.1

Package:: Microsoft.Data.SqlClient v4.1.0

Package:: Microsoft.Data.SqlClient v5.0.0

Package:: Microsoft.Data.SqlClient v5.1.0

Package:: Microsoft.Data.SqlClient v5.2.0

Package:: Microsoft.Data.SqlClient v6.0.2

Package:: Microsoft.Data.SqlClient v6.1.3

Package:: Microsoft.Data.SqlClient.Extensions.Azure v7.0.3

Package:: Microsoft.Data.SqlClient.Extensions.Azure v7.1.0

Source:: ActiveDirectoryAuthenticationProvider.cs

Source:: ActiveDirectoryAuthenticationProvider.cs

Source:: ActiveDirectoryAuthenticationProvider.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class implements SqlAuthenticationProvider and is used for active directory federated authentication mechanisms.

public ref class ActiveDirectoryAuthenticationProvider sealed : Microsoft::Data::SqlClient::SqlAuthenticationProvider

public sealed class ActiveDirectoryAuthenticationProvider : Microsoft.Data.SqlClient.SqlAuthenticationProvider

type ActiveDirectoryAuthenticationProvider = class
    inherit SqlAuthenticationProvider

Public NotInheritable Class ActiveDirectoryAuthenticationProvider
Inherits SqlAuthenticationProvider

Inheritance: Object

SqlAuthenticationProvider
ActiveDirectoryAuthenticationProvider

Remarks

Responsibilities of this part:

Resolve the parent window handle handed to MSAL's WAM broker (and to the embedded WebView on .NET Framework) via WithParentActivityOrWindow.
Honor the caller-supplied SetParentActivityOrWindowFunc callback when present, and fall back to the process console window (resolved via Win32 interop) otherwise.

Constructors

Name	Description
ActiveDirectoryAuthenticationProvider()	Initializes the ActiveDirectoryAuthenticationProvider class.
ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions)	Initializes the ActiveDirectoryAuthenticationProvider class from a ActiveDirectoryAuthenticationProviderOptions bag. This is the recommended constructor for new code because new options can be added to `ActiveDirectoryAuthenticationProviderOptions` without forcing breaking changes on callers.
ActiveDirectoryAuthenticationProvider(Func<DeviceCodeResult,Task>, String)	Initializes the ActiveDirectoryAuthenticationProvider class with the provided device code flow callback method and application client id.
ActiveDirectoryAuthenticationProvider(String)	Initializes the ActiveDirectoryAuthenticationProvider class with the provided application client id.

Methods

Name	Description
AcquireTokenAsync(SqlAuthenticationParameters)	Acquires a security token from the authority.
BeforeLoad(SqlAuthenticationMethod)	This method is called immediately before the provider is added to authentication provider registry.
BeforeUnload(SqlAuthenticationMethod)	This method is called immediately before the provider is removed from the authentication provider registry.
ClearUserTokenCache()	Clears cached user tokens from the token provider.
IsSupported(SqlAuthenticationMethod)	Indicates whether the specified authentication method is supported.
SetAcquireAuthorizationCodeAsyncCallback(Func<Uri,Uri,CancellationToken,Task<Uri>>)	Sets a callback method which is invoked with a custom Web UI instance that will let the user sign-in with Entra ID, present consent if needed, and get back the authorization code. Applicable when working with Active Directory Interactive authentication.
SetDeviceCodeFlowCallback(Func<DeviceCodeResult,Task>)	Sets the callback method, overriding the default implementation that processes the result for 'Active Directory Device Code Flow' authentication.
SetIWin32WindowFunc(Func<IWin32Window>)	Sets a reference to the current IWin32Window that triggers the browser to be shown. Used to center the browser pop-up onto this window.
SetParentActivityOrWindowFunc(Func<Object>)	Sets a function to return the parent window handle to be used for WAM (Windows Account Manager) broker authentication prompts.

Applies to