SqlAuthenticationMethod Enum

  • Reference

Definition

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Package:
Microsoft.Data.SqlClient v1.0.19269.1
Package:
Microsoft.Data.SqlClient v1.1.4
Package:
Microsoft.Data.SqlClient v2.0.1
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

Describes the different SQL authentication methods that can be used by a client connecting to Azure SQL Database. For details, see Connecting to SQL Database By Using Azure Active Directory Authentication.

public enum class SqlAuthenticationMethod
public enum SqlAuthenticationMethod
type SqlAuthenticationMethod = 
Public Enum SqlAuthenticationMethod
Inheritance
Enum
SqlAuthenticationMethod

Fields

Name Value Description
NotSpecified 0

The authentication method is not specified.
SqlPassword 1

The authentication method is Sql Password.
ActiveDirectoryPassword 2

The authentication method uses Active Directory Password. Use Active Directory Password to connect to a SQL Database using an Azure AD principal name and password.
ActiveDirectoryIntegrated 3

The authentication method uses Active Directory Integrated. Use Active Directory Integrated to connect to a SQL Database using integrated Windows authentication.
ActiveDirectoryInteractive 4

The authentication method uses Active Directory Interactive. Use Active Directory Interactive to connect to a SQL Database with an interactive authentication flow.
ActiveDirectoryServicePrincipal 5

The authentication method uses Active Directory Service Principal. Use Active Directory Service Principal to connect to a SQL Database using the client ID and secret of a service principal identity.
ActiveDirectoryDeviceCodeFlow 6

The authentication method uses Active Directory Device Code Flow. Use Active Directory Device Code Flow to connect to a SQL Database from devices and operating systems that do not provide a Web browser, using another device to perform interactive authentication.
ActiveDirectoryManagedIdentity 7

The authentication method uses Active Directory Managed Identity. Use System Assigned or User Assigned Managed Identity to connect to SQL Database from Azure client environments that have enabled support for Managed Identity. For User Assigned Managed Identity, 'User Id' or 'UID' is required to be set to the "client ID" of the user identity.
ActiveDirectoryMSI 8

Alias for "Active Directory Managed Identity" authentication method. Use System Assigned or User Assigned Managed Identity to connect to SQL Database from Azure client environments that have enabled support for Managed Identity. For User Assigned Managed Identity, 'User Id' or 'UID' is required to be set to the "client ID" of the user identity.
ActiveDirectoryDefault 9

The authentication method uses Active Directory Default. Use this mode to connect to a SQL Database using multiple non-interactive authentication methods tried sequentially to acquire an access token. This method does not fallback to the "Active Directory Interactive" authentication method.
ActiveDirectoryWorkloadIdentity 10

The authentication method uses Active Directory Workload Identity. Use a federated User Assigned Managed Identity to connect to SQL Database from Azure client environments that have enabled support for Workload Identity. The 'User Id' or 'UID' is required to be set to the "client ID" of the user identity.

Applies to