ActiveDirectoryAuthenticationProviderOptions Class

Definition

Namespace:: Microsoft.Data.SqlClient

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

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

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

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.

Property bag used by the ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions) constructor.

public ref class ActiveDirectoryAuthenticationProviderOptions sealed

public sealed class ActiveDirectoryAuthenticationProviderOptions

type ActiveDirectoryAuthenticationProviderOptions = class

Public NotInheritable Class ActiveDirectoryAuthenticationProviderOptions

Inheritance: Object
ActiveDirectoryAuthenticationProviderOptions

Remarks

Prefer this options-bag constructor over the positional-argument overloads in new code. Additional options can be added here in future versions without introducing new constructor overloads.

UseWamBroker is a Windows-only setting: it has no effect on non-Windows platforms, where interactive Entra ID flows always use the system browser.

Constructors

Name	Description
ActiveDirectoryAuthenticationProviderOptions()

Properties

Name	Description
ApplicationClientId	Optional Entra ID application (client) id. When `null`, the SqlClient first-party application id is used and WAM broker mode is forced on (regardless of UseWamBroker) when running on Windows.
DeviceCodeFlowCallback	Optional device-code-flow callback invoked for `SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow`. When `null`, the provider's default callback (which writes the device-code instructions to the console) is used.
UseWamBroker	Windows-only setting to control whether the provider uses the WAM broker for interactive authentication. Defaults to `false` when you provide a custom ApplicationClientId. Otherwise, WAM broker mode is used automatically on Windows.

Applies to