Login Class

Definition

This class represents a SqlServer login

[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacet]
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone)]
public sealed class Login : Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDropIfExists, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.IDmfFacet, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcSupportsDesignMode, Microsoft.SqlServer.Management.Smo.ILoginOptions, Microsoft.SqlServer.Management.Smo.IObjectPermission, Microsoft.SqlServer.Management.Smo.IScriptable
type Login = class
    inherit ScriptNameObjectBase
    interface ISfcSupportsDesignMode
    interface IObjectPermission
    interface ICreatable
    interface IAlterable
    interface IDroppable
    interface IDropIfExists
    interface IRenamable
    interface IScriptable
    interface ILoginOptions
    interface IDmfFacet
type Login = class
    inherit ScriptNameObjectBase
    interface ICreatable
    interface IAlterable
    interface IDroppable
    interface IDropIfExists
    interface IRenamable
    interface IScriptable
    interface ILoginOptions
    interface IDmfFacet
    interface ISfcSupportsDesignMode
    interface IObjectPermission
Public NotInheritable Class Login
Inherits ScriptNameObjectBase
Implements IAlterable, ICreatable, IDmfFacet, IDropIfExists, IDroppable, ILoginOptions, IObjectPermission, IRenamable, IScriptable, ISfcSupportsDesignMode
Inheritance
Attributes
EvaluationModeAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute
Implements

Constructors

Login()
Login(Server, String)

Fields

m_ExtendedProperties (Inherited from SqlSmoObject)
singletonParent

Regular SMO objects access the parent class reference through parentColl (corresponding collection in parent class). Singleton class has no collection in parent.

(Inherited from SqlSmoObject)

Properties

AsymmetricKey
Certificate
CreateDate
Credential
DatabaseEngineEdition

Returns the DatabaseEngineEdition of the SMO object

(Inherited from SqlSmoObject)
DatabaseEngineType

Returns the DatabaseEngineType of the SMO object

(Inherited from SqlSmoObject)
DateLastModified
DefaultDatabase
DenyWindowsLogin
Events
ExecuteForScalar (Inherited from SqlSmoObject)
ExecutionManager (Inherited from SqlSmoObject)
HasAccess
ID
IsDisabled
IsLocked
IsPasswordExpired
IsSystemObject
IsTouched

Whether the object has been touched for unconditional scripting of Alter

(Inherited from SqlSmoObject)
Language
LanguageAlias
LoginType
MustChangePassword
Name
ObjectInSpace (Inherited from SqlSmoObject)
Parent
ParentCollection

Returns the collection that contains the object. May be null.

(Inherited from SqlSmoObject)
PasswordExpirationEnabled
PasswordHashAlgorithm
PasswordPolicyEnforced
Properties (Inherited from SqlSmoObject)
ScalarResult (Inherited from SqlSmoObject)
ServerVersion

Returns the ServerVersion of the Server that contains the object. If the object is not associated with a connected Server, the highest known server version is returned.

(Inherited from SqlSmoObject)
Sid
State

Returns the state of the object

(Inherited from SmoObjectBase)
Urn

Returns the Urn of the object, computed on the fly

(Inherited from SqlSmoObject)
UrnSuffix

returns the name of the type in the urn expression

UserData (Inherited from SmoObjectBase)
WindowsLoginAccessType

Methods

AddCredential(String)

Adds a credential to the login

AddDatabaseContext(StringCollection)

method get called from the create script related method (from derived classes like Table, Index etc..)

(Inherited from SqlSmoObject)
AddToRole(String)

Add the login to the specified role.

Alter()
AlterImpl() (Inherited from SqlSmoObject)
AlterImplWorker() (Inherited from SqlSmoObject)
AppendCommaText(StringBuilder, String, Boolean, String) (Inherited from ScriptNameObjectBase)
AppendWithCommaText(StringBuilder, String, Boolean) (Inherited from ScriptNameObjectBase)
AppendWithOption(StringBuilder, String, String, Boolean) (Inherited from ScriptNameObjectBase)
AutoGenerateName() (Inherited from ScriptNameObjectBase)
BindDefaultImpl(String, String, Boolean) (Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) (Inherited from SqlSmoObject)
ChangePassword(SecureString)

Changes login password using SecureString, effective immediate on the server.

ChangePassword(SecureString, Boolean, Boolean)

Changes the password using SecureString. The unlock parameter indictates if the account needs to be unlocked. The mustChange parameter indicates whether the user has to change the password on the next Login.

ChangePassword(SecureString, SecureString)

Changes login password using SecureString, effective immediate on the server.

ChangePassword(String)

Changes login password, effective immediate on the server.

ChangePassword(String, Boolean, Boolean)

Changes the password. The unlock parameter indictates if the account needs to be unlocked. The mustChange parameter indicates whether the user has to change the password on the next Login.

ChangePassword(String, String)

Changes login password, effective immediate on the server.

CheckObjectDirty()

If there are some properties which are respected in special cases then use this function. currently applicable for DatabaseDdltriggers

(Inherited from ScriptNameObjectBase)
CheckObjectState() (Inherited from SqlSmoObject)
CheckObjectState(Boolean)

This is a virtual function, so that derived classes can override it if they want to do additional checks on the state of the object

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean)

Checks object state Because it is not recusrive, this function can be called directly and which means derived classes can't supply their own validation

(Inherited from SqlSmoObject)
CheckTextCorrectness(String, Boolean, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

checks text syntax, that it manipulates the right type of object ( PROC, TRIGGER, etc )

(Inherited from ScriptNameObjectBase)
CheckTextCorrectness(String, Boolean, Boolean, String[], DdlTextParserHeaderInfo)

checks text syntax, that it manipulates the right type of object ( PROC, TRIGGER, etc )

(Inherited from ScriptNameObjectBase)
CheckTextModeSupport() (Inherited from ScriptNameObjectBase)
CleanObject() (Inherited from ScriptNameObjectBase)
Create()

Creates the object on the server.

Create(SecureString)

Creates the object on the server.

Create(SecureString, LoginCreateOptions)

Creates the object on the server.

Create(String)

Creates the object on the server.

Create(String, LoginCreateOptions)

Creates the object on the server.

CreateImpl() (Inherited from SqlSmoObject)
CreateOrAlterImpl() (Inherited from SqlSmoObject)
Deny(ObjectPermissionSet, String)
Deny(ObjectPermissionSet, String, Boolean)
Deny(ObjectPermissionSet, String[])
Deny(ObjectPermissionSet, String[], Boolean)
Disable()

Disable Login if version >= 9. Otherwise, throw an exception. This is not part of Login.Alter because LOGIN [] ENABLE|DISABLE has to be issued by itself

Discover()

Best Effort Discovery mechanism : This method reflects upon metadata and gets all available objects

(Inherited from SqlSmoObject)
Drop()
DropCredential(String)

Drops a credential

DropIfExists()

Drops the object with IF EXISTS option. If object is invalid for drop function will return without exception.

DropImpl(Boolean)

drops the object

(Inherited from SqlSmoObject)
DropImpl(Boolean, Boolean)

For drop calls on the user database in Azure, the connection will be closed as the database is dropped The ExecutionManager will normally attempt to retry such calls by reopening the connection We want to avoid this retry when handleSevereError is true.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean)

drops the object

(Inherited from SqlSmoObject)
Enable()

Enable Login if version >= 9. Otherwise, throw an exception. This is not part of Login.Alter because LOGIN [] ENABLE|DISABLE has to be issued by itself

EnumAgentProxyAccounts()

Retrieves ProxyAccounts associated with login

EnumCredentials()

Gets the Collection of Credential Names mapped to the login. This method would always execute the select queries on the server even when ExecutionManager.ConnectionContext.SqlExecutionModes is set only to CaptureSql.

EnumDatabaseMappings()

Enumerates the database mappings for this login

EnumObjectPermissions()
EnumObjectPermissions(ObjectPermissionSet)
EnumObjectPermissions(String)
EnumObjectPermissions(String, ObjectPermissionSet)
ExecuteNonQuery(StringCollection, Boolean, Boolean)

Executes sql statements

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String)

Creates the Rename query for a SqlSmoObject and Executes it on the Server.

(Inherited from NamedSmoObject)
ExecuteWithModes(SqlExecutionModes, Action)

Executes the given action under the given execution modes.

Resets the original modes after the action completes or fails.

(Inherited from SqlSmoObject)
ForceTextModeOnTextBody() (Inherited from ScriptNameObjectBase)
FormatSqlVariant(Object) (Inherited from SqlSmoObject)
GenerateAlterEvent() (Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) (Inherited from SqlSmoObject)
GetBraketNameForText() (Inherited from ScriptNameObjectBase)
GetContextDB() (Inherited from SqlSmoObject)
GetDatabaseUser(String)

Returns the user for this login in the specified database

GetDBName() (Inherited from SqlSmoObject)
GetDisabledProperties(ScriptingPreferences)

Provides an enumerable of properties that are explicitly disabled for specific server types or editions. This is not a list of all properties that don't work for the specified target.

(Inherited from SqlSmoObject)
GetFragOptionString(FragmentationOption) (Inherited from SqlSmoObject)
GetIsSystemNamed() (Inherited from ScriptNameObjectBase)
GetIsTextDirty() (Inherited from ScriptNameObjectBase)
GetPropValue(String)

Retrieve the property value from : - The property bag directly if property is available (dirty or retrieved) - A call to our OnPropertyMissing method otherwise

Will throw an exception if the property value is NULL in either case.

(Inherited from SqlSmoObject)
GetPropValueOptional(String)

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL value) - A call to our OnPropertyMissing method otherwise (will throw exception if value is NULL)

(Inherited from SqlSmoObject)
GetPropValueOptional<T>(String, T)

Returns the value of the named property. If the object is in the Creating state and the property has not yet been set the defaultValue is returned. If the object exists the defaultValue is ignored and the actual value is returned.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String)

Retrieve the property value from : - The property bag if the state is creating or we're in Design Mode (possible NULL) - A call to our OnPropertyMissing method otherwise (possible NULL)

(Inherited from SqlSmoObject)
GetRealValue(Property, Object)

Returns the real value for the property.

(Inherited from SqlSmoObject)
GetServerName() (Inherited from SqlSmoObject)
GetServerObject() (Inherited from SqlSmoObject)
GetSqlServerVersionName()

Gets the sqlserver public name for the current connection, e.g: will transfer "SQLTOOLS2008-2" to "SQL Server 2008".

(Inherited from SqlSmoObject)
GetStringComparer()

Returns the comparer used by all child object collections to perform comparison of object names. The comparer of a Server is based on the collation of master The comparer of a Database and its children is based on the database collation

(Inherited from SqlSmoObject)
GetTextBody() (Inherited from ScriptNameObjectBase)
GetTextBody(Boolean) (Inherited from ScriptNameObjectBase)
GetTextHeader(Boolean) (Inherited from ScriptNameObjectBase)
GetTextHeader(ScriptNameObjectBase+ScriptHeaderType) (Inherited from ScriptNameObjectBase)
GetTextMode() (Inherited from ScriptNameObjectBase)
GetTextProperty(String)

get the text of the object, if not available, throw apropiate exception based on the State of the object

(Inherited from ScriptNameObjectBase)
GetUrnRecursive(StringBuilder)

Computes the Urn for the object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption)

Computes the Urn for the object, potentially including other fields in the definition besides the key fields.

(Inherited from SqlSmoObject)
Grant(ObjectPermissionSet, String)
Grant(ObjectPermissionSet, String, Boolean)
Grant(ObjectPermissionSet, String, Boolean, String)
Grant(ObjectPermissionSet, String[])
Grant(ObjectPermissionSet, String[], Boolean)
Grant(ObjectPermissionSet, String[], Boolean, String)
ImplInitialize(String[], OrderBy[]) (Inherited from SqlSmoObject)
InitChildCollection(Urn, Boolean)

Initializes the child object collection associated with the given type. For example, the name Column would initialize the Columns collection.

(Inherited from SqlSmoObject)
Initialize() (Inherited from SqlSmoObject)
Initialize(Boolean)

Initializes the object, by reading its properties from the enumerator

(Inherited from SqlSmoObject)
IsExpressSku()

Returns whether the server containing this object is an Express SKU

(Inherited from SqlSmoObject)
IsMember(String)

Returns true if the login is a member of the role given as argument

IsObjectDirty() (Inherited from ScriptNameObjectBase)
IsObjectInitialized() (Inherited from SqlSmoObject)
IsObjectInSpace() (Inherited from SqlSmoObject)
IsSupportedProperty(String)

Validate whether the specified property is supported in current server environment

(Inherited from SqlSmoObject)
IsVersion80SP3() (Inherited from SqlSmoObject)
IsVersion90AndAbove() (Inherited from SqlSmoObject)
ListMembers()

List the roles in which this login is a member

MarkDropped() (Inherited from SqlSmoObject)
MarkForDropImpl(Boolean) (Inherited from SqlSmoObject)
PostAlter()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after altering the object

(Inherited from SqlSmoObject)
PostCreate()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after object creation

(Inherited from SqlSmoObject)
PostDrop()

this function is meant to be overriden by derived classes, if they have to do supplimentary actions after dropping the object

(Inherited from SqlSmoObject)
Refresh()

Refresh the Login

Rename(String)
RenameImpl(String)

change object name

(Inherited from NamedSmoObject)
RenameImplWorker(String) (Inherited from NamedSmoObject)
Revoke(ObjectPermissionSet, String)
Revoke(ObjectPermissionSet, String, Boolean, Boolean)
Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)
Revoke(ObjectPermissionSet, String[])
Revoke(ObjectPermissionSet, String[], Boolean, Boolean)
Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String)
Script()
Script(ScriptingOptions)

Script object with specific scripting optiions

ScriptImpl() (Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions)

