AvailabilityDatabase Class

Represents the availability database.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.AvailabilityDatabase

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class AvailabilityDatabase _
    Inherits NamedSmoObject _
    Implements ICreatable, IDroppable, IScriptable
'Usage
Dim instance As AvailabilityDatabase

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class AvailabilityDatabase : NamedSmoObject, 
    ICreatable, IDroppable, IScriptable

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class AvailabilityDatabase sealed : public NamedSmoObject, 
    ICreatable, IDroppable, IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type AvailabilityDatabase =  
    class 
        inherit NamedSmoObject 
        interface ICreatable 
        interface IDroppable 
        interface IScriptable 
    end

public final class AvailabilityDatabase extends NamedSmoObject implements ICreatable, IDroppable, IScriptable

The AvailabilityDatabase type exposes the following members.

Constructors

	Name	Description
	AvailabilityDatabase()	Initializes a new instance of the AvailabilityDatabase class.
	AvailabilityDatabase(AvailabilityGroup, String)	Initializes a new instance of the AvailabilityDatabase class with the specified name and availability group.

Top

Properties

	Name	Description
	IsFailoverReady	Gets or sets a value that indicates whether the database is marked synchronized in the cluster.
	IsJoined	Gets or sets a value that indicates whether the availability database has a physical replica on the server instance.
	IsPendingSecondarySuspend	Gets or sets a value that indicates whether the new primary, after a force failover, is waiting for an acknowledgement from the former primary of the suspend action.
	IsSuspended	Gets or sets a value that indicates whether the availability database is suspended.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Parent	Gets the specified AvailabilityGroup object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RecoveryLSN	Gets the end of log on the primary before it writes any new log records after recovery of failover.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	SynchronizationState	Gets the availability database synchronization state.
	TruncationLSN	Gets the log truncation point.
	UniqueId	Gets the unique identifier for the specified object.
	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
	Create	Creates an availability database.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes an availability database from the availability group.
	Equals	(Inherited from Object.)
	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.)
	JoinAvailablityGroup	Joins the local copy of the database on the instance to the availability group.
	LeaveAvailabilityGroup	Removes the local copy of the database on the availability replica from the availability group.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	ResumeDataMovement	Resumes the data movement on this availability database.
	Script()	Generates the script for creating the availability database.
	Script(ScriptingOptions)	Generates a script for the availability database using the specified scripting options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SuspendDataMovement	Suspends the data movement on this availability database.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	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
	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

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