ActiveDirectoryAuthenticationProvider 构造函数

定义

命名空间:

Microsoft.Data.SqlClient

程序集:

Microsoft.Data.SqlClient.Extensions.Azure.dll

程序包:

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

重载

名称	说明
ActiveDirectoryAuthenticationProvider()	初始化 ActiveDirectoryAuthenticationProvider 类。
ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions)	ActiveDirectoryAuthenticationProvider从ActiveDirectoryAuthenticationProviderOptions包初始化类。 这是新代码的推荐构造函数，因为可以添加新 ActiveDirectoryAuthenticationProviderOptions 选项，而无需对调用方强制进行重大更改。
ActiveDirectoryAuthenticationProvider(String)	ActiveDirectoryAuthenticationProvider使用提供的应用程序客户端 ID 初始化类。
ActiveDirectoryAuthenticationProvider(Func<DeviceCodeResult,Task>, String)	ActiveDirectoryAuthenticationProvider使用提供的设备代码流回调方法和应用程序客户端 ID 初始化类。

ActiveDirectoryAuthenticationProvider()

初始化 ActiveDirectoryAuthenticationProvider 类。

public:
 ActiveDirectoryAuthenticationProvider();

public ActiveDirectoryAuthenticationProvider();

Public Sub New ()

注解

新代码应首选 ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions) 重载，以避免在引入新选项时添加更多构造函数重载。

ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions)

ActiveDirectoryAuthenticationProvider从ActiveDirectoryAuthenticationProviderOptions包初始化类。 这是新代码的推荐构造函数，因为可以添加新 ActiveDirectoryAuthenticationProviderOptions 选项，而无需对调用方强制进行重大更改。

public:
 ActiveDirectoryAuthenticationProvider(Microsoft::Data::SqlClient::ActiveDirectoryAuthenticationProviderOptions ^ options);

public ActiveDirectoryAuthenticationProvider(Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProviderOptions options);

new Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider : Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProviderOptions -> Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Public Sub New (options As ActiveDirectoryAuthenticationProviderOptions)

参数

options

ActiveDirectoryAuthenticationProviderOptions

一个 ActiveDirectoryAuthenticationProviderOptions 实例，其属性初始化提供程序。 不得为 null。

例外

ArgumentNullException

当 为 options时null引发。

ActiveDirectoryAuthenticationProvider(String)

ActiveDirectoryAuthenticationProvider使用提供的应用程序客户端 ID 初始化类。

public:
 ActiveDirectoryAuthenticationProvider(System::String ^ applicationClientId);

public ActiveDirectoryAuthenticationProvider(string applicationClientId);

new Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider : string -> Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Public Sub New (applicationClientId As String)

参数

applicationClientId

String

用于获取联合身份验证访问令牌的客户端应用程序 ID。 默认情况下，驱动程序使用自己的应用程序客户端 ID。

示例

以下示例演示如何为 SqlClient 提供用户定义的应用程序客户端 ID，以实现“Active Directory交互式”身份验证方法：

using System;
using Microsoft.Data.SqlClient;

namespace CustomAuthenticationProviderExamples
{
  public class Program
  {
    public static void Main()
    {
      // Supported for all authentication modes supported by ActiveDirectoryAuthenticationProvider
      ActiveDirectoryAuthenticationProvider provider = new ActiveDirectoryAuthenticationProvider("<application_client_id>");
      if (provider.IsSupported(SqlAuthenticationMethod.ActiveDirectoryInteractive))
      {
        SqlAuthenticationProvider.SetProvider(SqlAuthenticationMethod.ActiveDirectoryInteractive, provider);
      }

      using (SqlConnection sqlConnection = new SqlConnection("Server=<myserver>.database.windows.net;Authentication=Active Directory Interactive;Database=>db<;"))
      {
        sqlConnection.Open();
        Console.WriteLine("Connected successfully!");
      }
    }
  }
}

注解

新代码应首选 ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions) 重载，以避免在引入新选项时添加更多构造函数重载。

ActiveDirectoryAuthenticationProvider(Func<DeviceCodeResult,Task>, String)

ActiveDirectoryAuthenticationProvider使用提供的设备代码流回调方法和应用程序客户端 ID 初始化类。

public ActiveDirectoryAuthenticationProvider(Func<Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task> deviceCodeFlowCallbackMethod, string? applicationClientId = default);

new Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider : Func<Microsoft.Identity.Client.DeviceCodeResult, System.Threading.Tasks.Task> * string -> Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Public Sub New (deviceCodeFlowCallbackMethod As Func(Of DeviceCodeResult, Task), Optional applicationClientId As String = Nothing)

参数

deviceCodeFlowCallbackMethod

Func<DeviceCodeResult,Task>

要用于“Active Directory设备代码流”身份验证的回调方法。

applicationClientId

String

（可选）用于获取联合身份验证访问令牌的客户端应用程序 ID。 默认情况下，驱动程序使用自己的应用程序客户端 ID。

注解

新代码应首选 ActiveDirectoryAuthenticationProvider(ActiveDirectoryAuthenticationProviderOptions) 重载，以避免在引入新选项时添加更多构造函数重载。