Server.ActiveDirectory Property

Gets information about the Active Directory settings for the instance of Microsoft SQL Server.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public ReadOnly Property ActiveDirectory As ServerActiveDirectory

public ServerActiveDirectory ActiveDirectory { get; }

public:
property ServerActiveDirectory^ ActiveDirectory {
    ServerActiveDirectory^ get ();
}

/** @property */
public ServerActiveDirectory get_ActiveDirectory ()

public function get ActiveDirectory () : ServerActiveDirectory

Property Value

A ServerActiveDirectory object that specifies the Active Directory settings for the database.

Remarks

Updated text:

The ActiveDirectory property points to a ServerActiveDirectory object, which can be used to register the instance of SQL Server in Active Directory.

When you call the Register method to add an instance of SQL Server to Active Directory, users can use Active Directory to find this instance of SQL Server. This is useful in large organizations with many instances of SQL Server.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Register the instance of SQL Server in the Active Directory directory service.
srv.ActiveDirectory.Register()

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Server Class
Server Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Connecting to an Instance of SQL Server
Disconnecting from an Instance of SQL Server
Managing Servers

Change History