• Article

Database.ActiveDirectory Property

Gets the information about the Active Directory settings for the database.

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 DatabaseActiveDirectory
    Get
'Usage
Dim instance As Database
Dim value As DatabaseActiveDirectory

value = instance.ActiveDirectory

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

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

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

function get ActiveDirectory () : DatabaseActiveDirectory

Property Value

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

Remarks

The ActiveDirectory property points to a DatabaseActiveDirectory object, which can be used to register the referenced database Active Directory.

When you call the Register method to add a database to Active Directory, users can use Active Directory to find this database. This is useful in large organizations with many databases.

Note

Registering a database in Active Directory can be performed only on instances of SQL Server that are installed on computers that are running Windows 2000 or later versions.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server

'Reference the AdventureWorks2008R2 database
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")

'Register the AdventureWorks2008R2 database in the Active Directory 
'directory service.
db.ActiveDirectory.Register()

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")
$db.ActiveDirectory.Register()