SqlAuthenticationProvider Třída

Definice

Obor názvů:

Microsoft.Data.SqlClient

Sestavení:

Microsoft.Data.SqlClient.Extensions.Abstractions.dll

Balíček:

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

Definuje základní chování zprostředkovatelů ověřování a poskytuje základní třídu pro odvozené třídy.

public ref class SqlAuthenticationProvider abstract

public abstract class SqlAuthenticationProvider

type SqlAuthenticationProvider = class

Public MustInherit Class SqlAuthenticationProvider

Dědičnost

Object

SqlAuthenticationProvider

Odvozené

Microsoft.Data.SqlClient.ActiveDirectoryAuthenticationProvider

Příklady

Následující příklad ukazuje implementaci vlastního SqlAuthenticationProvider a poskytnutí stejné sqlClient pro přepsání režimu ověřování toku kódu zařízení:

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!");
            }
        }
    }
}

Poznámky

Odvozené třídy musí poskytovat konstruktor bez parametrů, pokud lze vytvořit instanci ze souboru app.config.

Konstruktory

Name	Description
SqlAuthenticationProvider()	Definuje základní chování zprostředkovatelů ověřování a poskytuje základní třídu pro odvozené třídy.

Metody

Name	Description
AcquireTokenAsync(SqlAuthenticationParameters)	Získá přístupový token od autority.
BeforeLoad(SqlAuthenticationMethod)	Tato metoda se volá bezprostředně před přidáním zprostředkovatele do registru zprostředkovatele ověřování SQL.
BeforeUnload(SqlAuthenticationMethod)	Tato metoda se volá bezprostředně před odebráním poskytovatele z registru zprostředkovatele ověřování SQL.
GetProvider(SqlAuthenticationMethod)	Získá zprostředkovatele ověřování metodou.
IsSupported(SqlAuthenticationMethod)	Určuje, jestli je zadaná metoda ověřování podporovaná.
SetProvider(SqlAuthenticationMethod, SqlAuthenticationProvider)	Nastaví zprostředkovatele ověřování podle metody.