Login Members

  • Article

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

The following tables list the members exposed by the Login type.

Public Constructors

  Name Description
Login Overloaded. Initializes a new instance of the Login class.

Top

Protected Fields

  Name Description
ms219819.protfield(en-US,SQL.90).gif m_ExtendedProperties  (inherited from SqlSmoObject )

Top

Public Properties

(see also Protected Properties )

  Name Description
ms219819.pubproperty(en-US,SQL.90).gif AsymmetricKey Gets the asymmetric key associated with the login.
ms219819.pubproperty(en-US,SQL.90).gif Certificate Gets the certificate associated with the login.
ms219819.pubproperty(en-US,SQL.90).gif CreateDate Gets the date and time when the login account was created.
ms219819.pubproperty(en-US,SQL.90).gif Credential Gets the credential associated with the login.
ms219819.pubproperty(en-US,SQL.90).gif DateLastModified Gets the date and time when the login account was last modified.
ms219819.pubproperty(en-US,SQL.90).gif DefaultDatabase Gets or sets the default database that the login account is assigned to after logging on to the instance of Microsoft SQL Server.
ms219819.pubproperty(en-US,SQL.90).gif DenyWindowsLogin 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 Microsoft SQL Server.
ms219819.pubproperty(en-US,SQL.90).gif Events Gets the events associated with the login account.
ms219819.pubproperty(en-US,SQL.90).gif HasAccess Gets or sets the Boolean property value that specifies whether the Microsoft SQL Server login account has access to the instance of SQL Server.
ms219819.pubproperty(en-US,SQL.90).gif ID Gets the ID value that uniquely identifies the login account.
ms219819.pubproperty(en-US,SQL.90).gif IsDisabled Gets or sets the Boolean property value that specifies whether the Microsoft SQL Server login account is disabled.
ms219819.pubproperty(en-US,SQL.90).gif IsLocked Gets the Boolean property value that specifies whether the login account has been locked out of the instance of Microsoft SQL Server.
ms219819.pubproperty(en-US,SQL.90).gif IsPasswordExpired Gets the Boolean property value that specifies whether the password for the Microsoft SQL Server login account has expired.
ms219819.pubproperty(en-US,SQL.90).gif IsSystemObject Gets or sets the Boolean property value that specifies whether the Microsoft SQL Server login account is a system object.
ms219819.pubproperty(en-US,SQL.90).gif Language Gets or sets the language required by the referenced login account for date formats and system messages.
ms219819.pubproperty(en-US,SQL.90).gif LanguageAlias Gets the alias name used for the language that is required by the Microsoft SQL Server login account.
ms219819.pubproperty(en-US,SQL.90).gif LoginType Gets or sets the type of Microsoft SQL Server login account.
ms219819.pubproperty(en-US,SQL.90).gif MustChangePassword 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 Microsoft SQL Server.
ms219819.pubproperty(en-US,SQL.90).gif Name  Gets or sets the name of the object. (inherited from NamedSmoObject)
ms219819.pubproperty(en-US,SQL.90).gif Parent Gets the Server object that is the parent of the Login object.
ms219819.pubproperty(en-US,SQL.90).gif PasswordExpirationEnabled Gets the Boolean property value that specifies whether the password for the login account will automatically expire.
ms219819.pubproperty(en-US,SQL.90).gif PasswordPolicyEnforced Gets the Boolean property value that specifies whether password policy is enforced for this login account.
ms219819.pubproperty(en-US,SQL.90).gif Properties  Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject)
ms219819.pubproperty(en-US,SQL.90).gif Sid Gets or sets the security identifier (SID) for the login account.
ms219819.pubproperty(en-US,SQL.90).gif State  Gets the state of the referenced object. (inherited from SmoObjectBase)
ms219819.pubproperty(en-US,SQL.90).gif Urn  Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject)
ms219819.pubproperty(en-US,SQL.90).gif UserData  Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase)
ms219819.pubproperty(en-US,SQL.90).gif WindowsLoginAccessType Gets the type of Microsoft Windows logon access.

Top

Protected Properties

  Name Description
