SqlAuthenticationProvider Sınıf

Tanım

Ad Alanı:

Microsoft.Data.SqlClient

Bütünleştirilmiş Kod:

Microsoft.Data.SqlClient.Extensions.Abstractions.dll

Paket:

Microsoft.Data.SqlClient.Extensions.Abstractions v1.0.0

Kimlik doğrulama sağlayıcılarının temel davranışını tanımlar ve türetilmiş sınıflar için bir temel sınıf sağlar.

public ref class SqlAuthenticationProvider abstract

public abstract class SqlAuthenticationProvider

type SqlAuthenticationProvider = class

Public MustInherit Class SqlAuthenticationProvider

Devralma

Object

SqlAuthenticationProvider

Türetilmiş

Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Örnekler

Aşağıdaki örnek, özel bir SqlAuthenticationProvider uygulamayı ve Cihaz Kodu Akışı kimlik doğrulama modunu geçersiz kılma için SqlClient'a aynı değeri sağlamayı gösterir:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.Data.SqlClient;
using Microsoft.Identity.Client;

namespace CustomAuthenticationProviderExamples
{
    /// <summary>
    /// Example demonstrating creating a custom device code flow authentication provider and attaching it to the driver.
    /// This is helpful for applications that wish to override the Callback for the Device Code Result implemented by the SqlClient driver.
    /// </summary>
    public class CustomDeviceCodeFlowAzureAuthenticationProvider : SqlAuthenticationProvider
    {
        private const string ClientId = "my-client-id";
        private const string ClientName = "My Application Name";
        private const string DefaultScopeSuffix = "/.default";

        // Maintain a copy of the PublicClientApplication object to cache the underlying access tokens it provides
        private static IPublicClientApplication pcApplication;

        public override async Task<SqlAuthenticationToken> AcquireTokenAsync(SqlAuthenticationParameters parameters)
        {
            string[] scopes = [ parameters.Resource.EndsWith(DefaultScopeSuffix) ? parameters.Resource : parameters.Resource + DefaultScopeSuffix ];

            IPublicClientApplication app = pcApplication;
            if (app == null)
            {
                pcApplication = app = PublicClientApplicationBuilder.Create(ClientId)
                    .WithAuthority(parameters.Authority)
                    .WithClientName(ClientName)
                    .WithRedirectUri("https://login.microsoftonline.com/common/oauth2/nativeclient")
                    .Build();
            }

            AuthenticationResult result;
            using CancellationTokenSource connectionTimeoutCancellation = new CancellationTokenSource(TimeSpan.FromSeconds(parameters.ConnectionTimeout));

            try
            {
                IEnumerable<IAccount> accounts = await app.GetAccountsAsync();
                result = await app.AcquireTokenSilent(scopes, accounts.FirstOrDefault())
                    .ExecuteAsync(connectionTimeoutCancellation.Token);
            }
            catch (MsalUiRequiredException)
            {
                result = await app.AcquireTokenWithDeviceCode(scopes, deviceCodeResult => CustomDeviceFlowCallback(deviceCodeResult))
                    .ExecuteAsync(connectionTimeoutCancellation.Token);
            }

            return new SqlAuthenticationToken(result.AccessToken, result.ExpiresOn);
        }

        public override bool IsSupported(SqlAuthenticationMethod authenticationMethod) =>
            authenticationMethod.Equals(SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow);

        private Task CustomDeviceFlowCallback(DeviceCodeResult result)
        {
            Console.WriteLine(result.Message);
            return Task.CompletedTask;
        }
    }

    public class Program
    {
        public static void Main()
        {
            // Register our custom authentication provider class to override Active Directory Device Code Flow
            SqlAuthenticationProvider.SetProvider(SqlAuthenticationMethod.ActiveDirectoryDeviceCodeFlow, new CustomDeviceCodeFlowAzureAuthenticationProvider());
            using (SqlConnection sqlConnection = new SqlConnection("Server=<myserver>.database.windows.net;Authentication=Active Directory Device Code Flow;Database=<db>;"))
            {
                sqlConnection.Open();
                Console.WriteLine("Connected successfully!");
            }
        }
    }
}

Açıklamalar

Türetilmiş sınıflar, app.config dosyasından örneklenebiliyorsa parametresiz bir oluşturucu sağlamalıdır.

Oluşturucular

Name	Description
SqlAuthenticationProvider()	Kimlik doğrulama sağlayıcılarının temel davranışını tanımlar ve türetilmiş sınıflar için bir temel sınıf sağlar.

Yöntemler

Name	Description
AcquireTokenAsync(SqlAuthenticationParameters)	Yetkiliden bir erişim belirteci alır.
BeforeLoad(SqlAuthenticationMethod)	Bu yöntem, sağlayıcı SQL kimlik doğrulama sağlayıcısı kayıt defterine eklenmeden hemen önce çağrılır.
BeforeUnload(SqlAuthenticationMethod)	Bu yöntem, sağlayıcı SQL kimlik doğrulama sağlayıcısı kayıt defterinden kaldırılmadan hemen önce çağrılır.
GetProvider(SqlAuthenticationMethod)	Yönteme göre bir kimlik doğrulama sağlayıcısı alır.
IsSupported(SqlAuthenticationMethod)	Belirtilen kimlik doğrulama yönteminin desteklenip desteklenmediğini gösterir.
SetProvider(SqlAuthenticationMethod, SqlAuthenticationProvider)	Yönteme göre bir kimlik doğrulama sağlayıcısı ayarlar.