Class AzureSqlDataProviderConfiguration

Namespace

combit.Reporting.DataProviders

Assembly

combit.ListLabel31.CrossPlatform.SqlConnectionDataProvider.dll

Provides the configuration data for connecting to Azure SQL databases.

public class AzureSqlDataProviderConfiguration

Inheritance

object

AzureSqlDataProviderConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The AzureSqlDataProviderConfiguration class encapsulates all connection parameters needed to connect to Microsoft Azure SQL Database. It supports two authentication methods: Azure Active Directory Integrated authentication (for domain-joined machines) and Azure AD username/password authentication. The class automatically generates a properly formatted Azure SQL connection string with security best practices, including encryption enabled by default. You can also override the generated connection string with a custom one using the ConnectionStringOverride property.

Constructors

AzureSqlDataProviderConfiguration(string, string, AzureSqlDataProviderAuthenticationType)

Constructs an instance of the AzureSqlDataProviderConfiguration

public AzureSqlDataProviderConfiguration(string server, string database, AzureSqlDataProviderAuthenticationType authenticationType)

Parameters

server string

The server name, e. g. contoso.database.windows.net

database string

The database name, e. g. Northwind

authenticationType AzureSqlDataProviderAuthenticationType

The authentication type, see AzureSqlDataProviderAuthenticationType

Properties

AuthenticationType

The authentication type, see AzureSqlDataProviderAuthenticationType

public AzureSqlDataProviderAuthenticationType AuthenticationType { get; set; }

Property Value

AzureSqlDataProviderAuthenticationType

ConnectionStringOverride

Enables to override the automatically generated connection string with a custom one

public string ConnectionStringOverride { get; set; }

Property Value

string

Database

The database name, e. g. Northwind

public string Database { get; set; }

Property Value

string

Encrypt

Enable encryption

public bool Encrypt { get; set; }

Property Value

bool

MultipleActiveResultSets

Enable multiple active result sets (MARS)

public bool MultipleActiveResultSets { get; set; }

Property Value

bool

Password

The password if AuthenticationType is set to AzureADIdentity

public string Password { get; set; }

Property Value

string

Port

The port of the database, default is 1433

public int Port { get; set; }

Property Value

int

Server

The server name, e. g. contoso.database.windows.net

public string Server { get; set; }

Property Value

string

TrustServerCertificate

Trust the server's certificate

public bool TrustServerCertificate { get; set; }

Property Value

bool

UserName

The user name if AuthenticationType is set to AzureADIdentity

public string UserName { get; set; }

Property Value

string