• Article

Login Members

Include Protected Members
Include Inherited Members

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.

The Login type exposes the following members.

Constructors

  Name Description
Public method Login() Initializes a new instance of the Login class.
Public method Login(Server, String) Initializes a new instance of the Login class on the specified instance of SQL Server and with the specified name.

Top

Methods

  Name Description
Public method AddCredential(String) Adds a login credential.
Protected method AddDatabaseContext(StringCollection) (Inherited from SqlSmoObject.)
Public method AddToRole(String) Adds the login account to a SQL Server role.
Public method Alter() Updates any Login object property changes on the login account on the instance of SQL Server.
Protected method AlterImpl() (Inherited from SqlSmoObject.)
Protected method AlterImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method AlterImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Protected method AlterImplWorker() (Inherited from SqlSmoObject.)
Protected method AppendCommaText(StringBuilder, String, Boolean%, String) (Inherited from ScriptNameObjectBase.)
Protected method AppendWithCommaText(StringBuilder, String, Boolean%) (Inherited from ScriptNameObjectBase.)
Protected method AppendWithOption(StringBuilder, String, String, Boolean%) (Inherited from ScriptNameObjectBase.)
Protected method BindDefaultImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method BindRuleImpl(String, String, Boolean) (Inherited from SqlSmoObject.)
Public method ChangePassword(String) Changes the password for the login account.
Public method ChangePassword(String, String) Changes the password for the login account.
Public method ChangePassword(String, Boolean, Boolean) Changes the password for the login account.
Protected method CheckCollation(String, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CheckObjectDirty() (Inherited from ScriptNameObjectBase.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(Boolean) Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected method CheckObjectStateImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method CheckTextCorectness(String, Boolean, Boolean, array<String[], DdlTextParserHeaderInfo%) (Inherited from ScriptNameObjectBase.)
Protected method CheckTextModeSupport() (Inherited from ScriptNameObjectBase.)
Protected method CheckVersion100() (Inherited from SqlSmoObject.)
Protected method CheckVersion80() Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3() Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90() Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90() (Inherited from SqlSmoObject.)
Protected method CleanObject() Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
Public method Create() Creates a login account on the instance of SQL Server as defined by the Login object.
Public method Create(SecureString) Creates a login account on the instance of Microsoft SQL Server as defined by the Login object
Public method Create(String) Creates a login account on the instance of Microsoft SQL Server as defined by the Login object
Public method Create(SecureString, LoginCreateOptions) Creates a login account on the instance of Microsoft SQL Server as defined by the Login object
Public method Create(String, LoginCreateOptions) Creates a login account on the instance of Microsoft SQL Server as defined by the Login object
Protected method CreateImpl() (Inherited from SqlSmoObject.)
Protected method CreateImplFinish(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method CreateImplInit(StringCollection%, ScriptingOptions%) (Inherited from SqlSmoObject.)
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the login account.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the logon.
Public method Deny(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.
Public method Deny(ObjectPermissionSet, array<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.
Public method Disable() Disables the login account.
Public method Discover() (Inherited from SqlSmoObject.)
Public method Drop() Removes the login account from the instance of SQL Server.
Public method DropCredential(String) Drops a login credential.
Protected method DropImpl() (Inherited from SqlSmoObject.)
Protected method DropImplWorker(Urn%) (Inherited from SqlSmoObject.)
Public method Enable() Enables the login account.
Public method EnumAgentProxyAccounts() Enumerates a list of agent proxy accounts in which the login account is participating.
Public method EnumCredentials() Returns a String Collection of credentials associated with a login.
Public method EnumDatabaseMappings() Enumerates a list of login account mappings to databases and database users.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the login account.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the login account.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the login account.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the login account.
Protected method EnumScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method ForceTextModeOnTextBody() Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected method FormatSqlVariant(Object) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean) (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript(StringBuilder, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript(ScriptingOptions, String, String, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetBraketNameForText() (Inherited from ScriptNameObjectBase.)
Public method GetDatabaseUser(String) Gets the name of the user that the login account is mapped to in a specified database.
Protected method GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetDBName() Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected method GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%) (Inherited from SqlSmoObject.)
Protected method GetFragOptionString(FragmentationOption) (Inherited from SqlSmoObject.)
Protected method GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetHashCode() (Inherited from Object.)
Protected method GetIsTextDirty() Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetPropValue(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional(String) (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull(String) (Inherited from SqlSmoObject.)
Protected method GetRealValue(Property, Object) (Inherited from SqlSmoObject.)
Protected method GetScriptIncludeExists(ScriptingOptions, String, Boolean) (Inherited from ScriptNameObjectBase.)
Protected method GetScriptingOptionsForCreate() (Inherited from SqlSmoObject.)
Protected method GetServerName() Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject() (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName() Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) (Inherited from SqlSmoObject.)
Protected method GetTextBody() Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextBody(Boolean) Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[]) Gets the text for scripting. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) (Inherited from ScriptNameObjectBase.)
Protected method GetTextHeader(Boolean) Returns the text header. (Inherited from ScriptNameObjectBase.)
Protected method GetTextMode() Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String) (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String, ScriptingOptions) (Inherited from ScriptNameObjectBase.)
Protected method GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%) (Inherited from SqlSmoObject.)
Public method GetType() (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) (Inherited from SqlSmoObject.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the login account.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the login account.
Public method Grant(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.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants access to the specified permission to the grantees and the ability to grant access to other users on the login account.
Public method Grant(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.
Public method Grant(ObjectPermissionSet, array<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.
Protected method ImplInitialize(array<String[], array<OrderBy[]) (Inherited from SqlSmoObject.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method IsMember(String) Returns a Boolean value that specifies whether the login account is a member of a specified role.
Protected method IsObjectDirty() Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
Protected method IsObjectInitialized() Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace() Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsVersion80SP3() (Inherited from SqlSmoObject.)
Public method ListMembers() Returns a list of the roles of which the login account is a member.
Protected method MarkDropped() (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method PostAlter() (Inherited from SqlSmoObject.)
Protected method PostCreate() (Inherited from SqlSmoObject.)
Protected method PostDrop() (Inherited from SqlSmoObject.)
Public method Refresh() Refreshes the login credentials. (Overrides ScriptNameObjectBase.Refresh().)
Public method Rename(String) Renames the login account.
Protected method RenameImpl(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker(String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the login account.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the login account.
Public method Revoke(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.
Public method Revoke(ObjectPermissionSet, array<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.
Public method Revoke(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.
Public method Revoke(ObjectPermissionSet, array<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.
Public method Script() Generates a Transact-SQL script that can be used to re-create the login account.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the login account as specified by the script options.
Protected method ScriptAlter(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptAnsiQI(SqlSmoObject, ScriptingOptions, StringCollection, StringBuilder, Object%, Object%) (Inherited from ScriptNameObjectBase.)
Protected method ScriptChangeOwner(StringCollection, ScriptingOptions) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDdl(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptDrop(StringCollection, ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImpl() (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker(ScriptingOptions) (Inherited from SqlSmoObject.)
Protected method ScriptInformativeHeaders(ScriptingOptions, StringBuilder) (Inherited from ScriptNameObjectBase.)
Protected method ScriptRename(StringCollection, ScriptingOptions, String) This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetCollectionTextMode(Boolean, SmoCollectionBase) Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl(SqlSmoObject) (Inherited from SqlSmoObject.)
Protected method SetTextBody(String) Specifies the text body. (Inherited from ScriptNameObjectBase.)
Protected method SetTextHeader(String) Specifies the text header. (Inherited from ScriptNameObjectBase.)
Protected method SetTextMode(Boolean, array<SmoCollectionBase[]) Specifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected method SwitchTextMode(Boolean, array<SmoCollectionBase[]) Switches the text mode. (Inherited from ScriptNameObjectBase.)
Protected method ThrowIfTextIsDirtyForAlter() (Inherited from ScriptNameObjectBase.)
Public method ToString() Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl() (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl(Boolean) (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl(Boolean) (Inherited from SqlSmoObject.)
Public method Validate(String, array<Object[]) (Inherited from SmoObjectBase.)

Top

Fields

  Name Description
Protected field m_ExtendedProperties (Inherited from SqlSmoObject.)

Top

Properties

  Name Description
Public property AsymmetricKey Gets the asymmetric key associated with the login.
Public property Certificate Gets the certificate associated with the login.
Public property CreateDate Gets the date and time when the login account was created.
Public property Credential Gets the credential associated with the login.
Public property DateLastModified Gets the date and time when the login account was last modified.
Public property DefaultDatabase Gets or sets the default database that the login account is assigned to after logging on to the instance of SQL Server.
Public property 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 SQL Server.
Public property Events Gets the events associated with the login account.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property HasAccess Gets or sets the Boolean property value that specifies whether the SQL Server login account has access to the instance of SQL Server.
Public property ID Gets the ID value that uniquely identifies the login account.
Public property IsDisabled Gets or sets the Boolean property value that specifies whether the SQL Server login account is disabled.
Public property IsLocked Gets the Boolean property value that specifies whether the login account has been locked out of the instance of SQL Server.
Public property IsPasswordExpired Gets the Boolean property value that specifies whether the password for the SQL Server login account has expired.
Public property IsSystemObject Gets or sets the Boolean property value that specifies whether the SQL Server login account is a system object.
Protected property IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public property Language Gets or sets the language required by the referenced login account for date formats and system messages.
Public property LanguageAlias Gets the alias name used for the language that is required by the SQL Server login account.
Public property LoginType Gets or sets the type of SQL Server login account.
Public property 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 SQL Server.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Protected property ObjectInSpace Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public property Parent Gets the Server object that is the parent of the Login object.
Public property PasswordExpirationEnabled Gets the Boolean property value that specifies whether the password for the login account will automatically expire.
Public property PasswordPolicyEnforced Gets the Boolean property value that specifies whether password policy is enforced for this login account.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property Sid Gets or sets the security identifier (SID) for the login account.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property WindowsLoginAccessType Gets the type of Windows logon access.

Top

Events

  Name Description
Public event PropertyChanged (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObjectDiscover() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetParent() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetProperty(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProviderGetPropertySet() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectGetUrn() (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectResolve(String) (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObjectSetProperty(Object, Object) (Inherited from SqlSmoObject.)

Top