Login Class
TOC
Collapse the table of content
Expand the table of content

Login Class

 

The Login object represents a SQL Server login account that has been granted access to the instance of SQL Server through Windows Authentication or SQL Server Authentication.

Namespace:   Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)


[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Login : ScriptNameObjectBase, ISfcSupportsDesignMode, 
	IObjectPermission, ICreatable, IAlterable, IDroppable, IDropIfExists, 
	IRenamable, IScriptable, ILoginOptions, IDmfFacet

NameDescription
System_CAPS_pubmethodLogin()

Initializes a new instance of the Login class.

System_CAPS_pubmethodLogin(Server, String)

Initializes a new instance of the Login class on the specified instance of SQL Server and with the specified name.

NameDescription
System_CAPS_pubpropertyAsymmetricKey

Gets the asymmetric key associated with the login.

System_CAPS_pubpropertyCertificate

Gets the certificate associated with the login.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the login account was created.

System_CAPS_pubpropertyCredential

Gets the credential associated with the login.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the login account was last modified.

System_CAPS_pubpropertyDefaultDatabase

Gets or sets the default database that the login account is assigned to after logging on to the instance of SQL Server.

System_CAPS_pubpropertyDenyWindowsLogin

Gets or sets the Boolean property value that specifies whether the login account has been granted or denied the ability to log on to the instance of SQL Server.

System_CAPS_pubpropertyEvents

Gets the events associated with the login account.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyHasAccess

Gets or sets the Boolean property value that specifies whether the SQL Server login account has access to the instance of SQL Server.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the login account.

System_CAPS_pubpropertyIsDisabled

Gets or sets the Boolean property value that specifies whether the SQL Server login account is disabled.

System_CAPS_pubpropertyIsLocked

Gets the Boolean property value that specifies whether the login account has been locked out of the instance of SQL Server.

System_CAPS_pubpropertyIsPasswordExpired

Gets the Boolean property value that specifies whether the password for the SQL Server login account has expired.

System_CAPS_pubpropertyIsSystemObject

Gets or sets the Boolean property value that specifies whether the SQL Server login account is a system object.

System_CAPS_pubpropertyLanguage

Gets or sets the language required by the referenced login account for date formats and system messages.

System_CAPS_pubpropertyLanguageAlias

Gets the alias name used for the language that is required by the SQL Server login account.

System_CAPS_pubpropertyLoginType

Gets or sets the type of SQL Server login account.

System_CAPS_pubpropertyMustChangePassword

Gets the Boolean property value that specifies whether the login account password must be changed when the user next logs on to the instance of SQL Server.

System_CAPS_pubpropertyName

Gets or sets the name of the login.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyParent

Gets the Server object that is the parent of the Login object.

System_CAPS_pubpropertyPasswordExpirationEnabled

Gets the Boolean property value that specifies whether the password for the login account will automatically expire.

System_CAPS_pubpropertyPasswordHashAlgorithm

Gets or sets the hash algorithm used for the password.

System_CAPS_pubpropertyPasswordPolicyEnforced

Gets the Boolean property value that specifies whether password policy is enforced for this login account.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySid

Gets or sets the security identifier (SID) for the login account.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyWindowsLoginAccessType

Gets the type of Windows logon access.

NameDescription
System_CAPS_pubmethodAddCredential(String)

Adds a login credential.

System_CAPS_pubmethodAddToRole(String)

Adds the login account to a SQL Server role.

System_CAPS_pubmethodAlter()

Updates any Login object property changes on the login account on the instance of SQL Server.

System_CAPS_pubmethodChangePassword(SecureString)

System_CAPS_pubmethodChangePassword(SecureString, Boolean, Boolean)

System_CAPS_pubmethodChangePassword(SecureString, SecureString)

System_CAPS_pubmethodChangePassword(String)

Changes the password for the login account.

System_CAPS_pubmethodChangePassword(String, Boolean, Boolean)

Changes the password for the login account.

System_CAPS_pubmethodChangePassword(String, String)

Changes the password for the login account.

System_CAPS_pubmethodCreate()

Creates a login account on the instance of SQL Server as defined by the Login object.

System_CAPS_pubmethodCreate(SecureString)

Creates a login account on the instance of SQL Server as defined by the Login object.

System_CAPS_pubmethodCreate(SecureString, LoginCreateOptions)

Creates a login account on the instance of SQL Server as defined by the Login object.

System_CAPS_pubmethodCreate(String)

Creates a login account on the instance of SQL Server as defined by the Login object.

System_CAPS_pubmethodCreate(String, LoginCreateOptions)

Creates a login account on the instance of SQL Server as defined by the Login object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the login account.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String, Boolean)

Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the logon.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the logon.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[], Boolean)

Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the logon.

System_CAPS_pubmethodDisable()

Disables the login account.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the login account from the instance of SQL Server.

System_CAPS_pubmethodDropCredential(String)

Drops a login credential.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnable()

Enables the login account.

System_CAPS_pubmethodEnumAgentProxyAccounts()

Enumerates a list of agent proxy accounts in which the login account is participating.

System_CAPS_pubmethodEnumCredentials()

Returns a string collection of credentials associated with a login.

System_CAPS_pubmethodEnumDatabaseMappings()

Enumerates a list of login account mappings to databases and database users.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the login account.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the login account.

System_CAPS_pubmethodEnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the login account.

System_CAPS_pubmethodEnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the login account.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetDatabaseUser(String)

Gets the name of the user that the login account is mapped to in a specified database.

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the login account.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String, Boolean)

Grants access to the specified permission to the grantee and the ability to grant access to other users on the login account.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String, Boolean, String)

Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the login account under an assumed role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the login account.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the login account.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean, String)

Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the logon under an assumed role.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsMember(String)

Returns a Boolean value that specifies whether the login account is a member of a specified role.

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodListMembers()

Returns a list of the roles of which the login account is a member.

System_CAPS_pubmethodRefresh()

Refreshes the login credentials.(Overrides ScriptNameObjectBase.Refresh().)

System_CAPS_pubmethodRename(String)

Renames the login account.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the login account.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String, Boolean, Boolean)

Revokes previously granted permissions from a grantee on the login account and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)

Revokes previously granted permissions from a grantee on the login account and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a list of grantees on the login account.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)

Revokes previously granted permissions from grantees on the login account and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)

Revokes previously granted permissions from grantees on the login account and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the login account.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the login account as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

To get Login object properties, users can be a member of the public fixed server role.

To set Login object properties, users must have ALTER ANY LOGIN permissions on the server or be a member of the sysadmin fixed server role.

To create or drop a login, users must have ALTER ANY LOGIN permissions on the server or be a member of the sysadmin fixed server role.

To grant, deny, or revoke permission on the login to other users, users must have CONTROL permissions on the logon or be a member of the sysadmin or securityadmin fixed server roles.

To set the password on a login without providing an old password, users must be a member of the sysadmin fixed server role.

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft