Share via

LinkedServerLogin Class

  • Article

The LinkedServerLogin object represents a SQL Server logon account that has permission to connect to the linked server.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.LinkedServerLogin

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

Syntax

'Declaration
<SfcElementTypeAttribute("Login")> _
Public NotInheritable Class LinkedServerLogin _
    Inherits NamedSmoObject _
    Implements ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable
'Usage
Dim instance As LinkedServerLogin

[SfcElementTypeAttribute("Login")]
public sealed class LinkedServerLogin : NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable

[SfcElementTypeAttribute(L"Login")]
public ref class LinkedServerLogin sealed : public NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Login")>]
type LinkedServerLogin =  
    class 
        inherit NamedSmoObject 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
    end

public final class LinkedServerLogin extends NamedSmoObject implements ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable

The LinkedServerLogin type exposes the following members.

Constructors

  Name Description
Public method LinkedServerLogin() Initializes a new instance of the LinkedServerLogin class.
Public method LinkedServerLogin(LinkedServer, String) Initializes a new instance of the LinkedServerLogin class for the specified linked server and with the specified name.

Top

Properties

  Name Description
Public property DateLastModified Gets the date and time when the linked server logon was last modified.
Public property Impersonate Gets or sets the Boolean property value that specifies whether the SQL Server authenticated logon account connects to the linked server using its own credentials or using a specified logon name and password.
Public property Name Gets or sets the name of the linked server log-in. (Overrides NamedSmoObject.Name.)
Public property Parent Gets or sets the Server object that is the parent of the LinkedServerLogin object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property RemoteUser Gets or sets an alternative logon name for the linked server logon to impersonate when it accesses data on a linked server.
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.)

Top

Methods

  Name Description
Public method Alter Updates any property changes on an instance of SQL Server. 
Public method Create Creates a linked server logon as defined by the LinkedServerLogin object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the linked server logon.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
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.)
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.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method SetRemotePassword(SecureString) Sets the password for an alternative login name used when a distributed query or another SQL Server process accesses data on a linked server using an OLE DB Provider.
Public method SetRemotePassword(String) Sets the password for an alternative logon name used when a distributed query or another SQL Server process accesses data on a linked server using an OLE DB Provider.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode.

Top

Remarks

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

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

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

To set the password for the linked server login, users must have ALTER ANY LOGIN permission on the server or be a member of the sysadmin fixed server role.

Thread Safety

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.

Examples

Using Linked Servers in SMO

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Linked Servers (Database Engine)

sp_addlinkedsrvlogin (Transact-SQL)