Returns a StringCollection object with the script for the object. This method throws an error if ScriptData is true

(Inherited from SqlSmoObject)
SetAccessToken(IRenewableToken)

Set the accessToken for connection.

(Inherited from SqlSmoObject)
SetCollectionTextMode(Boolean, SmoCollectionBase) (Inherited from ScriptNameObjectBase)
SetIsSystemNamed(Boolean) (Inherited from ScriptNameObjectBase)
SetParentImpl(SqlSmoObject) (Inherited from SqlSmoObject)
SetSchemaOwned() (Inherited from NamedSmoObject)
SetState(SqlSmoState)

Sets the object state (Existing, Dropped etc.) Applications should avoid using this method.

(Inherited from SmoObjectBase)
SetTextBody(String) (Inherited from ScriptNameObjectBase)
SetTextHeader(String) (Inherited from ScriptNameObjectBase)
SetTextMode(Boolean, SmoCollectionBase[]) (Inherited from ScriptNameObjectBase)
SwitchTextMode(Boolean, SmoCollectionBase[]) (Inherited from ScriptNameObjectBase)
ThrowIfAboveVersion100(String)

Throws an exception if the ServerVersion major version for this object is above 10.0 (SQL 2008)

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String)

Throws an exception if the ServerVersion major version for this object is above 8.0 (SQL 2000)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String)

Throws an exception if the ServerVersion major version for this object is below 10.0 (SQL 2008)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String)

Throws an UnsupportedVersionException if either the source or destination server is below 11.0 (SQL 2012)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 11.0 (SQL 2012)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String)

Throws an exception if the ServerVersion major version for this object is below 12.0 (SQL 2014)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 12.0 (SQL 2014)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String)

Throws an exception if the ServerVersion major version for this object is below 13.0 (SQL 2016)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 13.0 (SQL 2016)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140(String)

Throws an exception if the ServerVersion major version for this object is below 14.0 (SQL 2017)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion140Prop(String)

Throws an exception with text saying the specified property is not supported if the ServerVersion major version for this object is below 14.0 (SQL 2017)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String)

Throws an exception if the ServerVersion major version for this object is below 8.0 (SQL 2000)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3()

Throws an exception if the ServerVersion for this object is below 8.760 (8.0 SP3)

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String)

Throws an exception if the ServerVersion major version for this object is below 9.0 (SQL 2005)

(Inherited from SqlSmoObject)
ThrowIfTextIsDirtyForAlter() (Inherited from ScriptNameObjectBase)
ToString() (Inherited from SqlSmoObject)
Touch()

Mark the object "touched" for unconditional scripting of Alter.

(Inherited from SqlSmoObject)
TouchImpl()

Virtual method to allow derived classes to do additional work when touched.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) (Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) (Inherited from SqlSmoObject)
Validate(String, Object[]) (Inherited from SmoObjectBase)

Events

PropertyChanged (Inherited from SqlSmoObject)
PropertyMetadataChanged (Inherited from SqlSmoObject)

Explicit Interface Implementations

IAlienObject.Discover() (Inherited from SqlSmoObject)
IAlienObject.GetDomainRoot() (Inherited from SqlSmoObject)
IAlienObject.GetParent() (Inherited from SqlSmoObject)
IAlienObject.GetPropertyType(String)

Discovers type of property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type)

Retrieves value for a given property. Throws if property is not found.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() (Inherited from SqlSmoObject)
IAlienObject.Resolve(String) (Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState)

Sets state of this object based on provided SfcObjectState.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object)

Sets the value of given property, if it is writable. If property is not in property bag, reflection is used. Throws exception if the property is not found.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() (Inherited from SqlSmoObject)
ISfcSupportsDesignMode.IsDesignMode

This object extend ISfcSupportsDesignMode.

Extension Methods

GetAssessmentItems(SqlSmoObject, String[])

Finds all available checks for given smoObject.

GetAssessmentResults(SqlSmoObject, IEnumerable<ICheck>)

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues. This method performs only given checks from checks.

GetAssessmentResults(SqlSmoObject, String[])

Synchronously runs assessment for given smoObject and gives a IEnumerable<T> describing discovered issues.

GetAssessmentResultsList(SqlSmoObject, IEnumerable<ICheck>)

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues. This method performs only given checks from checks.

GetAssessmentResultsList(SqlSmoObject, String[])

Asynchronously runs assessment for given smoObject and gives a List<T> describing discovered issues.

IsSupportedObject<T>(SqlSmoObject, ScriptingPreferences)

Checks if the specified type is supported by the ServerVersion and DatabaseEngineType of the root server for this object. If ScriptingPreferences are non-null will also check if specified type is supported by the ServerVersion and DatabaseEngineType of the target server.

Applies to