ServerAlias Class
The ServerAlias class represents an alias for a server connection on the Windows Management Instrumentation (WMI) installation.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject
Microsoft.SqlServer.Management.Smo.Wmi.ServerAlias
Namespace: Microsoft.SqlServer.Management.Smo.Wmi
Assembly: Microsoft.SqlServer.SqlWmiManagement (in Microsoft.SqlServer.SqlWmiManagement.dll)
Syntax
'Declaration
Public NotInheritable Class ServerAlias _
Inherits WmiSmoObject _
Implements ICreatable, IDroppable
'Usage
Dim instance As ServerAlias
public sealed class ServerAlias : WmiSmoObject,
ICreatable, IDroppable
public ref class ServerAlias sealed : public WmiSmoObject,
ICreatable, IDroppable
[<SealedAttribute>]
type ServerAlias =
class
inherit WmiSmoObject
interface ICreatable
interface IDroppable
end
public final class ServerAlias extends WmiSmoObject implements ICreatable, IDroppable
The ServerAlias type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ServerAlias() | Initializes a new instance of the ServerAlias class. | |
ServerAlias(ManagedComputer, String) | Initializes a new instance of the ServerAlias class on the specified WMI installation and with the specified name. |
Top
Properties
Name | Description | |
---|---|---|
ConnectionString | Gets or sets the connection string that the alias uses to connect to the server. | |
Name | Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.) | |
Parent | Gets or sets the ManagedComputer object that is the parent of the ServerAlias object. | |
Properties | Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.) | |
ProtocolName | Gets or sets the name of the protocol used by the server connection alias. | |
ServerName | Gets or sets the name of the instance of SQL Server to which the server alias connects. | |
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) | |
Urn | Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
Name | Description | |
---|---|---|
Create | Creates a server connection alias on the WMI installation as defined by the ServerAlias object. | |
Drop | Removes the server connection alias from the WMI installation. | |
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Initialize | Initializes the referenced object. (Inherited from WmiSmoObject.) | |
IsObjectInitialized | Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.) | |
Refresh | Refreshes the referenced object and its properties. (Inherited from WmiSmoObject.) | |
SetName | Sets the name of the referenced object. (Inherited from WmiSmoObject.) | |
SetParentImpl | Sets the parent of the referenced object. (Inherited from WmiSmoObject.) | |
ToString | (Inherited from Object.) | |
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Remarks
A server connection alias is required when:
The client is connecting to an instance of Microsoft SQL Server over a network transport that is not the default network transport.
The instance of SQL Server to which the client is connected listens on an alternate named pipe.
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
Managing Services and Network Settings by Using WMI Provider
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.Wmi Namespace