Database.ActiveDirectory Property
Note: This API is now obsolete.
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)> _
<ObsoleteAttribute> _
Public ReadOnly Property ActiveDirectory As DatabaseActiveDirectory
Get
'Usage
Dim instance As Database
Dim value As DatabaseActiveDirectory
value = instance.ActiveDirectory
[SfcObjectAttribute(SfcObjectRelationship.Object, SfcObjectCardinality.One)]
[ObsoleteAttribute]
public DatabaseActiveDirectory ActiveDirectory { get; }
[SfcObjectAttribute(SfcObjectRelationship::Object, SfcObjectCardinality::One)]
[ObsoleteAttribute]
public:
property DatabaseActiveDirectory^ ActiveDirectory {
DatabaseActiveDirectory^ get ();
}
[<SfcObjectAttribute(SfcObjectRelationship.Object, SfcObjectCardinality.One)>]
[<ObsoleteAttribute>]
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.
Examples
VB
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Register the AdventureWorks2012 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("AdventureWorks2012")
$db.ActiveDirectory.Register()
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Active Directory Stored Procedures (Transact-SQL)