Share via

  • Article

Server.ActiveDirectory Property

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

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

Syntax

'Declaration
<SfcObjectAttribute(SfcObjectRelationship.Object, SfcObjectCardinality.One)> _
Public ReadOnly Property ActiveDirectory As ServerActiveDirectory
    Get
'Usage
Dim instance As Server
Dim value As ServerActiveDirectory

value = instance.ActiveDirectory

[SfcObjectAttribute(SfcObjectRelationship.Object, SfcObjectCardinality.One)]
public ServerActiveDirectory ActiveDirectory { get; }

[SfcObjectAttribute(SfcObjectRelationship::Object, SfcObjectCardinality::One)]
public:
property ServerActiveDirectory^ ActiveDirectory {
    ServerActiveDirectory^ get ();
}

[<SfcObjectAttribute(SfcObjectRelationship.Object, SfcObjectCardinality.One)>]
member ActiveDirectory : ServerActiveDirectory

function get ActiveDirectory () : ServerActiveDirectory

Property Value

Type: Microsoft.SqlServer.Management.Smo.ServerActiveDirectory
A ServerActiveDirectory object that specifies the Active Directory settings for the database.

Remarks

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.

Examples

Visual Basic

'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()

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server
$srv.ActiveDirectory.Register()