ms219819.protproperty(en-US,SQL.90).gif ExecuteForScalar  Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject)
ms219819.protproperty(en-US,SQL.90).gif ObjectInSpace  Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject)
ms219819.protproperty(en-US,SQL.90).gif PresetProperties  Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject)
ms219819.protproperty(en-US,SQL.90).gif ScalarResult  Gets the scalar result for the referenced object. (inherited from SqlSmoObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms219819.pubmethod(en-US,SQL.90).gif AddToRole Adds the login account to a Microsoft SQL Server role.
ms219819.pubmethod(en-US,SQL.90).gif Alter Updates any Login object property changes on the login account on the instance of Microsoft SQL Server.
ms219819.pubmethod(en-US,SQL.90).gif ChangePassword Overloaded. Changes the password for the login account.
ms219819.pubmethod(en-US,SQL.90).gif Create Overloaded.  
ms219819.pubmethod(en-US,SQL.90).gif Deny Overloaded. Denies the specified set of permissions for the specified grantees on the login account.
ms219819.pubmethod(en-US,SQL.90).gif Disable Disables the login account.
ms219819.pubmethod(en-US,SQL.90).gif Drop Removes the login account from the instance of Microsoft SQL Server.
ms219819.pubmethod(en-US,SQL.90).gif Enable Enables the login account.
ms219819.pubmethod(en-US,SQL.90).gif EnumAgentProxyAccounts Enumerates a list of agent proxy accounts in which the login account is participating.
ms219819.pubmethod(en-US,SQL.90).gif EnumDatabaseMappings Enumerates a list of login account mappings to databases and database users.
ms219819.pubmethod(en-US,SQL.90).gif EnumObjectPermissions Overloaded. Enumerates a list of object permissions for the login account.
ms219819.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms219819.pubmethod(en-US,SQL.90).gif GetDatabaseUser Gets the name of the user that the login account is mapped to in a specified database.
ms219819.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms219819.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms219819.pubmethod(en-US,SQL.90).gif Grant Overloaded. Grants the specified set of permissions to the specified grantees on the login account.
ms219819.pubmethod(en-US,SQL.90).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms219819.pubmethod(en-US,SQL.90).gif IsMember Returns a Boolean value that specifies whether the login account is a member of a specified role.
ms219819.pubmethod(en-US,SQL.90).gif ListMembers Returns a list of the roles of which the login account is a member.
ms219819.pubmethod(en-US,SQL.90).gifms219819.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms219819.pubmethod(en-US,SQL.90).gif Refresh  Refreshes the script name. (inherited from ScriptNameObjectBase)
ms219819.pubmethod(en-US,SQL.90).gif Rename Renames the login account.
ms219819.pubmethod(en-US,SQL.90).gif Revoke Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the login account.
ms219819.pubmethod(en-US,SQL.90).gif Script Overloaded. Generates a Transact-SQL script that can be used to re-create the login account.
ms219819.pubmethod(en-US,SQL.90).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)

Top

Protected Methods

  Name Description
ms219819.protmethod(en-US,SQL.90).gif AlterImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif AlterImplFinish  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif AlterImplInit  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif AlterImplWorker  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif AppendCommaText  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif AppendWithCommaText  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif AppendWithOption  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif BindRuleImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CheckCollation  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CheckTextCorectness  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif CheckTextModeSupport  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif CheckVersion80  Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif CheckVersion80SP3  Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif CheckVersion90  Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CleanObject  Cleans the referenced object. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif CreateImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CreateImplFinish  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif CreateImplInit  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif DropImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif DropImplWorker  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms219819.protmethod(en-US,SQL.90).gif ForceTextModeOnTextBody  Enforces text mode on the text body. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetBraketNameForText  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetDBName  Gets the database name associated with the object. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif GetEnumParameter  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetFragOptionString  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetGuidParameter  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetIsTextDirty  Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetPropValue  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetRealValue  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetScriptIncludeExists  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif GetScriptingOptionsForCreate  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetServerName  Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif GetSqlServerVersionName  Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif GetStringParameter  Overloaded. (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetTextBody  Overloaded. Returns the text body. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif GetTextForScript  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif GetTextHeader  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif GetTextMode  Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif GetTextProperty  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif GetTimeSpanParameterAsInt  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif GetUrnRecursive  Overloaded. (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ImplInitialize  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gifms219819.static(en-US,SQL.90).gif IsCollectionDirty  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif IsObjectDirty  Determines whether the referenced object is consistent with the stored object. (inherited from ScriptNameObjectBase)
ms219819.protmethod(en-US,SQL.90).gif IsObjectInitialized  Verifies whether the object has been initialized. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif IsObjectInSpace  Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif IsVersion80SP3  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif MarkDropped  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif MarkForDropImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )
ms219819.protmethod(en-US,SQL.90).gif PostAlter  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif PostCreate  This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif PostDrop  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif RenameImpl  (inherited from NamedSmoObject )
ms219819.protmethod(en-US,SQL.90).gif RenameImplWorker  (inherited from NamedSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptAlter  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptAnsiQI  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif ScriptChangeOwner  (inherited from NamedSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptCreate  This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif ScriptDdl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptDrop  This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject)
ms219819.protmethod(en-US,SQL.90).gif ScriptImpl  Overloaded. (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptImplWorker  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif ScriptInformativeHeaders  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif ScriptRename  This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from NamedSmoObject)
ms219819.protmethod(en-US,SQL.90).gif SetCollectionTextMode  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif SetParentImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif SetTextBody  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif SetTextHeader  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif SetTextMode  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif SwitchTextMode  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gif ThrowIfTextIsDirtyForAlter  (inherited from ScriptNameObjectBase )
ms219819.protmethod(en-US,SQL.90).gifms219819.static(en-US,SQL.90).gif Trace  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif UnbindDefaultImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gif UnbindRuleImpl  (inherited from SqlSmoObject )
ms219819.protmethod(en-US,SQL.90).gifms219819.static(en-US,SQL.90).gif UpdateCollectionState2  (inherited from SqlSmoObject )

Top

See Also

Reference

Login Class
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Managing Users, Roles, and Logins
Principals
CREATE LOGIN (Transact-SQL)