Share via

  • Article

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
Public method ServerAlias() Initializes a new instance of the ServerAlias class.
Public method 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
Public property ConnectionString Gets or sets the connection string that the alias uses to connect to the server.
Public property Name Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property Parent Gets or sets the ManagedComputer object that is the parent of the ServerAlias object.
Public property Properties Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property ProtocolName Gets or sets the name of the protocol used by the server connection alias.
Public property ServerName Gets or sets the name of the instance of SQL Server to which the server alias connects.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Protected method AlterProtocolProperties Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation. (Inherited from WmiSmoObject.)
Protected method CheckObjectState Checks the state of the referenced object. (Inherited from WmiSmoObject.)
Public method Create Creates a server connection alias on the WMI installation as defined by the ServerAlias object.
Protected method CreateProtocolPropertyCollection Creates a set of protocol attributes for the referenced object. (Inherited from WmiSmoObject.)
Public method Drop Removes the server connection alias from the WMI installation.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropertyManagementObject Gets the management object for the specified protocol property. (Inherited from WmiSmoObject.)
Protected method GetPropertyObject Gets the property from the specified collection with the specified position and value. (Inherited from WmiSmoObject.)
Protected method GetProtocolPropertyCollection Returns the protocol property collection for the referenced object. (Inherited from WmiSmoObject.)
Public method GetType (Inherited from Object.)
Protected method ImplInitialize Initializes the fields of the WmiSmoObjectobject. (Inherited from WmiSmoObject.)
Public method Initialize Initializes the referenced object. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, array<Object[]) Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters. (Inherited from WmiSmoObject.)
Protected method IsObjectInitialized Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Refreshes the referenced object and its properties. (Inherited from WmiSmoObject.)
Protected method SetName Sets the name of the referenced object. (Inherited from WmiSmoObject.)
Protected method SetParentImpl Sets the parent of the referenced object. (Inherited from WmiSmoObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateObjectState Updates the object state. (Inherited from WmiSmoObject.)
Public method 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.

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.