ServerAlias Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Management.Smo.Wmi

Assembly:: Microsoft.SqlServer.SqlWmiManagement.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class ServerAlias sealed : Microsoft::SqlServer::Management::Smo::Wmi::WmiSmoObject, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable

public sealed class ServerAlias : Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable

type ServerAlias = class
    inherit WmiSmoObject
    interface ICreatable
    interface IDroppable

Public NotInheritable Class ServerAlias
Inherits WmiSmoObject
Implements ICreatable, IDroppable

Inheritance: Object

SmoObjectBase

WmiSmoObject
ServerAlias

Implements: ICreatable IDroppable

Examples

Managing Services and Network Settings by Using WMI Provider

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.

Constructors

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.

Properties

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)

Methods

AlterProtocolProperties(ProtocolPropertyCollection)	Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject)
CheckObjectState()	Checks the state of the referenced object. (Inherited from WmiSmoObject)
Create()	Creates a server connection alias on the WMI installation as defined by the ServerAlias object.
CreateProtocolPropertyCollection()	Creates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject)
Drop()	Removes the server connection alias from the WMI installation.
GetPropertyManagementObject(ProtocolProperty)	Gets the management object for the specified protocol property. (Inherited from WmiSmoObject)
GetPropertyObject(PropertyCollection, DataRow, Object)	Gets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject)
GetProtocolPropertyCollection()	Returns the protocol property collection for the referenced object. (Inherited from WmiSmoObject)
ImplInitialize(String[], OrderBy[])	Initializes the fields of the WmiSmoObject object. (Inherited from WmiSmoObject)
Initialize()	Initializes the referenced object. (Inherited from WmiSmoObject)
InvokeMgmtMethod(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)
InvokeMgmtMethod(ManagementObject, String, Object[])	Invokes the management method for the referenced object with the specified management object, method name, and parameters. (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(String)	Sets the name of the referenced object. (Inherited from WmiSmoObject)
SetParentImpl(WmiSmoObject)	Sets the parent of the referenced object. (Inherited from WmiSmoObject)
UpdateObjectState()	Updates the object state. (Inherited from WmiSmoObject)
Validate(String, Object[])	Validates the state of an object. (Inherited from SmoObjectBase)

Applies to

Share via