LinkedServerLogin Class
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 | |
---|---|---|
LinkedServerLogin() | Initializes a new instance of the LinkedServerLogin class. | |
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 | |
---|---|---|
DateLastModified | Gets the date and time when the linked server logon was last modified. | |
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. | |
Name | Gets or sets the name of the linked server log-in. (Overrides NamedSmoObject.Name.) | |
Parent | Gets or sets the Server object that is the parent of the LinkedServerLogin object. | |
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) | |
RemoteUser | Gets or sets an alternative logon name for the linked server logon to impersonate when it accesses data on a linked server. | |
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) | |
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
Name | Description | |
---|---|---|
Alter | Updates any property changes on an instance of SQL Server. | |
Create | Creates a linked server logon as defined by the LinkedServerLogin object. | |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) | |
Drop | Removes the linked server logon. | |
Equals | (Inherited from Object.) | |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) | |
GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) | |
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) | |
GetHashCode | (Inherited from Object.) | |
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetType | (Inherited from Object.) | |
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) | |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) | |
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) | |
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) | |
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) | |
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) | |
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. | |
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. | |
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) | |
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
Name | Description | |
---|---|---|
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) | |
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) | |
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) | |
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.) | |
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) | |
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) | |
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.) | |
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) | |
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) | |
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) | |
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) | |
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
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