ServerAlias Class

The ServerAlias class represents an alias for a server connection on the Windows Management Instrumentation (WMI) installation.

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

public sealed class ServerAlias : WmiSmoObject, 
	ICreatable, IDroppable

The ServerAlias type exposes the following members.

  NameDescription
Public methodServerAlias()Initializes a new instance of the ServerAlias class.
Public methodServerAlias(ManagedComputer, String)Initializes a new instance of the ServerAlias class on the specified WMI installation and with the specified name.
Top

  NameDescription
Public propertyConnectionStringGets or sets the connection string that the alias uses to connect to the server.
Public propertyNameGets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyParentGets or sets the ManagedComputer object that is the parent of the ServerAlias object.
Public propertyPropertiesRepresents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyProtocolNameGets or sets the name of the protocol used by the server connection alias.
Public propertyServerNameGets or sets the name of the instance of SQL Server to which the server alias connects.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Protected methodAlterProtocolPropertiesUpdates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject.)
Protected methodCheckObjectStateChecks the state of the referenced object. (Inherited from WmiSmoObject.)
Public methodCreateCreates a server connection alias on the WMI installation as defined by the ServerAlias object.
Protected methodCreateProtocolPropertyCollectionCreates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject.)
Public methodDropRemoves the server connection alias from the WMI installation.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropertyManagementObjectGets the management object for the specified protocol property. (Inherited from WmiSmoObject.)
Protected methodGetPropertyObjectGets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject.)
Protected methodGetProtocolPropertyCollectionReturns the protocol property collection for the referenced object. (Inherited from WmiSmoObject.)
Public methodGetType (Inherited from Object.)
Protected methodImplInitializeInitializes the fields of the WmiSmoObjectobject. (Inherited from WmiSmoObject.)
Public methodInitializeInitializes the referenced object. (Inherited from WmiSmoObject.)
Protected methodInvokeMgmtMethod(ManagementObject, String, Object[])Invokes the management method for the referenced object with the specified management object, method name, and parameters. (Inherited from WmiSmoObject.)
Protected methodInvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[])Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters. (Inherited from WmiSmoObject.)
Protected methodIsObjectInitializedSpecifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRefreshRefreshes the referenced object and its properties. (Inherited from WmiSmoObject.)
Protected methodSetNameSets the name of the referenced object. (Inherited from WmiSmoObject.)
Protected methodSetParentImplSets the parent of the referenced object. (Inherited from WmiSmoObject.)
Public methodToString (Inherited from Object.)
Protected methodUpdateObjectStateUpdates the object state. (Inherited from WmiSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

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.

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

Community Additions

ADD
Show: