DatabaseActiveDirectory Class
Note: This API is now obsolete.
The DatabaseActiveDirectory object provides programmatic access to the Active Directory settings for a database.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.DatabaseActiveDirectory
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<ObsoleteAttribute> _
Public NotInheritable Class DatabaseActiveDirectory _
Inherits SqlSmoObject
'Usage
Dim instance As DatabaseActiveDirectory
[ObsoleteAttribute]
public sealed class DatabaseActiveDirectory : SqlSmoObject
[ObsoleteAttribute]
public ref class DatabaseActiveDirectory sealed : public SqlSmoObject
[<SealedAttribute>]
[<ObsoleteAttribute>]
type DatabaseActiveDirectory =
class
inherit SqlSmoObject
end
public final class DatabaseActiveDirectory extends SqlSmoObject
The DatabaseActiveDirectory type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Alias | Gets or sets an alternative name for the database that appears in the Active Directory registration of the database. |
|
Contact | Gets or sets a contact name for the database that appears in the Active Directory registration of the database. |
|
Description | Gets or sets a textual description of the database that appears in the Active Directory registration of the database. |
|
InformationUrl | Gets or sets an information URL for the database that appears in the Active Directory registration of the database. |
|
IsRegistered | Gets the Boolean property that specifies whether the database is registered with the Active Directory service. |
|
Parent | Gets the Database object that is the parent of the DatabaseActiveDirectory object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
|
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
|
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
|
GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) |
|
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
|
GetType | (Inherited from Object.) |
|
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
|
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
|
Register | Adds the database to the Active Directory service register. |
|
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
|
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
Unregister | Removes the database from the Active Directory service register. |
|
UpdateRegistration | Updates the database details in the Active Directory service. |
|
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
|
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetParent | Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
|
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
|
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
|
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
|
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) |
Top
Remarks
The DatabaseActiveDirectory object allows you to:
Register a database in the Active Directory service.
Update the database information in Active Directory service.
Create an alias for the database that appears in the Active Directory service.
Create a contact, a description and an information URL for the database that appears in the Active Directory service.
Delete the database registration information from Active Directory service.
To get or set DatabaseActiveDirectory object properties, users must be a member of the db_owner fixed database role or the sysadmin fixed server role.
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.
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace