Table of Contents

Class SqlLogin

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a SQL login.

public class SqlLogin : BaseTypeSection, IComparable<SqlLogin>
Inheritance
SqlLogin
Implements

Constructors

SqlLogin()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.SqlLogin class.

public SqlLogin()

Properties

AsymmetricKey

Gets or sets the asymmetric key associated with the login. This only applies to on-premises installations of SQL Server.

public string AsymmetricKey { get; set; }

Property Value

string

Certificate

Gets or sets the certificate associated with the login. This only applies to on-premises installations of SQL Server.

public string Certificate { get; set; }

Property Value

string

Credentials

Gets or sets the credentials to which the login is mapped. This only applies to on-premises installations of SQL Server.

public SerializableStringCollection Credentials { get; set; }

Property Value

SerializableStringCollection

DateCreated

Gets or sets the date that the login was created.

public DateTime DateCreated { get; set; }

Property Value

DateTime

DateLastModified

Gets or sets the date and time the login was last modified.

public DateTime DateLastModified { get; set; }

Property Value

DateTime

DefaultDatabase

Gets or sets the name of the default database.

public string DefaultDatabase { get; set; }

Property Value

string

GrantConnectPermission

Gets or sets whether the login has permission to connect to the database engine. This only applies to on-premises installations of SQL Server.

public BooleanOption GrantConnectPermission { get; set; }

Property Value

BooleanOption

Id

Gets or sets the identifier of the login.

public int Id { get; set; }

Property Value

int

IsDisabled

Gets or sets whether the login is disabled.

public BooleanOption IsDisabled { get; set; }

Property Value

BooleanOption

IsLocked

Gets or sets whether the login is locked. This only applies to SQL logins on on-premises installations of SQL Server.

public BooleanOption IsLocked { get; set; }

Property Value

BooleanOption

IsPasswordExpired

Gets or sets whether the password for the login has expired. This only applies to SQL logins on on-premises installations of SQL Server.

public BooleanOption IsPasswordExpired { get; set; }

Property Value

BooleanOption

Language

Gets or sets the default language for the login - for example "us_english".

public string Language { get; set; }

Property Value

string

LanguageDisplayName

Gets or sets the display name of the default language for the login - for example "English".

public string LanguageDisplayName { get; set; }

Property Value

string

LoginType

Gets or sets the login type.

public SqlLoginType LoginType { get; set; }

Property Value

SqlLoginType

LoginTypeString

Gets the login type as a human readable string.

public string LoginTypeString { get; set; }

Property Value

string

MustChangePassword

Gets or sets whether the user must change their password. This only applies to SQL logins on on-premises installations of SQL Server.

public BooleanOption MustChangePassword { get; set; }

Property Value

BooleanOption

Name

Gets or sets the name of the login.

public string Name { get; set; }

Property Value

string

PasswordExpirationEnabled

Gets or sets whether password expiration is enabled for the login. This only applies to SQL logins.

public BooleanOption PasswordExpirationEnabled { get; set; }

Property Value

BooleanOption

PasswordPolicyEnforced

Gets or sets whether password policy enforcement is enabled for the login. This only applies to SQL logins.

public BooleanOption PasswordPolicyEnforced { get; set; }

Property Value

BooleanOption

ServerRoles

Gets or sets the server roles assigned to the login. This only applies to on-premises installations of SQL Server.

public SerializableStringCollection ServerRoles { get; set; }

Property Value

SerializableStringCollection

Sid

Gets or sets the security identifier of the Windows account in SDDL format. This only applies to Windows user or Windows group logins.

public string Sid { get; set; }

Property Value

string

Methods

Clone()

Returns a CENTREL.XIA.Configuration.Types.SqlLogin cloned from this object.

public SqlLogin Clone()

Returns

SqlLogin

A CENTREL.XIA.Configuration.Types.SqlLogin.

CompareTo(SqlLogin)

Compares two CENTREL.XIA.Configuration.Types.SqlLogin objects to allow sorting alphabetically by name.

public int CompareTo(SqlLogin other)

Parameters

other SqlLogin

The CENTREL.XIA.Configuration.Types.SqlLogin to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.SqlLogin objects.