AvailabilityGroup Class

Displays the availability group that contains the databases and replicas.

Inheritance Hierarchy

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

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

Syntax

'Bildirim
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class AvailabilityGroup _
    Inherits NamedSmoObject _
    Implements IObjectPermission, ICreatable, IAlterable, IDroppable,  _
    IScriptable
'Kullanım
Dim instance As AvailabilityGroup

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

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

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

public final class AvailabilityGroup extends NamedSmoObject implements IObjectPermission, ICreatable, IAlterable, IDroppable, IScriptable

The AvailabilityGroup type exposes the following members.

Constructors

	Name	Description
	AvailabilityGroup()	Initializes a new instance of the AvailabilityGroup class with the default property values.
	AvailabilityGroup(Server, String)	Initializes a new instance of the AvailabilityGroup class with the specified server and name.

Top

Properties

	Name	Description
	AutomatedBackupPreference	Gets or sets the collection of the automated backup preference for the availability group.
	AvailabilityDatabases	Gets the collection of availability databases contained in the availability group.
	AvailabilityGroupListeners	Gets or sets the collection of replicas participating in the availability group.
	AvailabilityReplicas	Gets the collection of availability replicas participating in the availability group.
	DatabaseReplicaStates	Gets the collection of DatabaseReplicaState objects representing the states of physical database replicas participating in the availability groups.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	FailureConditionLevel	Gets or sets the failure condition level of the availability group.
	HealthCheckTimeout	Gets or sets the collection of the health check timeout for the availability group.
	ID	Gets the identifier value that uniquely identifies the availability group.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	LocalReplicaRole	Gets the availability replica role.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Parent	Gets or sets the parent of the availability group.
	PrimaryReplicaServerName	Gets the collection for the primary replica server name of the availability group.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	UniqueId	Gets or sets the GUID that uniquely identifies the availability group.
	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
	AddDatabaseContext	Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
	Alter	Alters an availability group.
	AlterImpl	Activates the object altered event. (Inherited from SqlSmoObject.)
	AlterImplWorker	Calls the Alter methods. (Inherited from SqlSmoObject.)
	BindDefaultImpl	Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from SqlSmoObject.)
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl	Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
	CheckVersion110()	Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersion110(String)	Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
	CheckVersion80	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow110	Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
	CleanObject	Sets the object to its unmodified state. (Inherited from SqlSmoObject.)
	Create	Creates an availability group that has been specified on the client on the back end. The availability group creation will include any availability replicas or availability databases added to the object before creation.
	CreateImpl	Creates an object with scripting options. (Inherited from SqlSmoObject.)
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the availability group.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the availability group.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users to whom the grantee granted the specified set of permissions on the availability group.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users to whom the grantees granted the specified set of permissions on the availability group.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops an availability group.
	DropImpl	Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
	DropImplWorker	Calls the drop methods. (Inherited from SqlSmoObject.)
	EnumObjectPermissions()	Enumerates a list of object permissions for the availability group.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the availability group.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the availability group.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the availability group.
	EnumReplicaClusterNodes	Returns a DataTable with information about the cluster configuration of the availability group.
	Equals	(Inherited from Object.)
	ExecuteNonQuery	Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
	ExecuteRenameQuery	Executes the rename query for the object. (Inherited from NamedSmoObject.)
	Failover	Performs a manual failover of this availability group to the server specified by the Parent property with no possibility of data loss.
	FailoverWithPotentialDataLoss	Performs a forced failover of this availability group to the server specified by the Parent property with the possibility of data loss if the databases on the replica are not synchronized with the primary.
	Finalize	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GenerateAlterEvent()	Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
	GenerateAlterEvent(Urn, Object)	Generates alter event with the specified URN and inner object value. (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.)
	GetFragOptionString	Gets a FragmentationOption object as a string value. (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.)
	GetRealValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the availability group.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the availability group.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission and the ability to grant access to other users for the specified grantee on the availability group.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission and the ability to grant access to other users for the specified grantees on the availability group.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants access to the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the availability group under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants access to the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the availability group under an assumed role.
	ImplInitialize	Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	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.)
	IsObjectDirty	Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.)
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
	MarkDropped	Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
	MarkForDropImpl	Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
	MemberwiseClone	(Inherited from Object.)
	PostAlter	The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
	PostCreate	The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
	PostDrop	The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the availability group.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the availability group.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes a previously granted set of permissions from a grantee on the availability group and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from a list of grantees on the availability group and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes a previously granted set of permissions from a grantee from the availability group and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes a previously granted set of permissions from a list of grantees from the availability group and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Script()	Generates the script for creating this availability group.
	Script(ScriptingOptions)	Generates a script for this availability group using the specified scripting options.
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSchemaOwned	Sets the schema owned value. (Inherited from NamedSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl	Not implemented. (Inherited from SqlSmoObject.)
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject. (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

Fields

	Name	Description
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
	singletonParent	Represents the singleton parent. (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