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

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

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

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

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
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.
	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.
	LocalReplicaRole	Gets the availability replica role.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	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.)
	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
	Alter	Alters an availability group.
	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.
	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.
	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.)
	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.
	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.)
	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.
	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.)
	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.
	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.)
	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